Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2651A/11382.html b/WebHelpDocs/Commands_2651A/11382.html
new file mode 100644
index 0000000..aa7962f
--- /dev/null
+++ b/WebHelpDocs/Commands_2651A/11382.html
@@ -0,0 +1,58 @@
+
+
+ Bit manipulation and logic operations
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Bit manipulation and logic operations
+
The bit functions perform bitwise logic operations on two given numbers, and bit operations on one given number. Logic and bit operations truncate the fractional part of given numbers to make them integers.
+
Logic operations
+
The bit.bitand(), bit.bitor(), and bit.bitxor() functions in this group perform bitwise logic operations on two numbers. The Test Script Processor (TSP®) scripting engine performs the indicated logic operation on the binary equivalents of the two integers. This bitwise logic operation is performed on all corresponding bits of the two numbers. The result of a logic operation is returned as an integer.
+
Bit operations
+
The rest of the functions in this group are used for operations on the bits of a given number. These functions can be used to:
+
Clear a bit
Toggle a bit
Test a bit
Set a bit or bit field
Retrieve the weighted value of a bit or field value
All these functions use an index parameter to specify the bit position of the given number. The least significant bit of a given number has an index of 1, and the most significant bit has an index of 32.
+
The Test Script Processor (TSP) scripting engine stores all numbers internally as IEEE Std 754 double-precision floating point values. The logical operations work on 32‑bit integers. Any fractional bits are truncated. For numbers larger than 4294967295, only the lower 32 bits are used.
The integrating ADC of the Model 2651A uses a ratiometric A/D conversion technique. To ensure accuracy of readings, the instrument must periodically obtain fresh measurements of its internal ground and voltage reference. Separate reference and zero measurements are used for each aperture.
+
There are three different settings for autozero as summarized in the table below. By default, the instrument automatically checks these reference measurements whenever a signal measurement is made (AUTO). If the reference measurements are out of date when a signal measurement is made, the instrument will automatically take two more A/D conversions, one for the reference and one for the zero, before returning the result. Thus, occasionally, a measurement takes longer than normal.
+
This extra time can cause problems in sweeps and other test sequences in which measurement timing is critical. To avoid the extra time for the reference measurements in these situations, the OFF selection can be used to disable the automatic reference measurements. Note that with automatic reference measurements disabled, the instrument may gradually drift out of specification.
+
To minimize the drift, a reference and zero measurement should be made just prior to the critical test sequence. The ONCE setting can be used to force a refresh of the reference and zero measurements used for the current aperture setting.
+
+
+
+
+
+
+
Autozero settings
+
+
+
+
Autozero setting
+
+
Description
+
+
+
+
OFF
+
+
Turns automatic reference measurements off.
+
+
+
+
ONCE
+
+
Turns automatic reference measurements off, after immediately taking one reference and one zero measurement.
+
+
+
+
AUTO
+
+
Automatically takes new acquisitions when the Model 2651A determines reference and zero values are out-of-date.
+
+
+
+
+
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2651A/11500.html b/WebHelpDocs/Commands_2651A/11500.html
new file mode 100644
index 0000000..c74801c
--- /dev/null
+++ b/WebHelpDocs/Commands_2651A/11500.html
@@ -0,0 +1,205 @@
+
+
+ Digital I/O bit weighting
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Digital I/O bit weighting
+
Bit weighting for the digital I/O lines is shown in the following table.
+
+
+
+
+
+
+
+
+
Digital bit weight
+
+
+
+
Line #
+
+
Bit
+
+
Decimal weighting
+
+
Hexadecimal weighting
+
+
+
+
1
+
+
B1
+
+
1
+
+
0x0001
+
+
+
+
2
+
+
B2
+
+
2
+
+
0x0002
+
+
+
+
3
+
+
B3
+
+
4
+
+
0x0004
+
+
+
+
4
+
+
B4
+
+
8
+
+
0x0008
+
+
+
+
5
+
+
B5
+
+
16
+
+
0x0010
+
+
+
+
6
+
+
B6
+
+
32
+
+
0x0020
+
+
+
+
7
+
+
B7
+
+
64
+
+
0x0040
+
+
+
+
8
+
+
B8
+
+
128
+
+
0x0080
+
+
+
+
9
+
+
B9
+
+
256
+
+
0x0100
+
+
+
+
10
+
+
B10
+
+
512
+
+
0x0200
+
+
+
+
11
+
+
B11
+
+
1024
+
+
0x0400
+
+
+
+
12
+
+
B12
+
+
2048
+
+
0x0800
+
+
+
+
13
+
+
B13
+
+
4096
+
+
0x1000
+
+
+
+
14
+
+
B14
+
+
8192
+
+
0x2000
+
+
+
+
+
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
Although the digital I/O lines are primarily intended for use with a device handler for limit testing, they can also be used for other purposes such as controlling external logic circuits. You can control lines either from the front panel or over a remote interface.
+
The trigger mode for the line must be set to digio.TRIG_BYPASS in order to use the line for digital I/O. See Triggering for more information.
+
To set digital I/O values from the front panel:
+
Press the MENU key, select DIGOUT, and then press the ENTER key or press the navigation wheel .
Select DIG-IO-OUTPUT, and then press the ENTER key or the navigation wheel .
Set the decimal value as required to set digital I/O lines within the range of 0 to 16,383 (see the table in Digital I/O bit weighting), and then press the ENTER key or the navigation wheel .
Press the EXIT (LOCAL) key as needed to return to the main menu.
To write-protect specific digital I/O lines to prevent their values from being changed:
+
Press the MENU key, then select DIGOUT, and then press the ENTER key or the navigation wheel .
Select WRITE-PROTECT, and then press the ENTER key or the navigation wheel .
Set the decimal value as required to write‑protect digital I/O lines within the range of 0 to 16,383 (see Digital I/O bit weighting), and then press the ENTER key or the navigation wheel .
Press the EXIT (LOCAL) key as needed to return to the main menu.
To remove write protection, repeat the above steps, but enter the original value in step 3.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
The filter feature lets you set the filter response to stabilize noisy measurements. The Model 2651A uses a digital filter, which is based on reading conversions. The displayed, stored, or transmitted reading is calculated using one or more reading conversions (from 1 to 100).
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
Depending on how it is programmed and what is connected to the output (load or source), the instrument can operate in any of the four quadrants. The four quadrants of operation are shown in the continuous operating boundaries figures. When operating in the first (I) or third (III) quadrant, the instrument is operating as a source (V and I have the same polarity). As a source, the instrument is delivering power to a load.
+
+
When operating in the second (II) or fourth (IV) quadrant, the instrument is operating as a sink (V and I have opposite polarity). As a sink, it is dissipating power rather than sourcing it. An external source or an energy storage device, such as a capacitor or battery, can force operation in the sink region.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
You can specify the Model 2651A start-up (power-on) configuration. Use the setup.poweron attribute to select which setup to return to upon power-up. To set the setup.poweron configuration attribute:
+
setup.poweron = n -- Select power-on setup.
+
Where:
+
+
+
+
+
n
+
+
=
+
+
0 (*RST/reset() factory defaults)
+
+
+
+
+
+
n
+
+
=
+
+
1 to 5 (user setups 1-5)
+
+
+
+
+
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
Readings can be obtained by taking overlapped or non-overlapped measurements. Routines that make single‑point measurements can be configured to make multiple measurements where one would ordinarily be made. The measured value is not the only component of a reading. The measurement status (for example, “In Compliance” or “Overranged”) is also an element of data associated with a particular reading.
+
All routines that return measurements can also store the measurements in the reading buffers. Overlapped measurements always return readings in a reading buffer. Non-overlapped measurement functions can return single-point measurement values or store multiple values in a reading buffer.
+
A reading buffer is based on a Lua table. The measurements are accessed by ordinary array accesses. If rb is a reading buffer, the first measurement is accessed as rb[1] and the 9th measurement as rb[9], and so on. The additional information in the table is accessed as additional members of the table.
+
The load, save, and write operations for reading buffers function differently in the remote state. From a remote command interface, you can extract data from reading buffers as the instrument acquires the data.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2651A/11815.html b/WebHelpDocs/Commands_2651A/11815.html
new file mode 100644
index 0000000..b3a41cb
--- /dev/null
+++ b/WebHelpDocs/Commands_2651A/11815.html
@@ -0,0 +1,47 @@
+
+
+ Setting a value
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Setting a value
+
There are two ways to adjust a value: the Navigation wheel method or Numeric entry method (using the keypad).
+
Navigation wheel method:
+
Use the CURSOR arrow keys (or turn the navigation wheel ) to move the cursor to the value that you want to edit.
Press the navigation wheel or the ENTER key to enter edit mode. The EDIT indicator is illuminated.
Rotate the navigation wheel to set the appropriate value.
Press the ENTER key to select the value or press the EXIT (LOCAL) key to cancel the change.
(Optional) Press the EXIT (LOCAL) key to return to the main menu.
+
Numeric entry method:
+
The numeric entry method may only be used if the numeric keypad is enabled and while the instrument is in edit mode.
+
To set a value to zero, press the 0000 numeric entry key. To toggle the polarity of a value, press the +/– numeric entry key.
+
If the keypad is disabled, press the MENU key, then select DISPLAY > NUMPAD > ENABLE.
Use the CURSOR arrow keys (or turn the navigation wheel ) to move the cursor to the value that you want to edit.
Press the navigation wheel or the ENTER key to enter edit mode. The EDIT indicator is illuminated.
Press any of the desired number keys (0-9, +/-, 0000) (see 2. Setup, performance control, special operation, and numbers ). The cursor moves to the next value on the right.
Repeat the above steps as required to set the desired values.
Press the ENTER key to select the value or press the EXIT (LOCAL) key to cancel change.
(Optional) Press the EXIT (LOCAL) key to return to the main menu.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2651A/11993.html b/WebHelpDocs/Commands_2651A/11993.html
new file mode 100644
index 0000000..f79b3e5
--- /dev/null
+++ b/WebHelpDocs/Commands_2651A/11993.html
@@ -0,0 +1,41 @@
+
+
+ Range
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Range
+
The selected measurement range effects the accuracy of the measurements as well as the maximum signal that can be measured. Note that dashed lines are displayed (for example, --.---- µA) to indicate that the previous measurement is not recent. To update the displayed reading, trigger a measurement.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
The Model 2651A has two analog-to-digital converters (ADC): one integrating, one high speed. Fastest reading rates are achieved using the fast ADC. With the exception of one setting, the SPEED key largely controls the integrating ADC (see Analog-to-digital converter). The SPEED key is used to set the integration time, or measurement aperture, of the analog-to-digital converter (the period of time the input signal is measured). The integration time affects the usable digits, the amount of reading noise, and the reading rate of the instrument. The integration time is specified in parameters based on the number of power line cycles (NPLC), where 1 PLC for 60 Hz is 16.67 ms (1/60) and 1 PLC for 50 Hz is 20 ms (1/50).
+
In general, the fastest integration time (0.001 PLC) results in the fastest reading rate for the integrating ADC, but also causes increased reading noise and fewer usable digits. The slowest integration time (25 PLC) provides the best common-mode and normal-mode noise rejection, but has the slowest reading rate. Settings between the fastest and slowest integration times are a compromise between speed and noise. The default power‑on speed setting is NORMAL (1 PLC).
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
The relative offset (REL) feature can be used to set offsets to zero (0) or subtract a baseline reading from present and future readings. With relative offset enabled, subsequent readings are the difference between the actual input value and the relative offset value, as follows:
+
Displayed reading = Actual input - Relative offset value
+
Once a relative offset value is established for a measurement function, the value is the same for all ranges. For example, if 0.5 A is set as a relative offset value on the 1 A range, the relative offset value is also 0.5 A on the lower current ranges.For example, on the 1 A range, the Model 2651A still overflows for a more than 1.02 A input.
+
When relative offset is enabled, the REL indicator turns on. Changing measurement functions changes the relative offset value to the established relative offset value and state for that measurement function.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2651A/12044.html b/WebHelpDocs/Commands_2651A/12044.html
new file mode 100644
index 0000000..18580f6
--- /dev/null
+++ b/WebHelpDocs/Commands_2651A/12044.html
@@ -0,0 +1,42 @@
+
+
+ Time and date values
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Time and date values
+
Time and date values are represented as the number of seconds since some base. Representing time as a number of seconds is referred to as “standard time format.” There are three time bases:
+
UTC 12:00 am Jan 1, 1970. Some examples of UTC time are reading buffer base timestamps, adjustment dates, and the value returned by os.time().
Instrument on. References time to when the instrument was turned on. The value returned by os.clock() is referenced to the turn-on time.
Event. Time referenced to an event, such as the first reading stored in a reading buffer.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
A history of the key code for the last pressed front panel key is maintained by the Model 2651A. When the instrument is turned on (or when transitioning from local to remote operation), the key code is set to 0 (display.KEY_NONE).
+
When a front‑panel key is pressed, the key code value for that key can be captured and returned. There are two functions associated with the capture of key-press codes: display.getlastkey() and display.waitkey().
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
The KISweep factory script provides simple sweep test programming and shows how to use the sweeping function.
+
This script is made up of the following functions. Access these functions from the front panel or the remote interfaces. Details on these functions are provided in the tables that follow. The following functions make up the KISweep factory script:
System SourceMeter® instrument channel (set to smua)
+
+
+
+
starti
+
+
Sweep start current in amperes
+
+
+
+
stopi
+
+
Sweep stop current in amperes
+
+
+
+
stime
+
+
Settling time in seconds; occurs after stepping the source and before performing a measurement
+
+
+
+
points
+
+
Number of sweep points (must be =2)
+
+
+
+
+
Details
+
Data for voltage measurements, current source values, and timestamps are stored in smuX.nvbuffer1.
+
If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.
+
Performs a linear current sweep with voltage measured at every step (point):
+
1. Sets the smu to output starti amperes, allows the source to settle for stime seconds, and then performs a voltage measurement.
+
2. Sets the smu to output the next amperes step, allows the source to settle for stime seconds, and then performs a voltage measurement.
+
3. Repeats the above sequence until the voltage is measured on the stopi amperes step.
+
The linear step size is automatically calculated as follows:
+
step = (stopi – starti) / (points – 1)
+
+
Example
+
+
+
+
SweepILinMeasureV(smua, -1E-3, 1E-3, 0, 100)
+
+
This function performs a 100-point linear current sweep starting at -1 mA and stopping at +1 mA. Voltage is measured at every step (point) in the sweep. Because stime is set for 0 s, voltage will be measured as fast as possible after each current step.
+
+
+
+
+
Also see
+
None
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
System SourceMeter® instrument channel (set to smua)
+
+
+
+
startv
+
+
Sweep start voltage in volts
+
+
+
+
stopv
+
+
Sweep stop voltage in volts
+
+
+
+
stime
+
+
Settling time in seconds; occurs after stepping the source and before performing a measurement
+
+
+
+
points
+
+
Number of sweep points (must be =2)
+
+
+
+
+
Details
+
Data for current measurements, voltage source values, and timestamps are stored in smuX.nvbuffer1.
+
If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.
+
Performs a linear voltage sweep with current measured at every step (point):
+
1. Sets the smu to output startv amperes, allows the source to settle for stime seconds, and then performs a current measurement.
+
2. Sets the smu to output the next amperes step, allows the source to settle for stime seconds, and then performs a voltage measurement.
+
3. Repeats the above sequence until the voltage is measured on the stopv amperes step.
+
The linear step size is automatically calculated as follows:
+
step = (stopv – startv) / (points – 1)
+
+
Example
+
+
+
+
SweepVLinMeasureI(smua, -1, 1, 1E-3, 1000)
+
+
This function performs a 1000-point linear voltage sweep starting at -1 V and stopping at +1 V. Current is measured at every step (point) in the sweep after a 1 ms source settling period.
+
+
+
+
+
Also see
+
None
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This function performs a five‑point linear current sweep starting at 10 mA and stopping at 100 mA. Voltage is measured at every step (point) in the sweep. The source will be allowed to settle on each step for 1 ms before a measurement is performed.
+
+
The following table contains log values and corresponding source levels for the five‑point logarithmic sweep:
+
+
+
MeasurePoint
+
+
LogStepSize
+
+
LogStep
+
+
SourceStepLevel
+
+
+
+
1
+
+
0.25
+
+
0.0
+
+
0.01 A
+
+
+
+
2
+
+
0.25
+
+
0.25
+
+
0.017783 A
+
+
+
+
3
+
+
0.25
+
+
0.5
+
+
0.031623 A
+
+
+
+
4
+
+
0.25
+
+
0.75
+
+
0.056234 A
+
+
+
+
5
+
+
0.25
+
+
1.0
+
+
0.1 A
+
+
+
+
+
+
+
+
+
+
Also see
+
None
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This KISweep factory script function performs a current list sweep with voltage measured at every step (point).
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
SweepIListMeasureV(smu, ilist, stime, points)
+
+
+
+
smu
+
+
System SourceMeter® instrument channel (set to smua)
+
+
+
+
ilist
+
+
Arbitrary list of current source values; ilist = {value1, value2, ...valueN}
+
+
+
+
stime
+
+
Settling time in seconds; occurs after stepping the source and before performing a measurement
+
+
+
+
points
+
+
Number of sweep points (must be =2)
+
+
+
+
+
Details
+
Data for voltage measurements, current source values, and timestamps are stored in smuX.nvbuffer1.
+
If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.
+
Performs a current list sweep with voltage measured at every step (point):
+
1. Sets the smu to output ilist amperes value, allows the source to settle for stime seconds, and then performs a voltage measurement.
+
2. Sets the smu to output the next ilist step, allows the source to settle for stime seconds, and then performs a voltage measurement.
+
3. Repeats the above sequence until the voltage is measured for the last amperes value. The last point in the list to be measured is points.
+
Example
+
+
+
+
testilist = {-100E-9, 100E-9, -1E-6, 1E-6,
+
-1E-3, 1E-3}
+
+
SweepIListMeasureV(smua, testilist,
+
500E-3, 6)
+
+
This function performs a six‑point current list sweep starting at the first point in testilist. Voltage is measured at every step (point) in the sweep. The source will be allowed to settle on each step for 500 ms before a measurement is performed.
+
+
+
+
+
Also see
+
None
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This function performs a five‑point logarithmic voltage sweep starting at 1 V and stopping at 10 V. Current is measured at every step (point) in the sweep after a 1 ms source settling period.
+
+
The following table contains log values and corresponding source levels for the five‑point logarithmic sweep:
+
+
+
+
MeasurePoint
+
+
LogStepSize
+
+
LogStep
+
+
SourceStepLevel
+
+
+
+
1
+
+
0.25
+
+
0.0
+
+
1.0000 V
+
+
+
+
2
+
+
0.25
+
+
0.25
+
+
1.7783 V
+
+
+
+
3
+
+
0.25
+
+
0.5
+
+
3.1623 V
+
+
+
+
4
+
+
0.25
+
+
0.75
+
+
5.6234 V
+
+
+
+
5
+
+
0.25
+
+
1.0
+
+
10.000 V
+
+
+
+
+
+
+
+
+
+
Also see
+
None
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2651A/12194.html b/WebHelpDocs/Commands_2651A/12194.html
new file mode 100644
index 0000000..a0734b4
--- /dev/null
+++ b/WebHelpDocs/Commands_2651A/12194.html
@@ -0,0 +1,48 @@
+
+
+ Retrieving and modifying a factory script listing
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Retrieving and modifying a factory script listing
+
The script listing for a factory script can be retrieved and modified. However, it cannot be saved as a factory script. The modified script can be saved as a user script using the same name or a new name.
+
An imported factory script can only be loaded back into the Model 2651A as a user script.
+
The following function retrieves a script listing. The script code is output with the shell keywords (loadscript or loadandrunscript, and endscript):
+
script.factory.scripts.name.list()
+
Where: name is the name of the factory script.
+
Example:
+
Retrieve the script listing for a factory script named “KIPulse”:
+
script.factory.scripts.KIPulse.list()
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2651A/124.gif b/WebHelpDocs/Commands_2651A/124.gif
new file mode 100644
index 0000000..65878ab
Binary files /dev/null and b/WebHelpDocs/Commands_2651A/124.gif differ
diff --git a/WebHelpDocs/Commands_2651A/12458.html b/WebHelpDocs/Commands_2651A/12458.html
new file mode 100644
index 0000000..b946baa
--- /dev/null
+++ b/WebHelpDocs/Commands_2651A/12458.html
@@ -0,0 +1,41 @@
+
+
+ TSP-Link synchronization lines
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
TSP-Link synchronization lines
+
The Model 2651A has three synchronization lines that you can use for triggering, digital I/O, and to synchronize multiple instruments on a TSP-Link® network.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2651A/125.gif b/WebHelpDocs/Commands_2651A/125.gif
new file mode 100644
index 0000000..2478cb4
Binary files /dev/null and b/WebHelpDocs/Commands_2651A/125.gif differ
diff --git a/WebHelpDocs/Commands_2651A/12893.html b/WebHelpDocs/Commands_2651A/12893.html
new file mode 100644
index 0000000..131633e
--- /dev/null
+++ b/WebHelpDocs/Commands_2651A/12893.html
@@ -0,0 +1,67 @@
+
+
+ Logical operators
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Logical operators
+
The logical operators in Lua are and, or, and not. All logical operators consider both false and nil as false and anything else as true.
+
The operator not always returns false or true.
+
The conjunction operator and returns its first argument if this value is false or nil; otherwise, and returns its second argument. The disjunction operator or returns its first argument if this value is different from nil and false; otherwise, or returns its second argument. Both and and or use shortcut evaluation, that is, the second operand is evaluated only if necessary.
+
Example
+
+
+
+
print(10 or errorqueue.next())
+
print(nil or "a")
+
print(nil and 10)
+
print(false and errorqueue.next())
+
print(false and nil)
+
print(false or nil)
+
print(10 and 20)
+
+
1.00000e+01
+
a
+
nil
+
false
+
false
+
nil
+
2.00000e+01
+
+
+
+
+
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
The Keithley Instruments Model 2651A High Power System SourceMeter® Instrument is shipped with one or more factory scripts saved in its flash firmware memory. A factory script is made up of a number of functions. Some of them can be called from the front‑panel LOAD TEST menu. All of them can be called using remote programming.
+
As Keithley Instruments develops additional factory scripts, they will be made available on the Keithley Instruments website as a flash firmware upgrade for the Model 2651A. See Upgrading the firmware for instructions on upgrading the flash firmware of your Model 2651A instrument.
+
A factory script is similar to a user script, except a factory script is created by Keithley Instruments at the factory and is permanently stored in nonvolatile memory. The differences between a user script and a factory script include the following:
+
A factory script cannot be deleted from nonvolatile memory.
The script listing for a factory script can be retrieved and modified, but it will then be treated as a user script. A user script cannot be saved as a factory script.
Factory scripts are not stored in global variables. The only references to factory scripts are in the script.factory.scripts attribute.
The script.factory.catalog() function returns an iterator that can be used in a for loop to iterate over all the factory scripts.
Example
+
To retrieve the catalog listing for factory scripts, send:
+
for name in script.factory.catalog() do print(name) end
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
The KIPulse factory script provides examples of how to generate pulses and to provide a simple pulsing interface. Pulses can be generated using the functions listed below.
+
Please note the following information about the KIPulse factory script:
Ÿ This factory script only operates on the channels present in the instrument executing the pulse functions. These functions will not operate correctly if you attempt to access instrument channels over the TSP‑Link® interface.
Ÿ The KIPulse factory scripts are general purpose examples that may not be suitable for all use cases. Very short pulses (less than 1ms pulse width) may require optimization of the examples provided by the factory script in order to achieve settled measurements.
Ÿ The PulseIMeasureV() and PulseVMeasureI() functions may be accessed from the front panel. The remaining functions may only be accessed remotely.
+
Use the configuration KIPulse tag parameter pulse functions to configure a pulse train and assign the configuration to the tagparameter (use QueryPulseConfig() to inspect configured pulse trains). Use the initiation InitiatePulseTest() function to execute the pulse trains assigned to its tag arguments. The conditions listed in the table below must be true for these functions to execute successfully.
+
Conditions that must be true for successful function execution:
+
+
+
Config functions:
+
+
+
+
InitiatePulseTest functions:
+
+
+
+
Source autorange (I and V) off
+
+
+
+
Output on
+
+
+
+
Measure autorange (I and V) off
+
+
+
+
There is enough free space in the buffer
+
+
+
+
Measure NPLC < ton
+
+
+
+
Buffer append mode is on when pulse train is >1 point
This KIPulse factory script function performs a specified number of pulse I, measure V cycles.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
PulseIMeasureV(smu, bias, level, ton, toff, points)
+
+
+
+
smu
+
+
System SourceMeter® instrument channel (set to smua)
+
+
+
+
bias
+
+
Bias level in amperes
+
+
+
+
level
+
+
Pulse level in amperes
+
+
+
+
ton
+
+
Pulse on time in seconds
+
+
+
+
toff
+
+
Pulse off time in seconds
+
+
+
+
points
+
+
Number of pulse-measure cycles
+
+
+
+
+
Details
+
Data for pulsed voltage measurements, current levels, and timestamps are stored in smua.nvbuffer1.
+
If any parameters are omitted or nil, the operator will be prompted to enter them using the front panel.
+
To perform the specified number of pulse I, measure V cycles, this function:
+
1. Sets the smu to output bias amperes and dwell for toff seconds.
+
2. Sets the smu to output level amperes and dwell for ton seconds.
+
3. Performs voltage measurement with source at level amperes.
+
4. Sets the smu to output bias amperes for toff seconds.
+
5. Repeats steps 2 through 4 for all remaining points pulse-measure cycles.
+
+
Example
+
+
+
+
PulseIMeasureV(smua, 0.001, 1.0,
+
20e-3, 40e-3, 10)
+
+
SMU A will output 1 mA and dwell for 40 ms, output 1 A and dwell for 20 ms. The voltage measurements occur during each 20 ms dwell period. After the measurement, the output will return to 1 mA and dwell for 40 ms. This pulse‑measure process will repeat nine more times.
+
+
+
+
+
Also see
+
None
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This KIPulse factory script function performs a specified number of pulse V, measure I cycles.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
PulseVMeasureI(smu, bias, level, ton, toff, points)
+
+
+
+
smu
+
+
System SourceMeter® instrument channel (set to smua)
+
+
+
+
bias
+
+
Bias level in volts
+
+
+
+
level
+
+
Pulse level in volts
+
+
+
+
ton
+
+
Pulse on time in seconds
+
+
+
+
toff
+
+
Pulse off time in seconds
+
+
+
+
points
+
+
Number of pulse-measure cycles
+
+
+
+
+
Details
+
If any parameters are omitted or nil, the operator will be prompted to enter them using the front panel. Data for pulsed current measurements, voltage levels, and timestamps are stored in smuX.nvbuffer1.
+
To perform the specified number of pulse V, measure I cycles, this function:
+
Sets the smuto output bias volts and dwell for toff seconds
Sets the smu to output level volts and dwell for ton seconds
Performs voltage measurement with source at level volts
Sets the smu to output bias volts for toff seconds
Repeats steps 2 through 4 for the remaining points pulse-measure cycles
+
+
Example 1
+
+
+
+
smua.measure.nplc = 0.001
+
PulseVMeasureI(smua, -1, 1, 1E-3, 2E-3, 20)
+
+
SMU A will output -1 V and dwell for 2 ms, output 1 V and dwell for 1 ms. The current measurement occurs during the dwell period. After the measurement, the output will return to -1 V and dwell for 2 ms. This pulse-measure process will repeat 19 more times.
+
+
+
+
+
Also see
+
None
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
A Boolean flag. This flag will be true when the pulse was successfully configured, false when errors were encountered
+
+
+
+
msg
+
+
A string message; if the f flag is false, msg will contain an error message; if it is true, msg will contain a string indicating successful configuration
+
+
+
+
smu
+
+
System SourceMeter® instrument channel (set to smua)
+
+
+
+
bias
+
+
Bias level in amperes
+
+
+
+
level
+
+
Pulse level in amperes
+
+
+
+
limit
+
+
Voltage limit (for example, compliance) in volts
+
+
+
+
ton
+
+
Pulse on time in seconds
+
+
+
+
toff
+
+
Pulse off time in seconds
+
+
+
+
points
+
+
Number of pulse-measure cycles
+
+
+
+
buffer
+
+
Reading buffer where pulsed measurements will be stored; if this is nil when the function is called, no measurements will be made when the pulse train is initiated
+
+
+
+
tag
+
+
Numeric identifier to be assigned to the defined pulse train
+
+
+
+
sync_in
+
+
Defines a digital I/O trigger input line; if programmed, the pulse train will wait for a trigger input before executing each pulse
+
+
+
+
sync_out
+
+
Defines a digital I/O trigger output line; if programmed, the pulse train will generate a trigger output immediately before the start of ton (this parameter is optional)
+
+
+
+
sync_in_timeout
+
+
Specifies the length of time (in seconds) to wait for input trigger; default value is 10 s
+
+
+
+
sync_in_abort
+
+
Specifies whether or not to abort pulse if input trigger is not received. If pulse aborts because of a missed trigger, a timer timeout message is returned; true or false
+
+
+
+
+
Details
+
Data for pulsed voltage measurements are stored in the reading buffer specified by the buffer input parameter.
+
Configures a current pulse train with a voltage measurement at each point. Measurements are made at the end of the ton time.
+
This function does not cause the specified smu to output a pulse train. It simply checks to see if all of the pulse dimensions are achievable, and if they are, assigns the indicated tag or index to the pulse train. The InitiatePulseTest(tag) function is used to initiate a pulse train assigned to a valid tag.
+
+
Example
+
+
+
+
ConfigPulseIMeasureV(smua, 0, 5, 10,
+
0.001, 0.080, 1, smua.nvbuffer1, 1)
+
+
Set up a pulse train that uses System SourceMeter® instrument channel A. The pulse amplitude will be 5 A and will return to 0 A after 1 ms. The pulse will remain at 0 A for 80 ms and the voltage limit will be 10 V during the pulse. The pulse train will consist of only 1 pulse, and this pulse will be assigned a tag index of 1.
A Boolean flag; this flag will be true when the pulse was successfully configured, false when errors were encountered
+
+
+
+
msg
+
+
A string message; if the f flag is false, msg will contain an error message; if it is true, msg will contain a string indicating successful configuration
+
+
+
+
tag
+
+
Numeric identifier of the pulse configuration to be initiated
+
+
+
+
+
Details
+
This function will only initiate configured pulse trains assigned to a valid tag. Configure the pulse before initiating it using one of the ConfigurePulse* functions (refer to the Also see section).
+
Example
+
+
+
+
smua.reset()
+
+
smua.source.rangev = 5
+
smua.source.rangei = 1
+
smua.source.levelv = 0
+
+
smua.measure.rangev = 5
+
smua.measure.rangei = 1
+
smua.measure.nplc = 0.01
+
smua.measure.autozero = smua.AUTOZERO_ONCE
+
+
smua.nvbuffer1.clear()
+
smua.nvbuffer1.appendmode = 1
+
+
smua.source.output = smua.OUTPUT_ON
+
+
f1, msg1 = ConfigPulseVMeasureI(smua, 0, 5,
+
1, 0.002, 0.2, 10, smua.nvbuffer1, 1)
+
+
if f1 == true then
+
f2, msg2 = InitiatePulseTest(1)
+
print("Initiate message:", msg2)
+
else
+
print("Config errors:", msg1)
+
end
+
+
Configure System SourceMeter® instrument channel A to generate a pulse train. If no errors are encountered, initiate the pulse train. Channel A will pulse voltage from a bias level of 0 V to a pulse level of 5 V. The pulse level will be present for 2 ms and the bias level for 200 ms, with a 1 A limit setting. A total of 10 pulses will be generated, and the measurement data will be stored in smua.nvbuffer1. This pulse train will be assigned to tag = 1.
A Boolean flag; this flag will be true when the pulse was successfully configured, false when errors were encountered
+
+
+
+
msg
+
+
A string message; if the f flag is false, msg will contain an error message; if it is true, msg will contain a string indicating successful configuration
+
+
+
+
smu
+
+
System SourceMeter® instrument channel (set to smua)
+
+
+
+
bias
+
+
Bias level in volts
+
+
+
+
level
+
+
Pulse level in volts
+
+
+
+
limit
+
+
Current limit (for example, compliance) in amperes
+
+
+
+
ton
+
+
Pulse on time in seconds
+
+
+
+
toff
+
+
Pulse off time in seconds
+
+
+
+
points
+
+
Number of pulse-measure cycles
+
+
+
+
buffer
+
+
Reading buffer where pulsed measurements will be stored; if this is nil when the function is called, no measurements will be made when the pulse train is initiated
+
+
+
+
tag
+
+
Numeric identifier to be assigned to the defined pulse train
+
+
+
+
sync_in
+
+
Defines a digital I/O trigger input line; if programmed, the pulse train will wait for a trigger input before executing each pulse (this parameter is optional)
+
+
+
+
sync_out
+
+
Defines a digital I/O trigger output line; if programmed, the pulse train will generate a trigger output immediately before the start of ton (this parameter is optional)
+
+
+
+
sync_in_timeout
+
+
Specifies the length of time (in seconds) to wait for input trigger; default value is 10 s
+
+
+
+
sync_in_abort
+
+
Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or false
+
+
+
+
+
Details
+
Data for pulsed current measurements are stored in the reading buffer specified by the buffer input parameter.
+
Configures a voltage pulse train with a current measurement at each point. Measurements are made at the end of the ton time.
+
This function does not cause the specified smu to output a pulse train. It simply checks to see if all of the pulse dimensions are achievable, and if they are, assigns the indicated tag or index to the pulse train.The InitiatePulseTest(tag) function is used to initiate a pulse train assigned to a valid tag.
+
+
Example 1
+
+
+
+
ConfigPulseVMeasureI(smua, 0, 20, 1,
+
0.001, 0.080, 10, smua.nvbuffer1, 2)
+
+
Set up a pulse train that uses System SourceMeter® instrument channel A. The pulse amplitude will be 20 V and will return to 0 V after 1 ms. The pulse will remain at 0 V for 80 ms, and the current limit will be 1 A during the pulse. The pulse train will consist of 10 pulses, and the pulse train will be assigned a tag index of 2.
+
+
+
+
+
+
Example 2
+
+
+
+
local timelist = { 1, 2, 3, 4, 5 }
+
+
f, msg = ConfigPulseVMeasureI(smua, 0, 1,
+
100e-3, 1, timelist, 5, nil, 1)
+
+
Variable off time between pulses in a pulse train.
+
Configure a pulse with 1 second on-time and variable off-time, no measurement.
A Boolean flag; this flag will be true when the pulse was successfully configured, false when errors were encountered
+
+
+
+
msg
+
+
A string message; if the f flag is false, msg will contain an error message; if it is true, msg will contain a string indicating successful configuration
+
+
+
+
smu
+
+
System SourceMeter® instrument channel (set to smua)
+
+
+
+
bias
+
+
Bias level in amperes
+
+
+
+
start
+
+
Pulse sweep start level in volts
+
+
+
+
stop
+
+
Pulse sweep stop level in volts
+
+
+
+
limit
+
+
Voltage limit (for example, compliance) in volts
+
+
+
+
ton
+
+
Pulse on time in seconds
+
+
+
+
toff
+
+
Pulse off time in seconds
+
+
+
+
points
+
+
Number of pulse-measure cycles
+
+
+
+
buffer
+
+
Reading buffer where pulsed measurements will be stored; if this is nil when the function is called, no measurements will be made when the pulse train is initiated
+
+
+
+
tag
+
+
Numeric identifier to be assigned to the defined pulse train
+
+
+
+
sync_in
+
+
Defines a digital I/O trigger input line; if programmed, the pulse train will wait for a trigger input before executing each pulse (this parameter is optional)
+
+
+
+
sync_out
+
+
Defines a digital I/O trigger output line; if programmed, the pulse train will generate a trigger output immediately before the start of ton (this parameter is optional)
+
+
+
+
sync_in_timeout
+
+
Specifies the length of time (in seconds) to wait for input trigger; default value is 10 s
+
+
+
+
sync_in_abort
+
+
Specifies whether or not to abort pulse if input trigger is not received. If pulse aborts because of a missed trigger, a timer timeout message is returned; true or false
+
+
+
+
+
Details
+
Data for pulsed voltage measurements are stored in the reading buffer specified by the buffer input parameter.
+
Configures a linear pulsed current sweep with a voltage measurement at each point. Measurements are made at the end of the ton time.
+
The magnitude of the first pulse will be start amperes; the magnitude of the last pulse will be stop amperes. The magnitude of each pulse in between will be step amperes larger than the previous pulse, where:
+
step = (stop - start) / (points - 1)
+
This function does not cause the specified smu to output a pulse train. It simply checks to see if all of the pulse dimensions are achievable, and if they are, assigns the indicated tag or index to the pulse train. The InitiatePulseTest(tag) function is used to initiate a pulse train assigned to a valid tag.
+
+
Example
+
+
+
+
ConfigPulseIMeasureVSweepLin(smua, 0,
+
0.01, 0.05, 1, 1e-3, 0.1, 20,
+
smua.nvbuffer2, 3)
+
+
Set up a pulsed sweep that will use System SourceMeter® instrument channel A. The pulsed sweep will start at 10 mA, end at 50 mA, and return to a 0 mA bias level between pulses. Each pulsed step will be on for 1 ms, and then at the bias level for 100 ms. The voltage limit will be 1 V during the entire pulsed sweep. The pulse train will be comprised of 20 pulsed steps and the pulse train will be assigned a tag index of 3.
f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff,
+
points, buffer, tag, sync_in, sync_out)
+
f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff,
+
points, buffer, tag, sync_in)
+
f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff,
+
points, buffer, tag)
+
+
+
+
f
+
+
A Boolean flag. This flag will be true when the pulse was successfully configured, false when errors were encountered
+
+
+
+
msg
+
+
A string message; if the f flag is false, msg will contain an error message; if it is true, msg will contain a string indicating successful configuration
+
+
+
+
smu
+
+
System SourceMeter® instrument channel (set to smua)
+
+
+
+
bias
+
+
Bias level in volts
+
+
+
+
start
+
+
Pulse sweep start level in volts
+
+
+
+
stop
+
+
Pulse sweep stop level in volts
+
+
+
+
limit
+
+
Current limit (for example, compliance) in amperes
+
+
+
+
ton
+
+
Pulse on time in seconds
+
+
+
+
toff
+
+
Pulse off time in seconds
+
+
+
+
points
+
+
Number of pulse-measure cycles
+
+
+
+
buffer
+
+
Reading buffer where pulsed measurements will be stored; if this is nil when the function is called, no measurements will be made when the pulse train is initiated
+
+
+
+
tag
+
+
Numeric identifier to be assigned to the defined pulse train
+
+
+
+
sync_in
+
+
Defines a digital I/O trigger input line; if programmed, the pulse train will wait for a trigger input before executing each pulse (this parameter is optional)
+
+
+
+
sync_out
+
+
Defines a digital I/O trigger output line; if programmed, the pulse train will generate a trigger output immediately before the start of ton (this parameter is optional)
+
+
+
+
sync_in_timeout
+
+
Specifies the length of time (in seconds) to wait for input trigger; default value is 10 s
+
+
+
+
sync_in_abort
+
+
Specifies whether or not to abort pulse if input trigger is not received. If pulse aborts because of a missed trigger, a timer timeout message is returned; true or false
+
+
+
+
+
Details
+
Data for pulsed current measurements are stored in the reading buffer specified by the buffer input parameter.
+
Configures a linear pulsed voltage sweep with a current measurement at each point. Measurements are made at the end of the ton time.
+
The magnitude of the first pulse will be start volts; the magnitude of the last pulse will be stop volts. The magnitude of each pulse in between will be step volts larger than the previous pulse, where:
+
step = (stop - start) / (points - 1)
+
This function does not cause the specified smu to output a pulse train. It simply checks to see if all of the pulse dimensions are achievable, and if they are, assigns the indicated tag or index to the pulse train. The InitiatePulseTest(tag) function is used to initiate a pulse train assigned to a valid tag.
+
+
Example
+
+
+
+
ConfigPulseVMeasureISweepLin(smua, 0, 1,
+
10, 1, 10e-3, 20e-3, 16,
+
smua.nvbuffer1, 4)
+
+
Set up a pulsed sweep that will use System SourceMeter® instrument channel A. The pulsed sweep will start at 1 V, end at 10 V, and return to a 0 V bias level between pulses. Each pulsed step will be on for 10 ms, and then at the bias level for 20 ms.
+
The current limit will be 1 A during the entire pulsed sweep. The pulse train will be comprised of 16 pulsed steps, and the pulse train will be assigned a tag index of 4.
f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff,
+
points, buffer, tag, sync_in, sync_out)
+
f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff,
+
points, buffer, tag, sync_in)
+
f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff,
+
points, buffer, tag)
+
+
+
+
f
+
+
A Boolean flag; this flag will be true when the pulse was successfully configured, false when errors were encountered
+
+
+
+
msg
+
+
A string message; if the f flag is false, msg will contain an error message; if it is true, msg will contain a string indicating successful configuration
+
+
+
+
smu
+
+
System SourceMeter® instrument channel (set to smua)
+
+
+
+
bias
+
+
Bias level in amperes
+
+
+
+
start
+
+
Pulse sweep start level in amperes
+
+
+
+
stop
+
+
Pulse sweep stop level in amperes
+
+
+
+
limit
+
+
Voltage limit (for example, compliance) in volts
+
+
+
+
ton
+
+
Pulse on time in seconds
+
+
+
+
toff
+
+
Pulse off time in seconds
+
+
+
+
points
+
+
Number of pulse-measure cycles
+
+
+
+
buffer
+
+
Reading buffer where pulsed measurements will be stored; if this is nil when the function is called, no measurements will be made when the pulse train is initiated
+
+
+
+
tag
+
+
Numeric identifier to be assigned to the defined pulse train
+
+
+
+
sync_in
+
+
Defines a digital I/O trigger input line; if programmed, the pulse train will wait for a trigger input before executing each pulse (this parameter is optional)
+
+
+
+
sync_out
+
+
Defines a digital I/O trigger output line; if programmed, the pulse train will generate a trigger output immediately before the start of ton (this parameter is optional)
+
+
+
+
sync_in_timeout
+
+
Specifies the length of time (in seconds) to wait for input trigger; default value is 10 s
+
+
+
+
sync_in_abort
+
+
Specifies whether or not to abort pulse if input trigger is not received. If pulse aborts because of a missed trigger, a timer timeout message is returned; true or false
+
+
+
+
+
Details
+
Data for pulsed voltage measurements are stored in the reading buffer specified by the buffer input parameter.
+
Configures a logarithmic pulsed current sweep with a voltage measurement at each point. Measurements are made at the end of the ton time.
+
The magnitude of the first pulse will be start amperes; the magnitude of the last pulse will be stop amperes. The magnitude of each pulse in between will be LogStepn amperes larger than the previous pulse, where:
LogStepn = (n - 1) * (LogStepSize), where n = [1, points]
+
SourceStepLeveln = antilog(LogStepn) * start
+
This function does not cause the specified smu to output a pulse train. It simply checks to see if all of the pulse dimensions are achievable, and if they are, assigns the indicated tag or index to the pulse train. The InitiatePulseTest(tag) function is used to initiate a pulse train assigned to a valid tag.
+
+
Example
+
+
+
+
ConfigPulseIMeasureVSweepLog(smua, 0,
+
1e-3, 0.01, 1, 1e-3, 10e-3, 10,
+
smua.nvbuffer1, 5)
+
+
Set up a pulsed logarithmic sweep that uses System SourceMeter® instrument channel A. The pulsed sweep will start at 1 mA, end at 10 mA, and return to a 0 A bias level between pulses. Each pulsed step will be on for 1 ms, and then at the bias level for 10 ms. The voltage limit will be 1 V during the entire pulsed sweep. The pulse train will be comprised of 10 pulsed steps, and the pulse train will be assigned a tag index of 5.
f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff,
+
points, buffer, tag, sync_in, sync_out)
+
f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff,
+
points, buffer, tag, sync_in)
+
f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff,
+
points, buffer, tag)
+
+
+
+
f
+
+
A Boolean flag. This flag will be true when the pulse was successfully configured, false when errors were encountered
+
+
+
+
msg
+
+
A string message; if the f flag is false, msg will contain an error message; if it is true, msg will contain a string indicating successful configuration
+
+
+
+
smu
+
+
System SourceMeter® instrument channel (set to smua)
+
+
+
+
bias
+
+
Bias level in volts
+
+
+
+
start
+
+
Pulse sweep start level in volts
+
+
+
+
stop
+
+
Pulse sweep stop level in volts
+
+
+
+
limit
+
+
Current limit (for example, compliance) in amperes
+
+
+
+
ton
+
+
Pulse on time in seconds
+
+
+
+
toff
+
+
Pulse off time in seconds
+
+
+
+
points
+
+
Number of pulse-measure cycles
+
+
+
+
buffer
+
+
Reading buffer where pulsed measurements will be stored; if this is nil when the function is called, no measurements will be made when the pulse train is initiated
+
+
+
+
tag
+
+
Numeric identifier to be assigned to the defined pulse train
+
+
+
+
sync_in
+
+
Defines a digital I/O trigger input line; if programmed, the pulse train will wait for a trigger input before executing each pulse (this parameter is optional)
+
+
+
+
sync_out
+
+
Defines a digital I/O trigger output line; if programmed, the pulse train will generate a trigger output immediately before the start of ton (this parameter is optional)
+
+
+
+
sync_in_timeout
+
+
Specifies the length of time (in seconds) to wait for input trigger; default value is 10 s
+
+
+
+
sync_in_abort
+
+
Specifies whether or not to abort pulse if input trigger is not received. If pulse aborts because of a missed trigger, a timer timeout message is returned; true or false
+
+
+
+
+
Details
+
Data for pulsed current measurements are stored in the reading buffer specified by the buffer input parameter.
+
Configures a logarithmic pulsed voltage sweep with a current measurement at each point. Measurements are made at the end of the ton time.
+
The magnitude of the first pulse will be start volts; the magnitude of the last pulse will be stop volts. The magnitude of each pulse in between will be LogStepn volts larger than the previous pulse, where:
LogStepn = (n - 1) * (LogStepSize), where n = [1, points]
+
SourceStepLeveln = antilog(LogStepn) * start
+
This function does not cause the specified smu to output a pulse train. It simply checks to see if all of the pulse dimensions are achievable, and if they are, assigns the indicated tag or index to the pulse train. The InitiatePulseTest(tag)function is used to initiate a pulse train assigned to a valid tag.
+
+
Example
+
+
+
+
ConfigPulseVMeasureISweepLog(smua, 0, 1,
+
10, 1, 10e-3, 20e-3, 10,
+
smua.nvbuffer1, 6)
+
+
Set up a pulsed logarithmic sweep that will use System SourceMeter® instrument channel A. The pulsed sweep will start at 1 V, end at 10 V, and return to a 0 V bias level between pulses. Each pulsed step will be on for 10 ms, and then at the bias level for 20 ms.
+
The current limit will be 1 A during the entire pulsed sweep. The pulse train will be comprised of 10 pulsed steps, and the pulse train will be assigned a tag index of 6.
This KIPulse factory script function allows you to inspect the settings of the preconfigured pulse train assigned to tag.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
tbl = QueryPulseConfig(tag)
+
+
+
+
tag
+
+
Numeric identifier to be assigned to the defined pulse train
+
+
+
+
tbl
+
+
Returned table
+
+
+
+
+
Details
+
Once a pulse train has been configured and assigned to a tag, it is often desirable to inspect the settings of this preconfigured pulse train. The QueryPulseConfig() command can be used for this purpose.
+
This function will return a table containing the various settings associated with the tag input parameter.
+
+
+
+
+
+
+
Return values:
+
+
+
+
tostring()
+
+
A function that returns most elements in a string convenient for printing
+
+
+
+
tag
+
+
Identifying tag for this pulse train
+
+
+
+
smu
+
+
The SMU configured for pulsing
+
+
+
+
func
+
+
Pulse function:
+
smua.OUTPUT_DCAMPS or
+
smua.OUTPUT_DCVOLTS
+
+
+
+
bias
+
+
Pulse bias level
+
+
+
+
level
+
+
Pulse level for non sweeping pulses
+
+
+
+
start
+
+
Starting level for sweep pulses
+
+
+
+
stop
+
+
Ending level for sweep pulses
+
+
+
+
limit
+
+
Limit value
+
+
+
+
ton
+
+
On time in seconds
+
+
+
+
toff
+
+
Off time in seconds
+
+
+
+
points
+
+
The number of points in this pulse train
+
+
+
+
buf
+
+
Reference to buffer containing measurement data
+
+
+
+
sync_in
+
+
The sync_in digio line, if used
+
+
+
+
sync_out
+
+
The sync_out digio line, if used
+
+
+
+
sourcevalues
+
+
A table containing the source value for each point in the pulse train
+
+
+
+
+
Example
+
+
+
+
smua.reset()
+
+
smua.source.rangev = 5
+
smua.source.rangei = 1
+
smua.source.levelv = 0
+
+
smua.measure.rangev = 5
+
smua.measure.rangei = 1
+
smua.measure.nplc = 0.01
+
smua.measure.autozero = smua.AUTOZERO_ONCE
+
+
smua.nvbuffer1.clear()
+
smua.nvbuffer1.appendmode = 1
+
+
smua.source.output = smua.OUTPUT_ON
+
+
f1, msg1 = ConfigPulseVMeasureI(smua, 0, 5,
+
1, 0.002, 0.2, 10, smua.nvbuffer1, 1)
+
+
print(QueryPulseConfig(1).tostring())
+
+
Configure channel A to generate a pulse train, query configuration, and then display as a string. Channel A will pulse voltage from a bias level of 0 V to a pulse level of 5 V. The pulse level will be present for 2 ms, and the bias level for 200 ms with a 1 A limit setting. A total of 10 pulses will be generated, and the measurement data will be stored in smua.nvbuffer1. This pulse train will be assigned to tag = 1.
The KIHighC factory script is made up of two functions: i_leakage_measure() and i_leakage_threshold(). These functions are intended to be used when HighC mode is active. Output is generally at a non-zero voltage prior to calling these functions. These functions can also be used to step the voltage to zero volts in order to measure the leakage current.
System SourceMeter® instrument channel (set to smua)
+
+
+
+
levelv
+
+
Voltage level to step to when this function is called
+
+
+
+
limiti
+
+
Current limit setting for the voltage step
+
+
+
+
sourcedelay
+
+
Delay to wait before lowering the current limit for measurement
+
+
+
+
measurei
+
+
Current limit (and measure range); note the current limit is lower at this level and because high-capacitance mode is active, the measure range will follow
+
+
+
+
measuredelay
+
+
Delay to wait after lowering the current limit before taking the measurement
+
+
+
+
+
Details
+
Use this function when high-capacitance mode is active.
+
When the instrument is in high-capacitance mode, this function causes the smu to:
+
Change its current limit to limiti with a voltage output of levelv for sourcedelay time, and then changes its current limit to measurei (that also changes the measurement range to measurei) for measuredelay time
When measuredelay time expires, a measurement is taken and returned as imeas.
When measuring leakage current:
+
Charge the capacitor before calling this function (the instrument's output is usually at a nonzero voltage prior to calling this function; when measuring leakage, this function does not charge the capacitor).
Set levelv = 0
Example
+
+
+
+
smua.source.highc = smua.ENABLE
+
smua.source.levelv = 5
+
smua.source.output = smua.OUTPUT_ON
+
delay(1)
+
imeas = i_leakage_measure(smua, 0, 1, 300e‑3,
+
10e-6, .1)
+
+
Enable high-capacitance mode.
+
Charge the capacitor at 5 V for 1 second set by delay(1).
+
+
The parameters passed on to the i_leakage_measure() function in this example are:
+
smu = smua
+
levelv = 0 V
+
limiti = 1 A
+
sourcedelay = 300 ms
+
measurei = 10 mA range
+
measuredelay = 100 ms
+
The levels and delays will depend on the value and type of capacitor used.
This KIHighC factory script function measures the current and compares it to a threshold until either the measured current drops below the threshold or the timeout expires.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
f = i_leakage_threshold(smu, levelv, limiti, sourcedelay, measurei, measuredelay, threshold, timeout)
+
+
+
+
f
+
+
A Boolean flag; this flag will be true when the current is below the threshold, false if threshold is not reached before timeout expires
+
+
+
+
smu
+
+
System SourceMeter® instrument channel (set to smua)
+
+
+
+
levelv
+
+
Voltage level to step to when this function is called
+
+
+
+
limiti
+
+
Current limit setting for the voltage step
+
+
+
+
sourcedelay
+
+
Delay to wait before lowering the current limit for measurement
+
+
+
+
measurei
+
+
Current limit (and measure range); note the current limit is lower at this level and because high-capacitance mode is active, the measure range will follow
+
+
+
+
measuredelay
+
+
Delay before the first measurement after measure range is changed
+
+
+
+
threshold
+
+
The specified current that establishes the test limit
+
+
+
+
timeout
+
+
Amount of time (in seconds) to wait for the current to drop to threshold after all the delays have occurred
+
+
+
+
+
Details
+
This function is intended to be used when high-capacitance mode is active.
+
When the instrument is in high-capacitance mode, this function causes the smu to:
+
Change its current limit to limiti with a voltage output of levelv for sourcedelay time, and then changes its current limit to measurei (that also changes the measurement range to measurei) for measuredelay time
When measuredelay time expires, measurements are taken at a rate determined by the smuX.measure.nplc setting
The function returns true if threshold is reached; the function returns false if threshold is not reached before timeout expires.
+
When testing the leakage current threshold:
+
Charge the capacitor before calling this function (the instrument's output is usually at a non-zero voltage prior to calling this function; when measuring leakage, this function does not charge the capacitor).
If testing the device's leakage current threshold, set levelv = 0.
Example
+
+
+
+
smua.source.highc = smua.ENABLE
+
smua.source.levelv = 5
+
smua.source.output = smua.OUTPUT_ON
+
delay(1)
+
pass = i_leakage_threshold(smua, 0, 1,
+
300e-3, 10e-6, 100e-3, 1e-6, 1)
+
+
Enable high-capacitance mode.
+
Charge the capacitor.
+
+
+
The parameters passed on to the i_threshold_measure() function in this example are:
+
smu = smua
+
levelv = 0 V
+
limiti = 1 A
+
sourcedelay = 300 ms
+
measurei = 10 mA range
+
measuredelay = 100 ms
+
threshold = 1 mA
+
timeout = 1 s
+
The levels and delays will depend on the value and type of capacitor used.
+
Sets pass = true if the current is measured below 1 mA in less than 1 second.
A Lua table containing the calculated Gm values at each point
+
+
+
+
ibuf
+
+
A reading buffer containing the measured current at each point
+
+
+
+
vbuf
+
+
A reading buffer containing the measured voltage at each point
+
+
+
+
smu
+
+
System SourceMeter® instrument channel (set to smua)
+
+
+
+
start_v
+
+
Starting voltage level of the sweep
+
+
+
+
stop_v
+
+
Ending voltage level of the sweep
+
+
+
+
points
+
+
Number of measurements between start_v and stop_v (must be = 2)
+
+
+
+
+
Details
+
Output data includes transconductance values, reading buffer with measured currents, reading buffer with measured currents and voltages.
+
The gm_vsweep() function performs a linear voltage sweep, measuring voltage and current, and then calculating the transconductance (Gm) at each point using the central difference method. It can return an array of Gm values, a reading buffer with the measured currents, and a reading buffer with the measured voltages.
+
Example
+
+
+
+
gm_array = gm_vsweep(smua, 0, 5, 20)
+
+
gm_array, ibuf = gm_vsweep(smua, 0, 5, 20)
+
+
+
gm_array, ibuf, vbuf = gm_vsweep(smua, 0, 5, 20)
+
+
SMU A returns Gm values only.
+
+
SMU A returns Gm and reading buffer with measured currents.
+
+
SMU A returns Gm and reading buffers with measured currents and voltages.
A Lua table containing the calculated Gm values at each point
+
+
+
+
vbuf
+
+
A reading buffer containing the measured voltage at each point
+
+
+
+
ibuf
+
+
A reading buffer containing the measured current at each point
+
+
+
+
smu
+
+
System SourceMeter® instrument channel (set to smua)
+
+
+
+
start_i
+
+
Starting current level of the sweep
+
+
+
+
stop_i
+
+
Ending current level of the sweep
+
+
+
+
points
+
+
Number of measurements between start_i and stop_i (must be = 2)
+
+
+
+
+
Details
+
Output data includes transconductance values, reading buffer with measured voltages, reading buffer with measured voltages and currents.
+
If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.
+
The gm_isweep() function performs a linear current sweep, measuring voltage and current, and then calculating the transconductance (Gm) at each point using the central difference method. It can return an array of Gm values, a reading buffer with the measured voltages, and a reading buffer with the measured currents.
+
Example
+
+
+
+
gm_array = gm_isweep(smua, 0, 0.01, 20)
+
+
+
gm_array, vbuf = gm_isweep(smua, 0, 0.01, 20)
+
+
+
gm_array, vbuf, ibuf = gm_isweep(smua, 0,
+
0.01, 20)
+
+
Source‑measure unit (SMU) A returns Gm values only.
+
+
SMU A returns Gm and reading buffer with measured voltages.
+
+
SMU A returns Gm and reading buffers with measured voltages and currents.
This section contains an overview of the instrument commands organized into groups, with a brief description of each group. Each section contains links to the detailed command descriptions for each command in the Command reference section of this documentation.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
Reading buffers capture measurements, ranges, instrument status, and output state of the Keithley Instruments Model 2651A High Power System SourceMeter® Instrument. The Model 2651A has two dedicated reading buffers. You can use the dedicated reading buffers to acquire readings, or you can use the smuX.makebuffer() function to create dynamic reading buffers.
+
Each dedicated reading buffer in the Model 2651A can store over 60,000 readings with the timestamps and source values options enabled. Disable the timestamps and source values options to store over 140,000 readings internally.
+
You can save the dedicated reading buffers to internal nonvolatile memory in the instrument or to the USB flash drive.
+
Once you save the reading buffers to the USB flash drive, insert the USB flash drive into the USB port on your computer to view the data in any compatible data analysis application, or to transfer the data from the USB flash drive to your computer.
+
Reading buffers (other than the dedicated reading buffers) have fixed capacity and are not specifically limited to 60,000 or 140,000 readings.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
You would normally refer to all instrumentation in one enclosure or node as a single instrument. In the context of Test Script Processor (TSP®) scripting engine and instrument commands, it is useful to think of each individual subdivision in an enclosure, such as a card slot or the channels, as a stand‑alone instrument. To avoid confusion, all subdivisions of the instrumentation in an enclosure are referred to as "logical instruments."
+
Each logical instrument is given a unique identifier in a system. These identifiers are used as part of all commands that control a given logical instrument.
+
The logical instruments are:
+
+
+
beeper
+
gpib
+
+
+
bit
+
lan
+
+
+
digio
+
status
+
+
+
display
+
timer
+
+
+
eventlog
+
trigger
+
+
+
errorqueue
+
tsplink
+
+
+
format
+
smua
+
+
+
+
Do not create variable names that are the same as names of logical instruments. Doing so will result in the loss of use of the logical instrument and its associated commands. For example, if you send the command digio=5, you cannot access the digio.* commands until you turn off the power to the instrument, and then turn it on again.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
Function-based commands control actions or activities. A function-based command is not always directly related to instrument operation. For example, the bit.bitand() function will perform a logical AND operation on two numbers. Each function consists of a function name followed by a set of parentheses ( ). If the function does not have a parameter, the parentheses are left empty. If the function takes one or more parameters, they are placed between the parentheses and separated by commas.
+
+
Example 1
+
+
+
+
digio.writeport(15)
+
digio.writebit(3, 0)
+
reset()
+
digio.readport()
+
+
Sets digital I/O lines 1, 2, 3, and 4 high.
+
Sets line 3 to low (0).
+
Returns the instrument to its default settings.
+
Reads the digital I/O port.
+
+
+
+
+
Example 2
+
You can use the results of a function-based command directly or assign variables to the results for later access. The following code saves the value you enter from the front panel and prints it.
+
+
+
+
value = display.inputvalue("+0.00")
+
print(value)
+
+
If the operator enters 2.36 from the front panel, the resulting output is:
+
2.36000e+00
+
+
+
+
+
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This function resets commands to their default settings.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
reset()
+
reset(system)
+
+
+
+
system
+
+
true: If the node is the master, the entire system is reset
+
false: Only the local group is reset
+
+
+
+
+
Details
+
The reset() command in its simplest form resets the entire TSP‑enabled system, including the controlling node and all subordinate nodes.
+
If you want to reset a specific instrument, use either the localnode.reset() or node[X].reset() command. The localnode.reset() command is used for the local instrument. The node[X].reset() command is used to reset an instrument on a subordinate node.
+
When no value is specified for system, the default value is true.
+
Resetting the entire system using reset(true) is permitted only if the node is the master. If the node is not the master node, executing this command generates an error.
+
Example
+
+
+
+
reset(true)
+
+
If the node is the master node, the entire system is reset; if the node is not the master node, an error is generated.
This function sets the real-time clock (sets current time of the system).
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
settime(time)
+
+
+
+
time
+
+
The time in seconds since January 1, 1970 UTC
+
+
+
+
+
Details
+
This function sets the date and time of the instrument based on the time parameter (specified in UTC time). UTC time is specified as the number of seconds since Jan 1, 1970, UTC. You can use UTC time from a local time specification, or you can use UTC time from another source (for example, your computer).
+
To use the Lua os.time() function to generate a time value in UTC time, use the following format:
+
os.time({year = year, month = month, day = day, hour = hour, min = min, sec = sec})
+
Where:
+
+
+
year
+
+
= A full year (2006 or later)
+
+
+
+
month
+
+
= The desired month (1 to 12)
+
+
+
+
day
+
+
= The desired day (1 to 31)
+
+
+
+
hour
+
+
= The desired hour (00 to 23)
+
+
+
+
min
+
+
= The desired minute (00 to 59)
+
+
+
+
sec
+
+
= The desired second (00 to 59)
+
+
+
+
+
When you are using the os.time() function, make sure that you include the year, month, and day parameters, which are mandatory (the rest are optional). If the other parameters are not used, they default to noon for that day.
+
Set the time zone before calling the os.time() function.
+
Example
+
+
+
+
systemTime = os.time({year = 2010,
+
month = 3,
+
day = 31,
+
hour = 14,
+
min = 25})
+
settime(systemTime)
+
+
Sets the date and time to Mar 31, 2010 at 2:25 pm.
This function delays the execution of the commands that follow it.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
delay(seconds)
+
+
+
+
seconds
+
+
The number of seconds to delay, maximum 100,000
+
+
+
+
+
Details
+
You cannot set a delay for zero seconds.
+
The system delays execution of the commands for at least the specified number of seconds and fractional seconds. However, the processing time may cause the system to delay 5 µs to 10 µs (typical) more than the requested delay.
+
Example 1
+
+
+
+
beeper.beep(0.5, 2400)
+
delay(0.250)
+
beeper.beep(0.5, 2400)
+
+
Emit a double‑beep at 2400 Hz. The sequence is 0.5 s on, 0.25 s off, 0.5 s on.
+
+
+
+
+
Example 2
+
+
+
+
dataqueue.clear()
+
dataqueue.add(35)
+
timer.reset()
+
delay(0.5)
+
dt = timer.measure.t()
+
print("Delay time was " .. dt)
+
print(dataqueue.next())
+
+
Clear the data queue, add 35 to it, then delay 0.5 seconds before reading it.
+
+
Output:
+
Delay time was 0.500099
+
3.50000e+01
+
+
+
+
+
Also see
+
None
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This function creates an iterator for the user string catalog.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
for name in userstring.catalog() do body end
+
+
+
+
name
+
+
The name of the string; the key of the key-value pair
+
+
+
+
body
+
+
Code to execute in the body of the for loop
+
+
+
+
+
Details
+
The catalog provides access for userstring pairs, allowing you to manipulate all the key-value pairs in nonvolatile memory. The entries are enumerated in no particular order.
+
Example 1
+
+
+
+
for name in userstring.catalog() do
+
userstring.delete(name)
+
end
+
+
Deletes all user strings in nonvolatile memory.
+
+
+
+
+
Example 2
+
+
+
+
for name in userstring.catalog() do
+
print(name .. " = " ..
+
userstring.get(name))
+
end
+
+
Prints all userstring key‑value pairs.
+
+
Output:
+
product = Widgets
+
assetnumber = 236
+
contact = John Doe
+
The above output lists the user strings added in the example for the userstring.add() function. Notice the key-value pairs are not listed in the order they were added.
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2651A/1401.html b/WebHelpDocs/Commands_2651A/1401.html
new file mode 100644
index 0000000..f1e8e52
--- /dev/null
+++ b/WebHelpDocs/Commands_2651A/1401.html
@@ -0,0 +1,41 @@
+
+
+ Digital I/O port
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Digital I/O port
+
The Model 2651A instruments have a digital input/output port that can be used to control external digital circuitry. For example, a handler that is used to perform binning operations can be used with a digital I/O port. The digital I/O port is a standard female DB-25 connector.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
Use the functions in this group to store and retrieve user-defined strings in nonvolatile memory. These strings are stored as key‑value pairs. You can use the userstring functions to store custom, instrument-specific information in the instrument, such as department number, asset number, or manufacturing plant location.
The connection ID to be used as a handle in all other tspnet function calls
+
+
+
+
ipAddress
+
+
IP address to which to connect
+
+
+
+
portNumber
+
+
Port number
+
+
+
+
initString
+
+
Initialization string to send to ipAddress
+
+
+
+
+
Details
+
This command connects a device to another device through the LAN interface. The default port number is 5025. If the portNumber is 23, the interface uses the Telnet protocol and sets appropriate termination characters to communicate with the device.
+
If a portNumber and initString are provided, it is assumed that the remote device is not TSP‑enabled. The Model 2651A does not perform any extra processing, prompt handling, error handling, or sending of commands. Additionally, the tspnet.tsp.* commands cannot be used on devices that are not TSP‑enabled.
+
If neither a portNumber nor an initString is provided, the remote device is assumed to be a Keithley Instruments TSP‑enabled device. Depending on the state of the tspnet.tsp.abortonconnect attribute, the Model 2651A sends an abort command to the remote device on connection.
+
The Model 2651A also enables TSP prompts on the remote device and error management. The Model 2651A places remote errors from the TSP‑enabled device in its own error queue and prefaces these errors with Remote Error, followed by an error description.
+
Do not manually change either the prompt functionality (localnode.prompts) or show errors by changing localnode.showerrors on the remote TSP-enabled device, or subsequent tspnet.tsp.* commands using the connection may fail.
+
You can simultaneously connect to a maximum of 32 remote devices.
The second value decoded from the response message
+
+
+
+
valuen
+
+
The nth value decoded from the response message; there is one return value per format specifier in the format string
+
+
+
+
...
+
+
One or more values separated with commas
+
+
+
+
formatString
+
+
Format string for the output
+
+
+
+
+
Details
+
This command sends the command string to the remote instrument. A termination is added to the command string when it is sent to the remote instrument (tspnet.termination()). You can also specify a format string, which causes the command to wait for a response from the remote instrument. The Model 2651A decodes the response message according to the format specified in the format string and returns the message as return values from the function (see tspnet.read() for format specifiers).
+
When this command is sent to a TSP-enabled instrument, the Model 2651A suspends operation until a timeout error is generated or until the instrument responds, even if no format string is specified. The TSP prompt from the remote instrument is read and thrown away. The Model 2651A places any remotely generated errors into its error queue. When the optional format string is not specified, this command is equivalent to tspnet.write(), except that a termination is automatically added to the end of the command.
+
Example 1
+
+
+
+
tspnet.execute(instrumentID, "runScript()")
+
+
Command remote device to run script named runScript.
The second value decoded from the response message
+
+
+
+
valuen
+
+
The nth value decoded from the response message; there is one return value per format specifier in the format string
+
+
+
+
...
+
+
One or more values separated with commas
+
+
+
+
connectionID
+
+
The connection ID returned from tspnet.connect()
+
+
+
+
formatString
+
+
Format string for the output, maximum of 10 specifiers
+
+
+
+
+
Details
+
This command reads available data from the remote instrument and returns responses for the specified number of arguments.
+
The format string can contain the following specifiers:
+
+
+
+
%[width]s
+
+
Read data until the specific length
+
+
+
+
%[max width]t
+
+
Read data until the specific length or delimited by punctuation
+
+
+
+
%[max width]n
+
+
Read data until a newline or carriage return
+
+
+
+
%d
+
+
Read a number (delimited by punctuation)
+
+
+
+
+
A maximum of 10 format specifiers can be used for a maximum of 10 return values.
+
If formatString is not provided, the command returns a string containing the data until a new line is reached. If no data is available, the Model 2651A pauses operation until the requested data is available or until a timeout error is generated. Use tspnet.timeout to specify the timeout period.
+
When reading from a TSP-enabled remote instrument, the Model 2651A removes Test Script Processor (TSP®) prompts and places any errors received from the remote instrument into its own error queue. The Model 2651A prefaces errors from the remote device with "Remote Error," and follows this with the error number and error description.
The number of bytes available to be read from the connection
+
+
+
+
connectionID
+
+
The connection ID returned from tspnet.connect()
+
+
+
+
+
Details
+
This command checks to see if any output data is available from the device. No data is read from the instrument. This allows TSP scripts to continue to run without waiting on a remote command to finish.
+
Example
+
+
+
+
ID = tspnet.connect("192.0.2.1")
+
tspnet.write(ID, "*idn?\r\n")
+
+
repeat bytes = tspnet.readavailable(ID) until bytes > 0
This command disconnects all remote instruments connected through TSP-Net. For TSP-enabled devices, this causes any commands or scripts running remotely to be terminated.
+
Also see
+
None
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This function sets the device line termination sequence.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
type = tspnet.termination(connectionID)
+
type = tspnet.termination(connectionID, termSequence)
+
+
+
+
type
+
+
+
An enumerated value indicating the termination type:
+
1 or tspnet.TERM_LF
4 or tspnet.TERM_CR
2 or tspnet.TERM_CRLF
3 or tspnet.TERM_LFCR
+
+
+
connectionID
+
+
The connection ID returned from tspnet.connect()
+
+
+
+
termSequence
+
+
The termination sequence
+
+
+
+
+
Details
+
This function sets and gets the termination character sequence that is used to indicate the end of a line for a TSP-Net connection.
+
Using the termSequence parameter sets the termination sequence. The present termination sequence is always returned.
+
For the termSequence parameter, use the same values listed in the table above for type. There are four possible combinations, all of which are made up of line feeds (LF or 0x10) and carriage returns (CR or 0x13). For TSP-enabled devices, the default is tspnet.TERM_LF. For devices that are not TSP‑enabled, the default is tspnet.TERM_CRLF.
+
Example
+
+
+
+
deviceID = tspnet.connect("192.0.2.1")
+
if deviceID then
+
tspnet.termination(deviceID, tspnet.TERM_LF)
+
end
+
+
Sets termination type for IP address 192.0.2.1 to TERM_LF.
This attribute contains the setting for abort on connect to a TSP-enabled instrument.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset Recall setup
+
+
Not saved
+
+
1 (enable)
+
+
+
+
+
Usage
+
tspnet.tsp.abortonconnect = value
+
value = tspnet.tsp.abortonconnect
+
+
+
+
value
+
+
1 (enable) or 0 (disable)
+
+
+
+
+
Details
+
This setting determines if the instrument sends an abort message when it attempts to connect to a TSP‑enabled instrument using the tspnet.connect() function.
+
When you send the abort command on an interface, it causes any other active interface on that instrument to close. If you do not send an abort command (or if tspnet.tsp.abortonconnect is set to 0) and another interface is active, connecting to a TSP‑enabled remote instrument results in a connection. However, the instrument will not respond to subsequent reads or executes because control of the instrument is not obtained until an abort command has been sent. See Communications interfaces.
+
Example
+
+
+
+
tspnet.tsp.abortonconnect = 0
+
+
Configure the instrument so that it does not send an abort command when connecting to a TSP‑enabled instrument.
This function writes a string to the remote instrument.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
tspnet.write(connectionID, inputString)
+
+
+
+
connectionID
+
+
The connection ID returned from tspnet.connect()
+
+
+
+
inputString
+
+
The string to be written
+
+
+
+
+
Details
+
The tspnet.write() function sends inputString to the remote instrument. It does not wait for command completion on the remote instrument.
+
The Model 2651A sends inputString to the remote instrument exactly as indicated. The inputString must contain any necessary new lines, termination, or other syntax elements needed to complete properly.
+
Because tspnet.write() does not process output from the remote instrument, do not send commands that generate too much output without processing the output. This command can stop executing if there is too much unprocessed output from previous commands.
+
Example
+
+
+
+
tspnet.write(myID, "runscript()\r\n")
+
+
Commands the remote instrument to execute a command or script named "runscript()" on a remote device identified in the system as myID.
Integer value used as a handle for other tspnet commands
+
+
+
+
name
+
+
The full name of the reading buffer name and synchronous table to copy
+
+
+
+
startIndex
+
+
Integer start value
+
+
+
+
endIndex
+
+
Integer end value
+
+
+
+
+
Details
+
This function is only appropriate for TSP-enabled instruments.
+
This function reads the data from a reading buffer on a remote instrument and returns an array of numbers or a string representing the data. The startIndex and endIndex parameters specify the portion of the reading buffer to read. If no index is specified, the entire buffer is copied.
+
The function will return a table if the table is an array of numbers; otherwise a comma‑delimited string is returned.
+
This command is limited to transferring 50,000 readings at a time.
+
Example
+
+
+
+
t = tspnet.tsp.rbtablecopy(testConnection,
+
"testRemotebuffername.readings", 1, 3)
+
print(t[1], t[2], t[3])
+
+
Copy the specified readings table for buffer items 1 through 3, then display the first three readings. Sample output:
+
4.56534e-01
+
4.52675e-01
+
4.57535e-01
+
+
+
+
+
Also see
+
None
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2651A/14126.html b/WebHelpDocs/Commands_2651A/14126.html
new file mode 100644
index 0000000..ae95441
--- /dev/null
+++ b/WebHelpDocs/Commands_2651A/14126.html
@@ -0,0 +1,86 @@
+
+
+ Status model
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Status model
+
The status model is a set of status registers and queues. You can use the following commands to manipulate and monitor these registers and queues to view and control various instrument events.
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2651A/14129.html b/WebHelpDocs/Commands_2651A/14129.html
new file mode 100644
index 0000000..1860b5e
--- /dev/null
+++ b/WebHelpDocs/Commands_2651A/14129.html
@@ -0,0 +1,92 @@
+
+
+ LAN and LXI
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
LAN and LXI
+
The LAN commands have options that allow you to review and configure network settings.
+
The lan.config.* commands allow you to configure LAN settings over the remote interface. Note that you must send lan.applysettings() for the configuration settings to take effect.
+
The lan.status.* commands help you determine the status of the LAN.
+
The lan.trigger[N].* commands allow you to set up and assert trigger events that are sent over the LAN.
+
Other LAN commands allow you to reset the LAN, restore defaults, check LXI domain information, and enable or disable the Nagle algorithm.
This function overwrites a bit field at a specified index position.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
result = bit.setfield(value, index, width, fieldValue)
+
+
+
+
result
+
+
Result of the bit manipulation
+
+
+
+
value
+
+
Specified number
+
+
+
+
index
+
+
One‑based bit position in value to set (1 to 32)
+
+
+
+
width
+
+
The number of bits to include in the field (1 to 32)
+
+
+
+
fieldValue
+
+
Value to write to the field
+
+
+
+
+
Details
+
This function returns result, which is value with a field of bits overwritten, starting at index. The index specifies the position of the least significant bit of value. The width bits starting at index are set to fieldValue.
+
The least significant bit of value is at index position 1; the most significant bit is at index position 32.
+
Before setting the field of bits, any fractional parts of value and fieldValue are truncated to form integers.
+
If fieldValue is wider than width, the most significant bits of the fieldValue that exceed the width are truncated. For example, if width is 4 bits and the binary value for fieldValue is 11110 (5 bits), the most significant bit of fieldValue is truncated and a binary value of 1110 is used.
+
Example
+
+
+
+
testResult = bit.setfield(15, 2, 3, 5)
+
+
+
print(testResult)
+
+
The binary equivalent of decimal 15 is 1111. After overwriting it with a decimal 5 (binary 101) at index position 2, the returned value is decimal 11 (binary 1011).
The resulting value of true or false based on the success of the function
+
+
+
+
value
+
+
The data item to add; value can be of any type
+
+
+
+
timeout
+
+
The maximum number of seconds to wait for space in the data queue
+
+
+
+
+
Details
+
You cannot use the timeout value when accessing the data queue from a remote node (you can only use the timeout value while adding data to the local data queue).
+
The timeout value is ignored if the data queue is not full.
+
The dataqueue.add() function returns false:
+
If the timeout expires before space is available in the data queue
If the data queue is full and a timeout value is not specified
If the value is a table, a duplicate of the table and any subtables is made. The duplicate table does not contain any references to the original table or to any subtables.
This attribute contains the number of items in the data queue.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Power cycle
+
+
Not saved
+
+
Not applicable
+
+
+
+
+
Usage
+
count= dataqueue.count
+
+
+
+
count
+
+
The number of items in the data queue
+
+
+
+
+
Details
+
The count gets updated as entries are added with dataqueue.add() and read from the data queue with dataqueue.next(). It is also updated when the dataqueue is cleared with dataqueue.clear().
+
A maximum of dataqueue.CAPACITY items can be stored at any one time in the data queue.
+
Example
+
+
+
+
MaxCount = dataqueue.CAPACITY
+
while dataqueue.count < MaxCount do
+
dataqueue.add(1)
+
end
+
print("There are " .. dataqueue.count
+
.. " items in the data queue")
+
dataqueue.clear()
+
print("There are " .. dataqueue.count
+
.. " items in the data queue")
+
+
Add items to the data queue until it is at capacity.
This function removes the next entry from the data queue.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
value = dataqueue.next()
+
value = dataqueue.next(timeout)
+
+
+
+
value
+
+
The next entry in the data queue
+
+
+
+
timeout
+
+
The number of seconds to wait for data in the queue
+
+
+
+
+
Details
+
If the data queue is empty, the function waits up to the timeout value.
+
If data is not available in the data queue before the timeout expires, the return value is nil.
+
The entries in the data queue are removed in first-in, first-out (FIFO) order.
+
If the value is a table, a duplicate of the original table and any subtables is made. The duplicate table does not contain any references to the original table or to any subtables.
+
Example
+
+
+
+
dataqueue.clear()
+
for i = 1, 10 do
+
dataqueue.add(i)
+
end
+
print("There are " .. dataqueue.count
+
.. " items in the data queue")
+
+
while dataqueue.count > 0 do
+
x = dataqueue.next()
+
print(x)
+
end
+
print("There are " .. dataqueue.count
+
.. " items in the data queue")
+
+
Clears the data queue, adds ten entries, then reads the entries from the data queue.
The digital I/O port of the Model 2651A can control external circuitry (such as a component handler for binning operations).
+
The I/O port has 14 lines. Each line can be at TTL logic state 1 (high) or 0 (low). See the pinout diagram in Digital I/O port for additional information.
+
There are commands to read and write to each individual bit, and commands to read and write to the entire port.
The present value of the input lines on the digital I/O port
+
+
+
+
+
Details
+
The binary equivalent of the returned value indicates the value of the input lines on the I/O port. The least significant bit (bit B1) of the binary number corresponds to line 1; bit B14 corresponds to line 14.
+
For example, a returned value of 170 has a binary equivalent of 000000010101010, which indicates that lines 2, 4, 6, and 8 are high (1), and the other 10 lines are low (0).
+
Example
+
+
+
+
data = digio.readport()
+
print(data)
+
+
Assume lines 2, 4, 6, and 8 are set high when the I/O port is read.
This function clears the trigger event on a digital I/O line.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
digio.trigger[N].clear()
+
+
+
+
N
+
+
Digital I/O trigger line (1 to 14)
+
+
+
+
+
Details
+
The event detector of a trigger recalls if a trigger event has been detected since the last digio.trigger[N].wait() command. This function clears the event detector of the specified trigger line, discards the previous history of the trigger line, and clears the digio.trigger[N].overrun attribute.
This constant identifies the trigger event generated by the digital I/O line N.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Constant
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
eventID = digio.trigger[N].EVENT_ID
+
+
+
+
eventID
+
+
The trigger event number
+
+
+
+
N
+
+
Digital I/O trigger line (1 to 14)
+
+
+
+
+
Details
+
To have another trigger object respond to trigger events generated by the trigger line, set the other object's stimulus attribute to the value of this constant.
This attribute sets the mode in which the trigger event detector and the output trigger generator operate on the given trigger line.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset Digital I/O trigger N reset Recall setup
+
+
Not saved
+
+
0 (digio.TRIG_BYPASS)
+
+
+
+
+
Usage
+
triggerMode = digio.trigger[N].mode
+
digio.trigger[N].mode = triggerMode
+
+
+
+
triggerMode
+
+
The trigger mode; see Details for values
+
+
+
+
N
+
+
Digital I/O trigger line (1 to 14)
+
+
+
+
+
Details
+
Set triggerMode to one of the following values:
+
+
+
+
+
+
+
+
+
Trigger mode values
+
+
+
+
triggerMode
+
+
Description
+
+
+
+
digio.TRIG_BYPASS or 0
+
+
Allows direct control of the line.
+
+
+
+
digio.TRIG_FALLING or 1
+
+
Detects falling‑edge triggers as input; asserts a TTL-low pulse for output.
+
+
+
+
digio.TRIG_RISING or 2
+
+
If the programmed state of the line is high, the digio.TRIG_RISING mode behavior is similar to digio.TRIG_RISINGA. If the programmed state of the line is low, the digio.TRIG_RISING mode behavior is similar to digio.TRIG_RISINGM. This setting should only be used if necessary for compatibility with other Keithley Instruments products.
+
+
+
+
digio.TRIG_EITHER or 3
+
+
Detects rising- or falling‑edge triggers as input. Asserts a TTL‑low pulse for output.
+
+
+
+
digio.TRIG_SYNCHRONOUSA or 4
+
+
Detects the falling‑edge input triggers and automatically latches and drives the trigger line low. Asserting the output trigger releases the latched line.
+
+
+
+
digio.TRIG_SYNCHRONOUS or 5
+
+
Detects the falling‑edge input triggers and automatically latches and drives the trigger line low. Asserts a TTL‑low pulse as an output trigger.
+
+
+
+
digio.TRIG_SYNCHRONOUSM or 6
+
+
Detects rising‑edge triggers as input. Asserts a TTL‑low pulse for output.
+
+
+
+
digio.TRIG_RISINGA or 7
+
+
Detects rising‑edge triggers as input. Asserts a TTL‑low pulse for output.
+
+
+
+
digio.TRIG_RISINGM or 8
+
+
Asserts a TTL-high pulse for output. Input edge detection is not possible in this mode.
+
+
+
+
+
When programmed to any mode except digio.TRIG_BYPASS, the output state of the I/O line is controlled by the trigger logic, and the user‑specified output state of the line is ignored.
+
Use of either digio.TRIG_SYNCHRONOUSA or digio.TRIG_SYNCHRONOUSM is preferred over digio.TRIG_SYNCHRONOUS, because digio.TRIG_SYNCHRONOUS is provided for compatibility with the digital I/O and TSP-Link triggering on other Keithley Instruments products.
+
To control the line state, set the mode to digio.TRIG_BYPASS and use the digio.writebit() and digio.writeport() commands.
+
Example
+
+
+
+
digio.trigger[4].mode = 2
+
+
Sets the trigger mode for I/O line 4 to digio.TRIG_RISING.
Use this attribute to read the event detector overrun status.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Instrument reset Digital I/O trigger N clear Digital I/O trigger N reset Recall setup
+
+
Not saved
+
+
Not applicable
+
+
+
+
+
Usage
+
overrun = digio.trigger[N].overrun
+
+
+
+
overrun
+
+
Trigger overrun state (true or false)
+
+
+
+
N
+
+
Digital I/O trigger line (1 to 14)
+
+
+
+
+
Details
+
If this is true, an event was ignored because the event detector was already in the detected state when the event occurred.
+
This is an indication of the state of the event detector built into the line itself. It does not indicate if an overrun occurred in any other part of the trigger model or in any other detector that is monitoring the event.
+
Example
+
+
+
+
overrun = digio.trigger[1].overrun
+
print(overrun)
+
+
If there is no trigger overrun, the following text is output:
This function releases an indefinite length or latched trigger.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
digio.trigger[N].release()
+
+
+
+
N
+
+
Digital I/O trigger line (1 to 14)
+
+
+
+
+
Details
+
Releases a trigger that was asserted with an indefinite pulse width time, as well as a trigger that was latched in response to receiving a synchronous mode trigger. Only the specified trigger line (N) is affected.
The value true if a trigger is detected, or false if no triggers are detected during the timeout period
+
+
+
+
N
+
+
Digital I/O trigger line (1 to 14)
+
+
+
+
timeout
+
+
Timeout in seconds
+
+
+
+
+
Details
+
This function pauses for up to timeout seconds for an input trigger. If one or more trigger events are detected since the last time digio.trigger[N].wait() or digio.trigger[N].clear() was called, this function returns a value immediately. After waiting for a trigger with this function, the event detector is automatically reset and ready to detect the next trigger. This is true regardless of the number of events detected.
+
Example
+
+
+
+
triggered = digio.trigger[4].wait(3)
+
print(triggered)
+
+
Waits up to three seconds for a trigger to be detected on trigger line 4, then outputs the results.
This function sets a digital I/O line high or low.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
digio.writebit(N, data)
+
+
+
+
N
+
+
Digital I/O trigger line (1 to 14)
+
+
+
+
data
+
+
The value to write to the bit:
+
0 (low)
Non‑zero (high)
+
+
+
+
Details
+
If the output line is write‑protected using the digio.writeprotect attribute, the command is ignored.
+
The reset() function does not affect the present state of the digital I/O lines.
+
Use the digio.writebit() and digio.writeport() commands to control the output state of the synchronization line when trigger operation is set to digio.TRIG_BYPASS.
+
The data must be zero (0) to clear the bit. Any value other than zero (0) sets the bit.
The binary representation of data indicates the output pattern to be written to the I/O port. For example, a data value of 170 has a binary equivalent of 00000010101010. Lines 2, 4, 6, and 8 are set high (1), and the other 10 lines are set low (0).
+
Write‑protected lines are not changed.
+
The reset() function does not affect the present states of the digital I/O lines.
+
Use the digio.writebit() and digio.writeport() commands to control the output state of the synchronization line when trigger operation is set to digio.TRIG_BYPASS.
+
Example
+
+
+
+
digio.writeport(255)
+
+
Sets digital I/O Lines 1 through 8 high (binary 00000011111111).
This attribute contains the write‑protect mask that protects bits from changes from the digio.writebit() and digio.writeport() functions.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset Recall setup
+
+
Saved setup
+
+
0
+
+
+
+
+
Usage
+
mask = digio.writeprotect
+
digio.writeprotect = mask
+
+
+
+
mask
+
+
Sets the value that specifies the bit pattern for write‑protect
+
+
+
+
+
Details
+
Bits that are set to one cause the corresponding line to be write‑protected.
+
The binary equivalent of mask indicates the mask to be set for the I/O port. For example, a mask value of 7 has a binary equivalent of 00000000000111. This mask write‑protects Lines 1, 2, and 3.
This function switches to the user screen and then clears the display.
+
The display.clear(), display.setcursor(), and display.settext() functions are overlapped, nonblocking commands. That is, the script does not wait for one of these commands to complete. These nonblocking functions do not immediately update the display. For performance considerations, they update the physical display as soon as processing time becomes available.
This function reads the present position of the cursor on the front panel display.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
row, column, style = display.getcursor()
+
+
+
+
row
+
+
The row where the cursor is: 1 (top row); 2 (bottom row)
+
+
+
+
column
+
+
The column where the cursor is:
+
If the cursor is in the top row: 1 to 20
If the cursor is in the bottom row: 1 to 32
+
+
+
style
+
+
Visibility of the cursor: 0 (invisible cursor); 1 (blinking cursor)
+
+
+
+
+
Details
+
This function switches the display to the user screen (the text set by display.settext()), and then returns values to indicate the cursor's row and column position and cursor style.
+
Columns are numbered from left to right on the display.
+
Example 1
+
+
+
+
testRow, testColumn = display.getcursor()
+
print(testRow, testColumn)
+
+
This example reads the cursor position into local variables and prints them. Example output:
+
1.00000e+00 1.00000e+00
+
+
+
+
+
Example 2
+
+
+
+
print(display.getcursor())
+
+
This example prints the cursor position directly. In this example, the cursor is in row 1 at column 3, with an invisible cursor:
This function reads the text displayed on the instrument front panel.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
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)
+
+
+
+
text
+
+
The returned value, which contains the text that is presently displayed
+
+
+
+
embellished
+
+
Indicates type of returned text: false (simple text); true (text with embedded character codes)
+
+
+
+
row
+
+
Selects the row from which to read the text: 1 (row 1); 2 (row 2). If row is not included, both rows of text are read
+
+
+
+
columnStart
+
+
Selects the first column from which to read text; for row 1, the valid column numbers are 1 to 20; for row 2, the valid column numbers are 1 to 32; if nothing is selected, 1 is used
+
+
+
+
columnEnd
+
+
Selects the last column from which to read text; for row 1, the valid column numbers are 1 to 20; for row 2, the valid column numbers are 1 to 32; the default is 20 for row 1, and 32 for row 2
+
+
+
+
+
Details
+
Using the command without any parameters returns both lines of the display.
+
The $N character code is included in the returned value to show where the top line ends and the bottom line begins. This is not affected by the value of embellished.
+
When embellished is set to true, all other character codes are returned along with the message. When embellished is set to false, only the message and the $N character code is returned. For information on the embedded character codes, see display.settext().
+
The display is not switched to the user screen (the screen set using display.settext()). Text will be read from the active screen.
A string that defines how the input field is formatted; see Details for more information
+
+
+
+
default
+
+
The default value for the input value
+
+
+
+
minimum
+
+
The minimum input value
+
+
+
+
maximum
+
+
The maximum input value
+
+
+
+
+
Details
+
The format parameter uses zeros (0), the decimal point, polarity sign, and exponents to define how the input field is formatted. The format parameter can include the options shown in the following table.
+
+
+
+
Option
+
+
Description
+
+
Examples
+
+
+
+
E
+
+
Include the E to display the value exponentially
+
+
0.00000e+0
+
+
+
+
+
+
+
Allows operators to enter positive or negative values; if the "+" sign is not included, the operator cannot enter a negative value
+
+
+0.00
+
+
+
+
0
+
+
Defines the digit positions for the value; you can use up to six zeros (0)
+
+
+00.0000e+00
+
+
+
+
.
+
+
Include to have a decimal point appear in the value
+
+
+0.00
+
+
+
+
+
The default parameter is the value shown when the value is first displayed.
+
The minimum and maximum parameters can be used to limit the values that can be entered. When + is not selected for format, the minimum limit must be more than or equal to zero (0). When limits are used, you cannot enter values above or below these limits.
+
The input value is limited to ±1e37.
+
Before calling display.inputvalue(), you should send a message prompt to the operator using display.prompt(). Make sure to position the cursor where the edit field should appear.
+
After this command is sent, script execution pauses until you enter a value and press the ENTER key.
+
For positive and negative entry (plus sign (+) used for the value field and/or the exponent field), polarity of a nonzero value or exponent can be toggled by positioning the cursor on the polarity sign and turning the navigation wheel . Polarity will also toggle when using the navigation wheel to decrease or increase the value or exponent past zero. A zero (0) value or exponent (for example, +00) is always positive and cannot be toggled to negative polarity.
+
After executing this command and pressing the EXIT (LOCAL) key, the function returns nil.
+
Example
+
+
+
+
display.clear()
+
display.settext("Enter value between$N -0.10 and 2.00: ")
+
value = display.inputvalue("+0.00", 0.5, -0.1, 2.0)
+
print("Value entered = ", value)
+
+
+
+
+
Displays an editable field (+0.50) for operator input. The valid input range is -0.10 to +2.00, with a default of 0.50.
This function presents a menu on the front panel display.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
selection = display.menu(name, items)
+
+
+
+
selection
+
+
Name of the variable that holds the menu item selected
+
+
+
+
name
+
+
Menu name to display on the top line
+
+
+
+
items
+
+
Menu items to display on the bottom line
+
+
+
+
+
Details
+
The menu consists of the menu name string on the top line, and a selectable list of items on the bottom line. The menu items must be a single string with each item separated by whitespace. The name for the top line is limited to 20 characters.
+
After sending this command, script execution pauses for the operator to select a menu item. An item is selected by rotating the navigation wheel to place the blinking cursor on the item, and then pressing the navigation wheel (or the ENTER key). When an item is selected, the text of that selection is returned.
+
Pressing the EXIT (LOCAL) keywill not abort the script while the menu is displayed, but it will return nil. The script can be aborted by calling the exit function when nil is returned.
The active column position to set; row 1 has columns 1 to 20, row 2 has columns 1 to 32
+
+
+
+
style
+
+
Set the cursor to invisible (0, default) or blinking (1)
+
+
+
+
+
Details
+
Sending this command selects the user screen and then moves the cursor to the given location.
+
The display.clear(), display.setcursor(), and display.settext() functions are overlapped, nonblocking commands. That is, the script does not wait for one of these commands to complete. These nonblocking functions do not immediately update the display. For performance considerations, they update the physical display as soon as processing time becomes available.
+
An out‑of-range parameter for row sets the cursor to row 2. An out‑of‑range parameter for column sets the cursor to column 20 for row 1, or 32 for row 2.
+
An out‑of‑range parameter for style sets it to 0 (invisible).
+
A blinking cursor is only visible when it is positioned over displayed text. It cannot be seen when positioned over a space character.
+
Example
+
+
+
+
display.clear()
+
display.setcursor(1, 8)
+
display.settext("Hello")
+
display.setcursor(2, 14)
+
display.settext("World")
+
+
This example displays a message on the instrument front panel, approximately center. Note that the top line of text is larger than the bottom line of text.
+
The front panel of the instrument displays "Hello" on the top line and "World" on the second line.
Text message to be displayed, with optional character codes
+
+
+
+
+
Details
+
This function selects the user display screen and displays the given text.
+
After the instrument is turned on, the first time you use a display command to write to the display, the message "User Screen" is cleared. After the first write, you need to use display.clear() to clear the message.
+
The display.clear(), display.setcursor(), and display.settext() functions are overlapped, nonblocking commands. That is, the script does not wait for one of these commands to complete. These nonblocking functions do not immediately update the display. For performance considerations, they update the physical display as soon as processing time becomes available.
+
The text starts at the present cursor position. After the text is displayed, the cursor is after the last character in the display message.
+
Top line text does not wrap to the bottom line of the display automatically. Any text that does not fit on the current line is truncated. If the text is truncated, the cursor remains 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:
+
+
+
+
+
+
+
+
Display character codes
+
+
+
+
Character Code
+
+
Description
+
+
+
+
$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 intensity, nonblinking
+
+
+
+
$B
+
+
Sets text to blink
+
+
+
+
$D
+
+
Sets text to dim intensity
+
+
+
+
$F
+
+
Sets the text to background blink
+
+
+
+
$$
+
+
Escape sequence to display a single dollar symbol ($)
This function clears the front‑panel trigger event detector.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
display.trigger.clear()
+
Details
+
The trigger event detector remembers if an event has been detected since the last display.trigger.wait() call. This function clears the trigger’s event detector and discards the previous history of TRIG key presses.
+
This attribute also clears the display.trigger.overrun attribute.
This function waits for the TRIG key on the front panel to be pressed.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
triggered = display.trigger.wait(timeout)
+
+
+
+
triggered
+
+
true: Trigger was detected
+
false: The operation timed out
+
+
+
+
timeout
+
+
Timeout in seconds
+
+
+
+
+
Details
+
If the trigger key was previously pressed and one or more trigger events were detected, this function returns immediately.
+
After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.
+
Use the display.trigger.clear() call to clear the trigger event detector.
+
Example
+
+
+
+
triggered = display.trigger.wait(5)
+
print(triggered)
+
+
Waits up to five seconds for the TRIG key to be pressed. If TRIG is pressed within five seconds, the output is true. If not, the output is false.
This function reads the annunciators (indicators) that are presently turned on.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
annunciators = display.getannunciators()
+
+
+
+
annunciators
+
+
The bitmasked value that shows which indicators are turned on
+
+
+
+
+
Details
+
This function returns a bitmasked value showing which indicators are turned on. The 16‑bit binary equivalent of the returned value is the bitmask. The return value is a sum of set annunciators, based on the weighted value, as shown in the following table.
+
+
+
+
+
+
+
+
+
+
Annunciator (indicator) bitmasked values and equivalent constants
Indicates if a trigger event was ignored because the event detector was already in the detected state when the TRIG button was pressed.
+
Indicates the overrun state of the event detector built into the display.
+
This attribute does not indicate whether an overrun occurred in any other part of the trigger model or in any other detector that is monitoring the event.
+
Example
+
+
+
+
overrun = display.trigger.overrun
+
+
Sets the variable overrun equal to the present state of the event detector built into the display.
A string that defines how the input field is formatted; see Details for more information
+
+
+
+
units
+
+
Set the units text string for the top line (eight characters maximum); this indicates the units (for example, "V" or "A") for the value
+
+
+
+
help
+
+
Text string to display on the bottom line (32 characters maximum)
+
+
+
+
default
+
+
The value that is shown when the value is first displayed
+
+
+
+
minimum
+
+
The minimum input value that can be entered
+
+
+
+
maximum
+
+
The maximum input value that can be entered (must be more than minimum)
+
+
+
+
+
Details
+
This function creates 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 parameter uses zeros (0), the decimal point, polarity sign, and exponents to define how the input field is formatted.
+
The format parameter can include the options shown in the following table.
+
+
+
+
Option
+
+
Description
+
+
Examples
+
+
+
+
E
+
+
Include the E to display the value exponentially. Include a plus sign (+) for positive/negative exponent entry. Do not include the plus sign (+) to prevent negative value entry. 0 defines the digit positions for the exponent.
+
+
+
0.00000E+0
+
+
+
+
+
+
+
Allows operators to enter positive or negative values. If the plus sign (+) is not included, the operator cannot enter a negative value.
+
+
+0.00
+
+
+
+
0
+
+
Defines the digit positions for the value. You can use up to six zeros (0).
+
+
+00.0000E+00
+
+
+
+
.
+
+
The decimal point where needed for the value.
+
+
+0.00
+
+
+
+
+
The minimum and maximum parameters can be used to limit the values that can be entered. When a plus sign (+) is not selected for format, the minimum limit must be greater than or equal to zero (0). When limits are used, the operator cannot enter values above or below these limits.
+
The input value is limited to ±1e37.
+
After sending this command, script execution pauses for the operator to enter a value and press ENTER.
+
For positive and negative entry (plus sign (+) used for the value field and the exponent field), polarity of a nonzero value or exponent can be toggled by positioning the cursor on the polarity sign and turning the navigation wheel . Polarity will also toggle when using the navigation wheel to decrease or increase the value or exponent past zero. A zero value or exponent (for example, +00) is always positive and cannot be toggled to negative polarity.
+
After executing this command and pressing the EXIT (LOCAL) key, the value returns nil.
+
Example
+
+
+
+
value = display.prompt("0.00", "V", "Input 0 to +2V", 0.5, 0, 2)
+
print(value)
+
+
+
+
The above command prompts the operator to enter a voltage value. The valid input range is 0 to +2.00, with a default of 0.50:
This attribute contains the selected display screen.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset Recall setup
+
+
Saved setup
+
+
0 (display.SMUA)
+
+
+
+
+
Usage
+
displayID = display.screen
+
display.screen = displayID
+
+
+
+
displayID
+
+
One of the following values:
+
0 or display.SMUA: Displays source-measure and compliance
3 or display.USER: Displays the user screen
+
+
+
+
Details
+
Setting this attribute selects the display screen for the front panel. This performs the same action as pressing the DISPLAY key on the front panel. The text for the display screen is set by display.settext().
+
Read this attribute to determine which of the available display screens was last selected.
+
Example
+
+
+
+
display.screen = display.SMUA
+
+
Selects the source-measure and compliance limit display for the SMU.
This function returns all entries from the event log as a single string and removes them from the event log.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
logString = eventlog.all()
+
+
+
+
logString
+
+
A listing of all event log entries
+
+
+
+
+
Details
+
This function returns all events in the event log. Logged items are shown from oldest to newest. The response is a string that has the messages delimited with a new line character.
+
This function also clears the event log.
+
If there are no entries in the event log, this function returns the value nil.
+
Example
+
+
+
+
print(eventlog.all())
+
+
+
+
Get and print all entries from the event log and remove the entries from the log.
This function stops a script that is presently running.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
exit()
+
Details
+
Terminates script execution when called from a script that is being executed.
+
This command does not wait for overlapped commands to complete before terminating script execution. If overlapped commands are required to finish, use the waitcomplete() function before calling exit().
You can use the file I/O commands to open and close directories and files, write data, or to read a file on an installed USB flash drive. File I/O commands are organized into two groups:
+
Commands that reside in the fs and io table, for example: io.open(), io.close(), io.input(), and io.output(). Use these commands to manage file system directories; open and close file descriptors; and perform basic I/O operations on a pair of default files (one input and one output).
Commands that reside in the file descriptors (for example: fileVar:seek(), fileVar:write(), and fileVar:read()) operate exclusively on the file with which they are associated.
The root folder of the USB flash drive has the absolute path:
+
"/usb1/"
+
Both slash (/) and backslash (\) are supported as directory separators.
+
For basic information about navigation and directory listing of files on a flash drive, see File system navigation.
+
File descriptor commands for file I/O use a colon (:) to separate the command parts rather than a period (.), like the io commands.
+
File descriptors cannot be passed between nodes in a TSP-Link® system, so the io.open(), fileVar::read(), and fileVar::write commands are not accessible to the TSP-Link system. However, the default input and output files mentioned above allow for the execution of many file I/O operations without any reference to a file descriptor.
The fileVar:write() or io.write() functions buffer data, which may not be written immediately to the USB flash drive. Use this function to flush this data. Using this function removes the need to close a file after writing to it, allowing it to be left open to write more data. Data may be lost if the file is not closed or flushed before a script ends.
+
If there is going to be a time delay before more data is written to a file, and you want to keep the file open, flush the file after you write to it to prevent loss of data.
You can use the print(), printbuffer(), and printnumber() functions to query the instrument and generate response messages. The format attributes control how the data is formatted for the print functions used.
+
The localnode commands determine if generated errors are automatically sent and if prompts are generated.
This attribute sets the precision (number of digits) for all numbers printed with the ASCII format.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
No
+
+
Instrument reset Recall setup
+
+
Not saved
+
+
6
+
+
+
+
+
Usage
+
precision = format.asciiprecision
+
format.asciiprecision = precision
+
+
+
+
precision
+
+
A number representing the number of digits to be printed for numbers printed with the print(), printbuffer(), and printnumber() functions; must be a number between 1 and 16
+
+
+
+
+
Details
+
This attribute specifies the precision (number of digits) for numeric data printed with the print(), printbuffer(), and printnumber() functions. The format.asciiprecision attribute is only used with the ASCII format. The precision value must be a number between 1 and 16.
+
Note that the precision is the number of significant digits printed. There is always one digit to the left of the decimal point; be sure to include this digit when setting the precision.
This attribute sets the binary byte order for data printed using the printnumber() and printbuffer() functions.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset Recall setup
+
+
Not saved
+
+
1 (format.LITTLEENDIAN)
+
+
+
+
+
Usage
+
order= format.byteorder
+
format.byteorder = order
+
+
+
+
order
+
+
Byte order value as follows:
+
Most significant byte first: 0, format.NORMAL, format.NETWORK, or format.BIGENDIAN
Least significant byte first: 1, format.SWAPPED or format.LITTLEENDIAN
+
+
+
+
Details
+
This attribute selects the byte order in which data is written when printing data values with the printnumber() and printbuffer() functions. The byte order attribute is only used with the format.SREAL, format.REAL, format.REAL32, and format.REAL64 data formats.
+
format.NORMAL, format.BIGENDIAN, and format.NETWORK select the same byte order. format.SWAPPED and format.LITTLEENDIAN select the same byte order. Selecting which to use is a matter of preference.
+
Select the format.SWAPPED or format.LITTLEENDIAN byte order when sending data to a computer with a Microsoft Windows operating system.
+
Example
+
+
+
+
x = 1.23
+
format.data = format.REAL32
+
format.byteorder = format.LITTLEENDIAN
+
printnumber(x)
+
format.byteorder = format.BIGENDIAN
+
printnumber(x)
+
+
Output depends on the terminal program you use, but will look something like:
The precision of numeric values can be controlled with the format.asciiprecision attribute. The byte order of format.SREAL, format.REAL, format.REAL32, and format.REAL64 can be selected with the format.byteorder attribute.
+
REAL32 and SREAL select the same single precision format. REAL and REAL64 select the same double precision format. They are alternative identifiers. Selecting which to use is a matter of preference.
+
The IEEE Std 754 binary formats use four bytes each for single‑precision values and eight bytes each for double‑precision values.
+
When data is written with any of the binary formats, the response message starts with “#0” and ends with a new line. When data is written with the ASCII format, elements are separated with a comma and space.
+
Binary formats are not intended to be interpreted by humans.
+
Example
+
+
+
+
format.asciiprecision = 10
+
x = 3.14159265
+
format.data = format.ASCII
+
printnumber(x)
+
format.data = format.REAL64
+
printnumber(x)
+
+
Output a number represented by x in ASCII using a precision of 10, then output the same number in binary using double precision format.
This function creates a directory at the specified path.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
path = fs.mkdir(newPath)
+
+
+
+
path
+
+
The returned path of the new directory
+
+
+
+
newpath
+
+
Location (path) of where to create the new directory
+
+
+
+
+
Details
+
The directory path may be absolute or relative to the current working directory.
+
An error is logged to the error queue if the parent folder of the new directory does not exist, or if a file system entry already exists at the given path.
A new GPIB address takes affect when the command to change it is processed. If there are response messages in the output queue when this command is processed, they must be read at the new address.
+
If command messages are being queued (sent before this command has executed), the new settings may take effect in the middle of a subsequent command message, so care should be exercised when setting this attribute from the GPIB interface.
+
You should allow ample time for the command to be processed before attempting to communicate with the instrument again. After sending this command, make sure to use the new address to communicate with the instrument.
+
The GPIB address is stored in nonvolatile memory. The reset function has no affect on the address.
You must use the io.flush() or io.close() functions to write data to the file system.
+
Data is not automatically written to a file when you use the io.write() function. The io.write() function buffers data; it may not be written to the USB drive immediately. Use the io.flush() function to immediately write buffered data to the drive.
+
This function only flushes the default output file.
+
Using this command removes the need to close a file after writing to it and allows it to be left open to write more data. Data may be lost if the file is not closed or flushed before an application ends. To prevent the loss of data if there is going to be a time delay before more data is written (and when you want to keep the file open and not close it), flush the file after writing to it.
Indicates whether an error was encountered while processing the function
+
+
+
+
path
+
+
The path of the file to open
+
+
+
+
mode
+
+
A string representing the intended access mode ("r" = read, "w" = write, and "a" = append)
+
+
+
+
+
Details
+
The path to the file to open may be absolute or relative to the current working directory. If you successfully open the file, errorMsg is nil and fileVar has the descriptor that can be used to access the file.
+
If an error is encountered, the command returns nil for fileVar and an error string.
This function writes data to the default output file.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
io.write()
+
io.write(data1)
+
io.write(data1, data2)
+
io.write(data1, ..., dataN)
+
+
+
+
data1
+
+
The data to be written
+
+
+
+
data2
+
+
The data to be written
+
+
+
+
dataN
+
+
The data to be written
+
+
+
+
...
+
+
One or more values separated by commas
+
+
+
+
+
Details
+
All data parameters must be either strings or numbers.
+
Data is not immediately written to a file when you use the io.write() function. The io.write() function buffers data; it may not be written to the USB drive immediately. Use the io.flush() function to immediately write buffered data to the drive.
This function re-initializes the LAN interface with new settings.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
lan.applysettings()
+
Details
+
Disconnects all existing LAN connections to the instrument and re-initializes the LAN with the current configuration settings.
+
This function initiates a background operation. LAN configuration could be a lengthy operation. Although the function returns immediately, the LAN initialization will continue to run in the background.
+
Even though the LAN configuration settings may not have changed since the LAN was last connected, new settings may take effect due to the dynamic nature of DHCP or DLLA configuration.
+
Re-initialization takes effect even if the configuration has not changed since the last time the instrument connected to the LAN.
+
Example
+
+
+
+
lan.applysettings()
+
+
Re-initialize the LAN interface with new settings.
+
+
+
+
+
Also see
+
None
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This function resets LAN settings to default values.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
lan.restoredefaults()
+
Details
+
The settings that are restored are shown in the following table.
+
+
+
+
+
+
+
Settings that are restored to default
+
+
+
+
Attribute
+
+
Default setting
+
+
+
+
lan.autoconnect
+
+
lan.ENABLE
+
+
+
+
lan.config.dns.address[N]
+
+
"0.0.0.0"
+
+
+
+
lan.config.dns.domain
+
+
""
+
+
+
+
lan.config.dns.dynamic
+
+
lan.ENABLE
+
+
+
+
lan.config.dns.hostname
+
+
""
+
+
+
+
lan.config.dns.verify
+
+
lan.ENABLE
+
+
+
+
lan.config.duplex
+
+
lan.FULL
+
+
+
+
lan.config.gateway
+
+
"0.0.0.0"
+
+
+
+
lan.config.ipaddress
+
+
"192.168.0.2"
+
+
+
+
lan.config.method
+
+
lan.AUTO
+
+
+
+
lan.config.speed
+
+
100
+
+
+
+
lan.config.subnetmask
+
+
"255.255.255.0"
+
+
+
+
lan.linktimeout
+
+
20 (seconds)
+
+
+
+
lan.lxidomain
+
+
0
+
+
+
+
lan.nagle
+
+
lan.ENABLE
+
+
+
+
lan.timedwait
+
+
20 (seconds)
+
+
+
+
+
The lan.restoredefaults() function does not reset the LAN password. The localnode.password attribute controls the web password, which can be reset separately.
This attribute contains the LAN timed-wait state interval.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
LAN restore defaults
+
+
Nonvolatile memory
+
+
20 (20 s)
+
+
+
+
+
Usage
+
timeout = lan.timedwait
+
lan.timedwait = timeout
+
+
+
+
timeout
+
+
The LAN timed-wait state interval in seconds
+
+
+
+
+
Details
+
This attribute controls the amount of time that resources are allocated to closed TCP connections. When a TCP connection is closed, the connection is put in a timed-wait state and resources remain allocated for the connection until the timed-wait state ends. During the timed-wait interval, the instrument processes delayed packets that arrive after the connection is closed.
+
Use this attribute to tailor the timed-wait state interval for the instrument.
This attribute is an array of DNS (domain name system) server addresses. These addresses take priority for DNS lookups and are consulted before any server addresses that are obtained using DHCP. This allows local DNS servers to be specified that take priority over DHCP‑configured global DNS servers.
+
You can specify up to two addresses. The address specified by 1 is consulted first for DNS lookups.
+
Unused entries will be returned as "0.0.0.0" when read. dnsAddress must be a string specifying the DNS server’s IP address in dotted decimal notation. To disable an entry, set its value to "0.0.0.0" or the empty string "".
+
Although only two address may be manually specified here, the instrument will use up to three DNS server addresses. If two are specified here, only one that is given by a DHCP server is used. If no entries are specified here, up to three addresses that are given by a DHCP server are used. The IP address obtained from the DHCP server takes priority for all DNS lookups.
Dynamic DNS registration domain; use a string of 255 characters or less
+
+
+
+
+
Details
+
This attribute holds the domain to request during dynamic DNS registration. Dynamic DNS registration works with DHCP to register the domain specified in this attribute with the DNS server.
+
The length of the fully qualified host name (combined length of the domain and host name with separator characters) must be less than or equal to 255 characters. Although up to 255 characters are allowed, you must make sure the combined length is also no more than 255 characters.
+
Example
+
+
+
+
print(lan.config.dns.domain)
+
+
Outputs the present dynamic DNS domain. For example, if the domain is "Matrix", the response would be:
The dynamic DNS registration state. It may be one of the following values:
+
1 or lan.ENABLE: Enabled 0 or lan.DISABLE: Disabled
+
+
+
+
+
Details
+
Dynamic DNS registration works with DHCP to register the host name with the DNS server. The host name is specified in the lan.config.dns.hostname attribute.
+
Example
+
+
+
+
print(lan.config.dns.dynamic)
+
+
Outputs the dynamic registration state.
+
+
If dynamic DNS registration is enabled, the response is:
The host name to use for dynamic DNS registration; the host name must:
+
be a string of 255 characters or less
start with a letter
end with a letter or digit
contain only letters, digits, and hyphens
+
+
+
+
Details
+
This attribute holds the host name to request during dynamic DNS registration. Dynamic DNS registration works with DHCP to register the host name specified in this attribute with the DNS server.
+
The format for hostName is "k‑<model number>‑<serial number>", where <model number> and <serial number> are replaced with the actual model number and serial number of the instrument (for example, "k‑2651A‑1234567"). Note that hyphens separate the characters of hostName.
+
The length of the fully qualified host name (combined length of the domain and host name with separator characters) must be less than or equal to 255 characters. Although up to 255 characters can be entered here, care must be taken to be sure the combined length is also no more than 255 characters.
LAN duplex setting can be one of the following values:
+
1 or lan.FULL: Selects full-duplex operation 0 or lan.HALF: Selects half-duplex operation
+
+
+
+
+
Details
+
This attribute does not indicate the actual setting currently in effect. Use the lan.status.duplex attribute to determine the current operating state of the LAN.
This attribute contains the LAN default gateway address.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
LAN restore defaults
+
+
Nonvolatile memory
+
+
"0.0.0.0"
+
+
+
+
+
Usage
+
gatewayAddress = lan.config.gateway
+
lan.config.gateway = gatewayAddress
+
+
+
+
gatewayAddress
+
+
LAN default gateway address; must be a string specifying the default gateway’s IP address in dotted decimal notation
+
+
+
+
+
Details
+
This attribute specifies the default gateway IP address to use when manual or DLLA configuration methods are used to configure the LAN. If DHCP is enabled, this setting is ignored.
+
This attribute does not indicate the actual setting currently in effect. Use the lan.status.gateway attribute to determine the current operating state of the LAN.
+
The IP address must be formatted in four groups of numbers each separated by a decimal.
+
Example
+
+
+
+
print(lan.config.gateway)
+
+
Outputs the default gateway address. For example, you might see the output:
LAN IP address; must be a string specifying the IP address in dotted decimal notation
+
+
+
+
+
Details
+
This attribute specifies the LAN IP address to use when the LAN is configured using the manual configuration method. This setting is ignored when DLLA or DHCP is used.
+
This attribute does not indicate the actual setting currently in effect. Use the lan.status.ipaddress attribute to determine the current operating state of the LAN.
This attribute contains the LAN settings configuration method.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
LAN restore defaults
+
+
Nonvolatile memory
+
+
0 (lan.AUTO)
+
+
+
+
+
Usage
+
method = lan.config.method
+
lan.config.method = method
+
+
+
+
method
+
+
The method for configuring LAN settings; it can be one of the following values:
+
0 or lan.AUTO: Selects automatic sequencing of configuration methods
+
1 or lan.MANUAL: Use only manually specified configuration settings
+
+
+
+
+
Details
+
This attribute controls how the LAN IP address, subnet mask, default gateway address, and DNS server addresses are determined.
+
When method is lan.AUTO, the instrument first attempts to configure the LAN settings using dynamic host configuration protocol (DHCP). If DHCP fails, it tries dynamic link local addressing (DLLA). If DLLA fails, it uses the manually specified settings.
+
When method is lan.MANUAL, only the manually specified settings are used. Neither DHCP nor DLLA are attempted.
This attribute contains the LAN speed used when restarting in manual configuration mode.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
LAN restore defaults
+
+
Nonvolatile memory
+
+
100 (100 Mbps)
+
+
+
+
+
Usage
+
speed = lan.config.speed
+
lan.config.speed = speed
+
+
+
+
speed
+
+
LAN speed setting in Mbps (10 or 100)
+
+
+
+
+
Details
+
This attribute does not indicate the actual setting currently in effect. Use the lan.status.speed attribute to determine the current operating state of the LAN.
+
This attribute stores the speed that will be used if the LAN is restarted for manual configuration operation.
+
The LAN speed is measured in megabits per second (Mbps).
LAN subnet mask value string that specifies the subnet mask in dotted decimal notation
+
+
+
+
+
Details
+
This attribute specifies the LAN subnet mask to use when the manual configuration method is used to configure the LAN. This setting is ignored when DLLA or DHCP is used.
+
This attribute does not indicate the actual setting currently in effect. Use the lan.status.subnetmask attribute to determine the current operating state of the LAN.
This attribute contains the DNS server IP addresses.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Not applicable
+
+
Not applicable
+
+
Not applicable
+
+
+
+
+
Usage
+
dnsAddress = lan.status.dns.address[N]
+
+
+
+
dnsAddress
+
+
DNS server IP address
+
+
+
+
N
+
+
Entry index (1, 2, or 3)
+
+
+
+
+
Details
+
This attribute is an array of DNS server addresses. The system can use up to three addresses.
+
Unused or disabled entries are returned as "0.0.0.0" when read. The dnsAddress returned is a string specifying the IP address of the DNS server in dotted decimal notation.
+
You can only specify two addresses manually. However, the instrument uses up to three DNS server addresses. If two are specified, only the one given by a DHCP server is used. If no entries are specified here, up to three address given by a DHCP server are used.
+
The value of lan.status.dns.address[1] is referenced first for all DNS lookups. The values of lan.status.dns.address[2] and lan.status.dns.address[3] are referenced second and third, respectively.
This attribute contains the present DNS fully qualified host name.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Not applicable
+
+
Not applicable
+
+
Not applicable
+
+
+
+
+
Usage
+
hostName = lan.status.dns.name
+
+
+
+
hostName
+
+
Fully qualified DNS host name that can be used to connect to the instrument
+
+
+
+
+
Details
+
A fully qualified domain name (FQDN), sometimes referred to as an absolute domain name, is a domain name that specifies its exact location in the tree hierarchy of the Domain Name System (DNS).
+
A FQDN is the complete domain name for a specific computer or host on the LAN. The FQDN consists of two parts: the host name and the domain name.
+
If the DNS host name for an instrument is not found, this attribute stores the IP address in dotted decimal notation.
The MAC address is a character string representing the instrument's MAC address in hexadecimal notation. The string includes colons that separate the address octets (see Example).
+
Example
+
+
+
+
print(lan.status.macaddress)
+
+
Outputs the MAC address of the instrument, for example:
+
00:60:1A:00:00:57
+
+
+
+
+
Also see
+
None
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This attribute contains the LAN subnet mask that is presently in use by the LAN interface.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Not applicable
+
+
Not applicable
+
+
Not applicable
+
+
+
+
+
Usage
+
mask = lan.status.subnetmask
+
+
+
+
mask
+
+
A string specifying the subnet mask in dotted decimal notation
+
+
+
+
+
Details
+
Use this attribute to determine the present operating state of the LAN. This attribute will return the present LAN subnet mask value if the LAN is manually configured, or when DLLA or DHCP is used.
+
Example
+
+
+
+
print(lan.status.subnetmask)
+
+
Outputs the subnet mask of the instrument that is presently in use, such as:
This function clears the event detector for a trigger.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
lan.trigger[N].clear()
+
+
+
+
N
+
+
The LAN event number to clear (1 to 8)
+
+
+
+
+
Details
+
A trigger’s event detector remembers if an event has been detected since the last call. This function clears a trigger’s event detector and discards the previous history of the trigger packet.
+
This function clears all overruns associated with this LAN trigger.
This function prepares the event generator for outgoing trigger events.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
lan.trigger[N].connect()
+
+
+
+
N
+
+
The LAN event number (1 to 8)
+
+
+
+
+
Details
+
Prepares the event generator to send event messages. For TCP connections, this opens the TCP connection.
+
The event generator automatically disconnects when either the lan.trigger[N].protocol or lan.trigger[N].ipaddress attributes for this event are changed.
+
Example
+
+
+
+
lan.trigger[1].protocol = lan.MULTICAST
+
lan.trigger[1].connect()
+
lan.trigger[1].assert()
+
+
Set the protocol for LAN trigger 1 to be multicast when sending LAN triggers. Then, after connecting the LAN trigger, send a message on LAN trigger 1 by asserting it.
This attribute stores the LAN event connection state.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Not applicable
+
+
Not applicable
+
+
Not applicable
+
+
+
+
+
Usage
+
connected = lan.trigger[N].connected
+
+
+
+
connected
+
+
The LAN event connection state:
+
true: Connected
false: Not connected
+
+
+
N
+
+
The LAN event number (1 to 8)
+
+
+
+
+
Details
+
This read-only attribute is set to true when the LAN trigger is connected and ready to send trigger events following a successful lan.trigger[N].connect() command; if the LAN trigger is not ready to send trigger events, this value is false.
+
This attribute is also false when either lan.trigger[N].protocol or lan.trigger[N].ipaddress attributes are changed or the remote connection closes the connection.
+
Example
+
+
+
+
lan.trigger[1].protocol = lan.MULTICAST
+
print(lan.trigger[1].connected)
+
+
Outputs true if connected, or false if not connected.
This attribute sets the trigger operation and detection mode.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset LAN trigger N reset Recall setup
+
+
Not saved
+
+
0 (lan.TRIG_EITHER)
+
+
+
+
+
Usage
+
mode = lan.trigger[N].mode
+
lan.trigger[N].mode = mode
+
+
+
+
mode
+
+
A number representing the trigger mode (0 to 7); see the Details section for more information
+
+
+
+
N
+
+
A number representing the LAN event number (1 to 8)
+
+
+
+
+
Details
+
This attribute controls the mode in which the trigger event detector and the output trigger generator operate on the given trigger. These settings are intended to provide behavior similar to the digital I/O triggers.
+
+
+
+
+
+
+
+
+
Lan trigger mode values
+
+
+
+
mode
+
+
Number
+
+
Trigger packets detected as input
+
+
LAN trigger packet generated for output with a…
+
+
+
+
lan.TRIG_EITHER
+
+
0
+
+
Rising or falling edge (positive or negative state)
+
+
negative state
+
+
+
+
lan.TRIG_FALLING
+
+
1
+
+
Falling edge (negative state)
+
+
negative state
+
+
+
+
lan.TRIG_RISING
+
+
2
+
+
Rising edge (positive state)
+
+
positive state
+
+
+
+
lan.TRIG_RISINGA
+
+
3
+
+
Rising edge (positive state)
+
+
positive state
+
+
+
+
lan.TRIG_RISINGM
+
+
4
+
+
Rising edge (positive state)
+
+
positive state
+
+
+
+
lan.TRIG_SYNCHRONOUS
+
+
5
+
+
Falling edge (negative state)
+
+
positive state
+
+
+
+
lan.TRIG_SYNCHRONOUSA
+
+
6
+
+
Falling edge (negative state)
+
+
positive state
+
+
+
+
lan.TRIG_SYNCHRONOUSM
+
+
7
+
+
Rising edge (positive state)
+
+
negative state
+
+
+
+
+
lan.TRIG_RISING and lan.TRIG_RISINGA are the same.
+
lan.TRIG_RISING and lan.TRIG_RISINGM are the same.
+
Use of either lan.TRIG_SYNCHRONOUSA or lan.TRIG_SYNCHRONOUSM over lan.TRIG_SYNCHRONOUS is preferred, as lan.TRIG_SYNCHRONOUS is provided for compatibility with other Keithley Instruments products.
+
Example
+
+
+
+
print(lan.trigger[1].mode)
+
+
Outputs the present LAN trigger mode of LAN event 1.
This attribute contains the event detector's overrun status.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
LAN trigger N clear LAN trigger N reset Instrument reset Recall setup
+
+
Not applicable
+
+
Not applicable
+
+
+
+
+
Usage
+
overrun = lan.trigger[N].overrun
+
+
+
+
overrun
+
+
The trigger overrun state for the specified LAN packet (true or false)
+
+
+
+
N
+
+
A number representing the LAN event number (1 to 8)
+
+
+
+
+
Details
+
This attribute indicates whether an event has been ignored because the event detector was already in the detected state when the event occurred.
+
This is an indication of the state of the event detector built into the synchronization line itself. It does not indicate if an overrun occurred in any other part of the trigger model, or in any other construct that is monitoring the event.
+
It also is not an indication of an output trigger overrun. Output trigger overrun indications are provided in the status model.
+
Example
+
+
+
+
overrun = lan.trigger[5].overrun
+
print(overrun)
+
+
Checks the overrun status of a trigger on LAN5 and outputs the value, such as:
This attribute sets the LAN protocol to use for sending trigger messages.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset LAN trigger N reset Recall setup
+
+
Not saved
+
+
0 (lan.TCP)
+
+
+
+
+
Usage
+
protocol = lan.trigger[N].protocol
+
lan.trigger[N].protocol = protocol
+
+
+
+
protocol
+
+
The protocol to use for the trigger's messages:
+
0 or lan.TCP
1 or lan.UDP
2 or lan.MULTICAST
+
+
+
N
+
+
A number representing the LAN event number (1 to 8)
+
+
+
+
+
Details
+
The LAN trigger listens for trigger messages from all supported protocols, protocol but uses the designated protocol for sending outgoing messages. After changing this setting, lan.trigger[N].connect() must be called before outgoing event messages can be sent.
+
When the lan.MULTICAST protocol is selected, the lan.trigger[N].ipaddress attribute is ignored and event messages are sent to the multicast address 224.0.23.159.
+
Example
+
+
+
+
print(lan.trigger[1].protocol)
+
+
Get LAN protocol to use for sending trigger messages for LAN event 1.
Maximum amount of time in seconds to wait for the trigger event
+
+
+
+
+
Details
+
If one or more trigger events have been detected since the last time lan.trigger[N].wait() or lan.trigger[N].clear() was called, this function returns immediately.
+
After waiting for a LAN trigger event with this function, the event detector is automatically reset and rearmed regardless of the number of events detected.
+
Example
+
+
+
+
triggered = lan.trigger[5].wait(3)
+
+
Wait for a trigger with LAN packet 5 with a timeout of 3 seconds.
This attribute enables or disables automatic power line frequency detection at start‑up.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Not applicable
+
+
Nonvolatile memory
+
+
true (enabled)
+
+
+
+
+
Usage
+
flag = localnode.autolinefreq
+
localnode.autolinefreq = flag
+
+
+
+
flag
+
+
The auto line frequency detection setting: true or false
+
+
+
+
+
Details
+
Set flag to one of the following values:
+
true: Enable automatic line frequency detection at start-up.
+
false: Disable automatic line frequency detection at start-up.
+
When this attribute is set to true, the power line frequency is detected automatically the next time the Model 2651A powers up. After the power line frequency is automatically detected at power-up, the localnode.linefreq attribute will be set automatically to 50 or 60.
+
If the localnode.linefreq attribute is explicitly set, localnode.autolinefreq will be automatically set to false.
+
When using this command from a remote node, localnode should be replaced with the node reference, for example node[5].autolinefreq.
This attribute stores a user-defined description of the instrument.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Not applicable
+
+
Nonvolatile memory
+
+
Instrument specific (see Details)
+
+
+
+
+
Usage
+
localnode.description = description
+
description = localnode.description
+
+
+
+
description
+
+
User-defined description of the instrument
+
+
+
+
+
Details
+
This attribute stores a string that contains a description of the instrument. This value appears on instrument's LXI home page.
+
This attribute's default value contains Keithley ModelNumber #SSSSSSSS, where: ModelNumber is the instrument's model number, and #SSSSSSSS is the instrument's eight-digit serial number. You can change it to a value that makes sense for your system.
+
When using this command from a remote node, localnode should be replaced with the node reference, for example node[5].description.
+
Example
+
+
+
+
description = "System in Lab 05"
+
localnode.description = description
+
+
Set description equal to "System in Lab 05".
+
Set the LXI home page of this instrument to display "System in Lab 05".
+
+
+
+
+
Also see
+
None
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This function starts test scripts from a remote node.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes (see Details)
+
+
+
+
+
+
+
+
+
+
+
Usage
+
node[N].execute(scriptCode)
+
+
+
+
N
+
+
The node number of this instrument
+
+
+
+
scriptCode
+
+
A string containing the source code
+
+
+
+
+
Details
+
Only the remote master node can use the execute command to run a script on this node. This function does not run test scripts on the master node, only on this node when initiated by the master node.
+
This function may only be called when the group number of the node is different than the node of the master.
+
This function will not wait for the script to finish execution.
+
This function cannot be used from the local node. This command should only be used from a remote master when controlling this instrument over a TSP-link®.
+
Example 1
+
+
+
+
node[2].execute(sourcecode)
+
+
Runs script code on node 2. The code is in a string variable called sourcecode.
+
+
+
+
+
Example 2
+
+
+
+
node[3].execute("x = 5")
+
+
Runs script code in string constant ("x = 5") to set x
+
equal to 5 on node 3.
+
+
+
+
+
Example 3
+
+
+
+
node[32].execute(TestDut.source)
+
+
Runs the test script stored in the variable TestDut
+
(previously stored on the master node) on node 32.
This function returns the value of a global variable.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes (see Details)
+
+
+
+
+
+
+
+
+
+
+
Usage
+
value = node[N].getglobal(name)
+
+
+
+
value
+
+
The value of the variable
+
+
+
+
N
+
+
The node number of this instrument
+
+
+
+
name
+
+
The global variable name
+
+
+
+
+
Details
+
Use this function to have the remote master node retrieve the value of a global variable from this node's run-time environment.
+
Do not use this command to retrieve the value of a global variable from the local node (access the global variable directly). This command should only be used from a remote master when controlling this instrument over a TSP-link®.
+
Example
+
+
+
+
print(node[5].getglobal("test_val"))
+
+
Retrieves and outputs the value of the global variable named test_val from node 5.
This attribute contains the power line frequency setting used for NPLC calculations.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Not applicable
+
+
Nonvolatile memory
+
+
60 (60 Hz)
+
+
+
+
+
Usage
+
frequency = localnode.linefreq
+
localnode.linefreq = frequency
+
+
+
+
frequency
+
+
An integer representing the instrument's detected or specified line frequency
+
+
+
+
+
Details
+
To achieve optimum noise rejection when performing measurements at integer NPLC apertures, set the line frequency attribute to match the frequency (50 Hz or 60 Hz) of the AC power line.
+
When using this command from a remote node, localnode should be replaced with the node reference, for example node[5].linefreq.
+
When this attribute is set, the localnode.autolinefreq attribute is automatically set to false. You can have the instrument automatically detect the AC power line frequency and set this attribute with the line frequency detected when the instrument power is turned on by setting the localnode.autolinefreq attribute to true.
This write-only attribute stores the password that is set for any remote interface. When password usage is enabled (localnode.passwordmode), you must supply this password to change the configuration or to control an instrument from a web page or other remote command interface.
+
The instrument continues to use the old password for all interactions until the command to change it executes. When changing the password, give the instrument time to execute the command before attempting to use the new password.
+
You cannot retrieve a lost password from any command interface.
+
The password can be reset by resetting the LAN from the front panel or by using the lan.reset() command.
+
When using this command from a remote node, localnode should be replaced with the node reference, for example node[5].password.
+
Example
+
+
+
+
localnode.password = "N3wpa55w0rd"
+
+
Changes the remote interface password to N3wpa55w0rd.
This attribute sets and reads the local node prompting state (enabled or disabled).
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Power cycle
+
+
Not saved
+
+
0 (disabled)
+
+
+
+
+
Usage
+
prompting = localnode.prompts
+
localnode.prompts = prompting
+
+
+
+
prompting
+
+
Prompting state (0 to disable or 1 to enable)
+
+
+
+
+
Details
+
The command messages do not generate prompts. The instrument generates prompts in response to command messages.
+
When the prompting mode is enabled (set to 1), the instrument generates prompts in response to command messages. There are three prompts that might be generated:
+
TSP> is the standard prompt. This prompt indicates that everything is normal and the command is done processing.
TSP? is issued if there are entries in the error queue when the prompt is issued. Like the TSP> prompt, it indicates the command is done processing. It does not mean the previous command generated an error, only that there are still errors in the queue when the command was done processing.
>>>> is the continuation prompt. This prompt is used when downloading scripts. When downloading scripts, many command messages must be sent as a group. The continuation prompt indicates that the instrument is expecting more messages as part of the current command.
When using this command from a remote node, localnode should be replaced with the node reference, for example, node[5].prompts.
+
Do not disable prompting when using Test Script Builder. Test Script Builder requires prompts and sets the prompting mode behind the scenes. If you disable prompting, using Test Script Builder causes the instrument to stop responding because it is waiting for the prompt that lets it know that the command is done executing.
This attribute enables and disables the generation of prompts for IEEE Std 488.2 common commands.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Power cycle
+
+
Not saved
+
+
1 (enabled)
+
+
+
+
+
Usage
+
prompting = localnode.prompts4882
+
localnode.prompts4882 = prompting
+
+
+
+
prompting
+
+
IEEE Std 488.2 prompting mode
+
+
+
+
+
Details
+
When set to 1, the IEEE Std 488.2 common commands generate prompts if prompting is enabled with the localnode.prompts attribute. If set to 1, limit the number of *trg commands sent to a running script to 50 regardless of the setting of the localnode.prompts attribute.
+
When set to 0, IEEE Std 488.2 common commands will not generate prompts. When using the *trg command with a script that executes trigger.wait() repeatedly, set localnode.prompts4882 to 0 to avoid problems associated with the command interface input queue filling.
+
This attribute resets to the default value each time the instrument power is cycled.
+
When using this command from a remote node, localnode should be replaced with the node reference, for example node[5].prompts4882.
This function sets the value of a global variable.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes (see Details)
+
+
+
+
+
+
+
+
+
+
+
Usage
+
node[N].setglobal(name, value)
+
+
+
+
N
+
+
The node number of this instrument
+
+
+
+
name
+
+
The global variable name to set
+
+
+
+
value
+
+
The value to assign to the variable
+
+
+
+
+
Details
+
From a remote node, use this function to assign the given value to a global variable.
+
Do not use this command to create or set the value of a global variable from the local node (set the global variable directly instead). This command should only be used from a remote master when controlling this instrument over a TSP-link®.
+
Example
+
+
+
+
node[3].setglobal("x", 5)
+
+
Sets the global variable x on node 3 to the value of 5.
String representing daylight savings offset from UTC
+
+
+
+
dstStart
+
+
String representing when daylight savings time starts
+
+
+
+
dstEnd
+
+
String representing when daylight savings time ends
+
+
+
+
+
Details
+
The time zone is only used when converting between local time and UTC time when using the os.time() and os.date() functions.
+
If only one parameter is given, the same time offset is used throughout the year. If four parameters are given, time is adjusted twice during the year for daylight savings time.
+
offset and dstOffset are strings of the form "[+|-]hh[:mm[:ss]]" that indicate how much time must be added to the local time to get UTC time: hh is a number between 0 and 23 that represents hours; mm is a number between 0 and 59 that represents minutes; ss is a number between 0 and 59 that represents seconds. The minutes and seconds fields are optional.
+
The UTC-5 time zone would be specified with the string "5" because UTC-5 is 5 hours behind UTC and one must add 5 hours to the local time to get UTC time. The time zone UTC4 would be specified as "-4" because UTC4 is 4 hours ahead of UTC and 4 hours must be subtracted from the local time to get UTC.
+
dstStart and dstEnd are strings of the form "MM.w.dw/hh[:mm[:ss]]" that indicate when daylight savings time begins and ends respectively: MM is a number between 1 and 12 that represents the month; w is a number between 1 and 5 that represents the week within the month; dw is a number between 0 and 6 that represents the day of the week (where 0 is Sunday). The rest of the fields represent the time of day that the change takes effect: hh represents hours; mm represents minutes; ss represents seconds. The minutes and seconds fields are optional. The week of the month and day of the week fields are not specific dates.
+
Example
+
+
+
+
settimezone("8", "1", "3.3.0/02", "11.2.0/02")
+
settimezone(offset)
+
+
Sets offset to equal +8 hours, +1 hour for DST, starts on Mar 14 at 2:00 a.m, ends on Nov 7 at 2:00 a.m.
This attribute sets whether or not the instrument automatically sends generated errors.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Power cycle
+
+
Not saved
+
+
0 (disabled)
+
+
+
+
+
Usage
+
errorMode = localnode.showerrors
+
localnode.showerrors = errorMode
+
+
+
+
errorMode
+
+
Enables (1) or disables (0) the show errors state
+
+
+
+
+
Details
+
If this attribute is set to 1, the instrument automatically sends any generated errors stored in the error queue, and then clears the queue. Errors are processed after executing a command message (just before issuing a prompt, if prompts are enabled).
+
If this attribute is set to 0, errors are left in the error queue and must be explicitly read or cleared.
+
When using this command from a remote node, localnode should be replaced with the node reference, for example, node[5].showerrors.
This function creates a function to get the value of an attribute.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
getter = makegetter(table, attributeName)
+
+
+
+
getter
+
+
The return value
+
+
+
+
table
+
+
Read‑only table where the attribute is located
+
+
+
+
attributeName
+
+
A string representing the name of the attribute
+
+
+
+
+
Details
+
This function is useful for aliasing attributes to improve execution speed. Calling the function created with makegetter() executes faster than accessing the attribute directly.
+
Creating a getter function is only useful if it is going to be called several times. Otherwise, the overhead of creating the getter function outweighs the overhead of accessing the attribute directly.
+
Example
+
+
+
+
getlevel = makegetter(smua.source, "levelv")
+
v = getlevel()
+
+
Creates a getter function called getlevel.
+
When getlevel() is called, it returns the value of smua.source.levelv.
This function creates a function that, when called, sets the value of an attribute.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
setter = makesetter(table, attributeName)
+
+
+
+
setter
+
+
Function that sets the value of the attribute
+
+
+
+
table
+
+
Read-only table where the attribute is located
+
+
+
+
attributeName
+
+
The string name of the attribute
+
+
+
+
+
Details
+
This function is useful for aliasing attributes to improve execution speed. Calling the setter function will execute faster than accessing the attribute directly.
+
Creating a setter function is only useful if it is going to be called several times. If you are not calling the setter function several times, it is more efficient to access the attribute directly.
+
Example
+
+
+
+
setlevel = makesetter(smua.source, "levelv")
+
for v = 1, 10 do
+
setlevel(v)
+
end
+
+
Creates a setter function called setlevel.
+
+
Using setlevel() in the loop sets the value of smua.source.levelv,
This function sets the operation complete status bit when all overlapped commands are completed.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
opc()
+
Details
+
This function causes the operation complete bit in the Standard Event Status Register to be set when all previously started local overlapped commands are complete.
+
Note that each node independently sets its operation complete bits in its own status model. Any nodes not actively performing overlapped commands will set their bits immediately. All remaining nodes will set their own bits as they complete their own overlapped commands.
The last table or reading buffer subtable to print
+
+
+
+
...
+
+
One or more tables or reading buffer subtables separated with commas
+
+
+
+
+
Details
+
The correct usage of this function for a buffer containing n elements is:
+
1 = startIndex = endIndex = n
+
Where n refers to the index of the last entry in the tables to be printed.
+
If endIndex< startIndex or n<startIndex, no data is printed. If startIndex = 1, 1 is used as startIndex. Ifn< endIndex,nis used as endIndex.
+
When any given reading buffers are used in overlapped commands that have not yet completed (at least to the desired index), this function outputs data as it becomes available.
+
When there are outstanding overlapped commands to acquire data, n refers to the index that the last entry in the table will have after all the measurements have completed.
+
If you pass a reading buffer instead of a reading buffer subtable, the default subtable for that reading buffer will be used.
+
This command generates a single response message that contains all data. The response message is stored in the output queue.
+
The format.data attribute controls the format of the response message.
+
Example
+
+
+
+
format.data = format.ASCII
+
format.asciiprecision = 6
+
printbuffer(1, rb1.n, rb1)
+
+
+
+
This assumes that rb1 is a valid reading buffer in the run-time environment. The use of rb1.n (bufferVar.n) indicates that the instrument should output all readings in the reading buffer. In this example, rb1.n equals 10.
Scripting helps you combine commands into a block of code that the instrument can run. Scripts help you communicate with the instrument efficiently. These commands describe how to create, load, modify, run, and exit scripts.
This function creates a script from a specified file.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
scriptVar = script.load(file)
+
scriptVar = script.load(file, name)
+
+
+
+
scriptVar
+
+
The created script. This is nil if an error is encountered
+
+
+
+
file
+
+
The path and file name of the script file to load
+
+
+
+
name
+
+
The name of the script to be created
+
+
+
+
+
Details
+
The file path may be absolute or relative to the current working directory. The root folder of the USB flash drive has the absolute path "/usb1/". Both the forward slash (/) and backslash (\) are supported as directory separators.
+
The file to be loaded must start with the loadscript or loadandrunscript keywords, contain the body of the script, and end with the endscript keyword.
+
Script naming:
+
If the name parameter is an empty string, or name is absent (or nil) and the script name cannot be extracted from the file, scriptVar is the only handle to the created script.
If name is given (and not nil), any script name embedded in the file is ignored.
If name conflicts with the name of an existing script in the script.user.scripts table, the existing script’s name attribute is set to an empty string before it is replaced in the script.user.scripts table by the new script.
If name is absent or nil, the command attempts to extract the name of the script from the file. Any conflict between the extracted name and that of an existing script in the scripts table generates an error. If the script name cannot be extracted, the created script's name attribute is initialized to the empty string, and must be set to a valid nonempty string before saving the script to nonvolatile memory.
The name of the variable that will reference the script
+
+
+
+
code
+
+
A string containing the body of the script
+
+
+
+
name
+
+
The name of the script
+
+
+
+
+
Details
+
The name parameter is the name that is added to the script.user.scripts table. If name is not given, an empty string will be used, and the script will be unnamed. If the name already exists in script.user.scripts, the existing script's name attribute is set to an empty string before it is replaced by the new script.
+
Note that name is the value that is used for the instrument front panel display. If this value is not defined, the script will not be available from the instrument front panel.
+
You must save the new script into nonvolatile memory to keep it when the instrument is turned off.
+
Example 1
+
+
+
+
myTest8 = script.new(
+
"display.clear() display.settext('Hello from myTest8')", "myTest8")
+
myTest8()
+
+
+
+
Creates a new script referenced by the variable myTest8 with the name "myTest8".
+
Runs the script. The instrument displays "Hello from myTest8".
+
+
+
+
+
Example 2
+
+
+
+
autoexec = script.new(
+
"display.clear() display.settext('Hello from autoexec')", 'autoexec')
+
+
+
+
Creates a new autoexec script that clears the display when the instrument is turned on and displays "Hello from autoexec".
This attribute configures the baud rate for the RS-232 port.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Not applicable
+
+
Nonvolatile memory
+
+
9600
+
+
+
+
+
Usage
+
baud = serial.baud
+
serial.baud = baud
+
+
+
+
baud
+
+
The baud rate (300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600 or 115200)
+
+
+
+
+
Details
+
A new baud rate setting takes effect when the command to change it is processed.
+
Allow ample time for the command to be processed before attempting to communicate with the instrument again. If possible, set the baud rate from one of the other command interfaces or from the front panel.
This attribute configures character width (data bits) for the RS-232 port.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Not applicable
+
+
Nonvolatile memory
+
+
8
+
+
+
+
+
Usage
+
bits = serial.databits
+
serial.databits = bits
+
+
+
+
bits
+
+
An integer representing the character width (7 or 8)
+
+
+
+
+
Details
+
A new data width setting takes effect when the command to change it is processed.
+
Allow ample time for the command to be processed before attempting to communicate with the instrument again. If possible, set the character width from one of the other command interfaces or from the front panel.
This attribute configures flow control for the RS-232 port.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Not applicable
+
+
Nonvolatile memory
+
+
"none" (serial.FLOW_NONE)
+
+
+
+
+
Usage
+
flow = serial.flowcontrol
+
serial.flowcontrol = flow
+
+
+
+
flow
+
+
A string representing flow control configuration; set to:
+
"none" or serial.FLOW_NONE (selects no flow control)
"hardware" or serial.FLOW_HARDWARE (selects hardware flow control)
+
+
+
+
Details
+
A new flow control setting takes effect when the command to change it is processed.
+
Allow ample time for the command to be processed before attempting to communicate with the instrument again. If possible, set the flow control from one of the other command interfaces or from the front panel.
This attribute configures parity for the RS-232 port.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Not applicable
+
+
Nonvolatile memory
+
+
"none" (serial.PARITY_NONE)
+
+
+
+
+
Usage
+
parity = serial.parity
+
serial.parity = parity
+
+
+
+
parity
+
+
Set parity to one of the following values:
+
Select no parity ("none" or serial.PARITY_NONE)
Select even parity ("even" or serial.PARITY_EVEN)
Select odd parity ("odd" or serial.PARITY_ODD)
+
+
+
+
Details
+
A new parity setting takes effect when the command to change it is processed.
+
Allow ample time for the command to be processed before attempting to communicate with the instrument again. If possible, set parity from one of the other command interfaces or from the front panel.
This function reads available characters (data) from the serial port.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
data = serial.read(maxchars)
+
+
+
+
maxchars
+
+
An integer that specifies the maximum number of characters to read
+
+
+
+
data
+
+
A string consisting of all data read from the serial port
+
+
+
+
+
Details
+
This function will read available characters from the serial port. It will not wait for new characters to arrive. As long as maxchars is less than 200 characters, all characters received by the serial port (before the serial.read() command is executed) are returned. If too many characters are received between calls to this function, the RS-232 buffers will overflow and some characters may be lost.
+
Call this function as many times as necessary to receive the required number of characters. For optimal performance, use a small delay between repeated calls to this function.
+
The data returned is the raw data stream read from the port. No characters, such as control characters or terminator characters, are interpreted nor will the data stream be altered.
+
This function cannot be used if the serial port is enabled as a command interface; a settings conflict error will be generated.
+
Example
+
+
+
+
data = serial.read(200)
+
+
print(data)
+
+
Read data from the serial port.
+
+
Output:
+
John Doe
+
The above output indicates that the string "John Doe" was read from the serial port.
This attribute specifies which saved setup to recall when the instrument is turned on.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Not applicable
+
+
Nonvolatile memory
+
+
0
+
+
+
+
+
Usage
+
N = setup.poweron
+
setup.poweron = N
+
+
+
+
N
+
+
An integer that specifies the setup to recall when the instrument power is turned on (0 to 5)
+
+
+
+
+
Details
+
When N = 0, the instrument uses the factory default setup when it is turned on. When N is set to 1 to 5, it uses the setup saved with setup.save().
+
Only setups stored in nonvolatile memory are available (you cannot recall a script from a USB flash drive with this command) . To save a script to be used when the instrument is powered on, you can create a configuration script and name it autoexec.
+
Example
+
+
+
+
setup.poweron = 0
+
+
Set the instrument to use the factory default setup when power is turned on.
This function recalls settings from a saved setup.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
setup.recall(id)
+
+
+
+
id
+
+
An integer or string specifying the location of the setup to recall:
+
Factory default setup (0)
User-saved setup in nonvolatile memory (1 to 5 )
User-saved setup on a USB flash drive ("/path/filename")
+
+
+
+
Details
+
When the id parameter is an integer (n), it is interpreted as the setup number to restore from the instrument's nonvolatile memory. When n = 0, the instrument recalls the factory default setup; when n = 1 to 5, the instrument recalls a user-saved setup from nonvolatile memory.
+
When the id parameter is a string, it is interpreted as the path and file name of the setup to restore from a file on a USB flash drive. The path may be absolute or relative to the current working directory.
+
Before a setup is recalled, an instrument reset is performed.
+
Example 1
+
+
+
+
setup.recall(1)
+
+
Recall the user-saved setup at location 1 .
+
+
+
+
+
Example 2
+
+
+
+
setup.recall("/usb1/KEITHLEY_30730.set")
+
+
Recall a user-saved setup stored in a file named KEITHLEY_30730 on a USB flash drive.
This function saves the present setup as a user-saved setup.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
setup.save(id)
+
+
+
+
id
+
+
An integer or string specifying where to save the user setup:
+
Save in nonvolatile memory (1 to 5)
Save as user-saved setup on a USB flash drive ("/path/filename")
+
+
+
+
When the id parameter is an integer (n), it is interpreted as the setup number to save to the instrument's nonvolatile memory.
+
When you save to a specified integer (1 to 5) in nonvolatile memory, the previous setup at that same location is overwritten.
+
When the id parameter is a string, it is interpreted as the path and file name of the location to save the present setup on a USB flash drive. The path may be absolute or relative to the current working directory.
+
+
Example
+
+
+
+
setup.save(5)
+
+
Saves the present setup to the internal memory of the instrument at location 5.
This function disables commands that change calibration settings.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
smuX.cal.lock()
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.cal.lock() specifies SMU channel A)
+
+
+
+
+
Details
+
This function disables calibration functions that can change calibration settings. The calibration constants must be written to nonvolatile memory, or a previous calibration set must be restored prior to locking calibration. Error code 5012, "Cal data not saved - save or restore before lock," will result if this function is called when the calibration state is smuX.CALSTATE_CALIBRATING.
This function loads a stored set of calibration constants.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
smuX.cal.restore()
+
smuX.cal.restore(calset)
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.cal.restore() applies to SMU channel A)
+
+
+
+
calset
+
+
The calibration set to be loaded. Set calset to one of the following values:
+
0 or smuX.CALSET_NOMINAL: A set of calibration constants that are uncalibrated, but set to nominal values to allow rudimentary functioning of the instrument
+
1 or smuX.CALSET_FACTORY: The calibration constants when the instrument left the factory
+
2 or smuX.CALSET_DEFAULT: The normal calibration set
+
3 or smuX.CALSET_PREVIOUS: The calibration set that was used before the last default set was overwritten
+
+
+
+
+
Details
+
This function will overwrite the current set of calibration constants with constants read from nonvolatile memory.
+
This function will be disabled until a successful call to smuX.cal.unlock() is made.
+
If calset is not specified, smuX.CALSET_DEFAULT will be used.
+
Example
+
+
+
+
smua.cal.restore()
+
+
Restores factory calibration constants for SMU channel A.
This function stores the active calibration constants to nonvolatile memory.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
smuX.cal.save()
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.cal.save() applies to SMU channel A)
+
+
+
+
+
Details
+
This function will store the active set of calibration constants to nonvolatile memory. The previous calibration constants (from the default calibration set) will be copied to the previous calibration set (smuX.CALSET_PREVIOUS) prior to overwriting the default calibration set.
+
This function will be disabled until a successful call to smuX.cal.unlock() is made. If any of the calibration constants have been changed, this function will be disabled unless the calibration date, the calibration due date, and the calibration adjust date have been assigned new values.
+
Example
+
+
+
+
smua.cal.save()
+
+
Stores calibration constants for SMU channel A in nonvolatile memory.
This attribute stores the date of the last calibration adjustment.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU cal. restore
+
+
SMU nonvolatile memory
+
+
Initially set to factory calibration date
+
+
+
+
+
Usage
+
adjustDate = smuX.cal.adjustdate
+
smuX.cal.adjustdate = adjustDate
+
+
+
+
adjustDate
+
+
Date of the last calibration adjustment
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.cal.adjustdate applies to SMU channel A)
+
+
+
+
+
Details
+
This attribute stores the adjustment date associated with the active calibration set. The adjustment date can be read at any time, but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function.
+
You cannot change the adjust date without first making a change to the calibration constants.
+
Once you change any calibration constants, you must set the adjustment date before being allowed to save the calibration data to the SMU's nonvolatile memory.
+
This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute will reflect the date stored with that set.
+
smuX.cal.adjustdate must be set to the date the adjustment was done using the UTC time and date. The date is stored as the number of seconds since UTC, 12:00 am Jan 1, 1970.
+
Due to the internal storage format, smuX.cal.adjustdate is only accurate to within a few minutes of the value set.
+
Example
+
+
+
+
smua.cal.adjustdate = os.time()
+
+
Sets the adjustment date for SMU channel A to the current time set on the instrument.
This attribute stores the calibration date of the active calibration set.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU cal. restore
+
+
SMU nonvolatile memory
+
+
Initially set to factory calibration date
+
+
+
+
+
Usage
+
calDate = smuX.cal.date
+
smuX.cal.date = calDate
+
+
+
+
calDate
+
+
The active calibration set's calibration date
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.cal.date applies to SMU channel A)
+
+
+
+
+
Details
+
This attribute stores the calibration date associated with the active calibration set. The calibration date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function.
+
This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute will reflect the date stored with that set.
+
smuX.cal.date must be set to the date the calibration was done using the UTC time and date. The date is stored as the number of seconds since UTC 12:00 am Jan 1, 1970.
+
Due to the internal storage format, smuX.cal.date is accurate to within a few minutes of the value set.
+
Example
+
+
+
+
smua.cal.date = os.time()
+
+
Sets calibration date for SMU channel A to the current time set on the instrument.
This attribute stores the calibration due date for the next calibration.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU cal. restore
+
+
SMU nonvolatile memory
+
+
0
+
+
+
+
+
Usage
+
calDue = smuX.cal.due
+
smuX.cal.due = calDue
+
+
+
+
calDue
+
+
Due date of next calibration
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.cal.due applies to SMU channel A)
+
+
+
+
+
Details
+
This attribute stores the calibration due date associated with the active calibration set. The calibration due date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function.
+
This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute will reflect the due date stored with that set.
+
smuX.cal.due must be set to the date the next calibration is required using the UTC time and date. The date is stored as the number of seconds since UTC 12:00 am Jan 1, 1970.
+
Due to the internal storage format, smuX.cal.due is only accurate to within a few minutes of the value set.
+
Example
+
+
+
+
smua.cal.due = os.time() + 365 * 24 * 60 * 60
+
+
Sets the SMU channel A calibration due date equal to one year from the current time set on the instrument.
The polarity to use for measurements. Set to one of the following values:
+
0 or smuX.CAL_AUTO: Automatic polarity detection
+
1 or smuX.CAL_POSITIVE: Measure with positive polarity calibration constants
+
2 or smuX.CAL_NEGATIVE: Measure with negative polarity calibration constants
+
+
+
+
X
+
+
SMU channel (for example, smua.cal.polarity applies to SMU channel A)
+
+
+
+
+
Details
+
This attribute controls which polarity calibration constants are used to make all subsequent measurements. This attribute does not affect the smuX.measure.calibrateY() or smuX.source.calibrateY() commands. The polarity for those commands are dictated by the range parameter given to the command. The measurement calibration commands require the measurements provided to have been made using the polarity being calibrated.
+
When making those measurements with calibration points far away from zero, the desired polarity constants are inherently used. When measuring near zero, it is possible for the measurement to be made using the calibration constants from either polarity without knowing which was used. Setting this attribute to positive or negative forces measurements to be made using the calibration constants for a given polarity rather than basing the choice on the raw measurement data.
+
This attribute can only be set to positive or negative when calibration is unlocked. This attribute will automatically be set to smuX.CAL_AUTO when calibration is locked.
+
Example
+
+
+
+
smua.cal.polarity = smua.CAL_POSITIVE
+
+
Selects positive calibration constants for all subsequent measurements on SMU channel A.
Source‑measure unit (SMU) channel (for example, smua.contact.calibratehi() applies to SMU channel A)
+
+
+
+
cp1Measured
+
+
The value measured by this SMU for calibration point 1
+
+
+
+
cp1Reference
+
+
The reference measurement for calibration point 1 as measured externally
+
+
+
+
cp2Measured
+
+
The value measured by this SMU for calibration point 2
+
+
+
+
cp2Reference
+
+
The reference measurement for calibration point 2 as measured externally
+
+
+
+
+
Details
+
Contact check measurement calibration does not require range information.
+
Typically, calibration points one and two will be near 0 W and 50 W, respectively.
+
All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the active calibration set. If not, corruption of the calibration constants may result.
+
The new calibration constants will be activated immediately but are not written to nonvolatile storage. Use smuX.cal.save() to save the new constants to nonvolatile storage. The active calibration constants will stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile storage with the smuX.cal.restore() function.
+
This function will be disabled until a successful call to smuX.cal.unlock() is made.
+
Example
+
+
+
+
-- Short sense LO and output LO terminals
+
-- Short sense HI and output HI terminals
+
-- Allow readings to settle, then get measurements
+
r0_hi, r0_lo = smua.contact.r()
+
+
-- Connect 50 OHM resistor between sense LO and output LO
+
-- Connect 50 OHM resistor between sense HI and output HI
+
-- Allow readings to settle, then get measurements
Source‑measure unit (SMU) channel (for example, smua.contact.calibratelo() applies to SMU channel A)
+
+
+
+
cp1Measured
+
+
The value measured by this SMU for calibration point 1
+
+
+
+
cp1Reference
+
+
The reference measurement for calibration point 1 as measured externally
+
+
+
+
cp2Measured
+
+
The value measured by this SMU for calibration point 2
+
+
+
+
cp2Reference
+
+
The reference measurement for calibration point 2 as measured externally
+
+
+
+
+
Details
+
Contact check measurement calibration does not require range information.
+
Typically, calibration points one and two will be near 0 W and 50 W, respectively.
+
All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the active calibration set. If not, corruption of the calibration constants may result.
+
The new calibration constants will be activated immediately but are not written to nonvolatile storage. Use smuX.cal.save() to save the new constants to nonvolatile storage. The active calibration constants will stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile storage with the smuX.cal.restore() function.
+
This function will be disabled until a successful call to smuX.cal.unlock() is made.
+
Example
+
+
+
+
-- Short sense LO and output LO terminals
+
-- Short sense HI and output HI terminals
+
-- Allow readings to settle, then get measurements
+
r0_hi, r0_lo = smua.contact.r()
+
+
-- Connect 50 OHM resistor between sense LO and output LO
+
-- Connect 50 OHM resistor between sense HI and output HI
+
-- Allow readings to settle, then get measurements
This function determines if contact resistance is lower than the threshold.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
smuX.contact.check()
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.contact.check() applies to SMU channel A)
+
+
+
+
+
Details
+
This function returns true if the contact resistance is below the threshold; this function returns false if it is above the threshold. The threshold value is set by the smuX.contact.threshold attribute.
+
Attempting to perform a contact check measurement when any of the following conditions exist will generate errors:
+
When output is on and any of the following:
+
SMU is a current source with current range set to less than 1 mA (error code 5065, "I range too low for contact check")
SMU is a voltage source with current limit set to less than 1 mA (error code 5050, "I limit too low for contact check")
When output is off and any of the following:
+
The output off mode is High-Z (error code 5048, "Contact check not valid with HIGH-Z OUTPUT off")
The output off mode is Normal with the smuX.source.offfunc attribute set to smuX.OUTPUT_DCVOLTS and the off current limit set to less than 1 mA (error code 5066, "source.offlimiti too low for contact check")
The output off mode is Normal with the smuX.source.offfunc attribute set to smuX.OUTPUT_DCAMPS and the source range is less than 1 mA (error code 5065, "I range too low for contact check")
Example
+
+
+
+
if not smua.contact.check() then
+
-- take action
+
end
+
+
Takes action if contact check on SMU channel A fails.
The measured contact resistance on the high/sense high side
+
+
+
+
rlo
+
+
The measured contact resistance on the low/sense low side
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.contact.r() applies to SMU channel A)
+
+
+
+
+
Details
+
Attempting to perform a contact resistance measurement when any of the following conditions exist will generate an error:
+
When output is on and any of the following:
+
SMU is a current source with current range set to less than 1 mA (error code 5065, "I range too low for contact check")
SMU is a voltage source with current limit set to less than 1 mA (error code 5050, "I limit too low for contact check")
When output is off and any of the following:
+
The output off mode is High-Z (error code 5048, "Contact check not valid with HIGH-Z OUTPUT off")
The output off mode is Normal with the smuX.source.offfunc attribute set to smuX.OUTPUT_DCVOLTS and the off current limit set to less than 1 mA (error code 5066, "source.offlimiti too low for contact check")
The output off mode is Normal with the smuX.source.offfunc attribute set to smuX.OUTPUT_DCAMPS and the source range is less than 1 mA (error code 5065, "I range too low for contact check")
Source‑measure unit (SMU) channel (for example, smua.makebuffer() applies to SMU channel A)
+
+
+
+
bufferSize
+
+
Maximum number of readings that can be stored
+
+
+
+
+
Details
+
Reading buffers can be created and allocated dynamically using this function. Use bufferSize to designate the number of readings the buffer can store.
+
Dynamically allocated reading buffers can be used interchangeably with the smuX.nvbufferY buffers.
+
A reading buffer can be deleted by setting all references to the reading buffer equal to nil, then running the garbage collector (see the collectgarbage() function in Standard libraries).
+
Example
+
+
+
+
mybuffer2 = smua.makebuffer(200)
+
+
Creates a 200 element reading buffer (mybuffer2)for SMU channel A .
This attribute stores the measurement autorange setting.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset SMU reset Recall setup
+
+
Saved setup
+
+
1 (smuX.AUTORANGE_ON)
+
+
+
+
+
Usage
+
autoRange = smuX.measure.autorangeY
+
smuX.measure.autorangeY = autoRange
+
+
+
+
autoRange
+
+
The state of the measurement autorange setting; set to one of the following values:
+
0 or smuX.AUTORANGE_OFF: Disabled
+
1 or smuX.AUTORANGE_ON: Enabled
+
2 or smuX.AUTORANGE_FOLLOW_LIMIT: Measure range automatically set to the limit range
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.measure.autorangev applies to SMU channel A)
+
+
+
+
Y
+
+
SMU measure function (v = voltage, i = current)
+
+
+
+
+
Details
+
This attribute indicates the measurement autorange state. Its value will be smuX.AUTORANGE_OFF when the SMU measure circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.
+
Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed range. The fixed range will be the present SMU measure range.
+
Setting this attribute to smuX.AUTORANGE_ON puts the SMU measure circuit into autorange mode. It will remain on its present measure range until the next measurement is requested.
+
If source highC mode is enabled, current autorange will be set to smuX.AUTORANGE_FOLLOW_LIMIT and cannot be changed.
+
Example
+
+
+
+
smua.measure.autorangev = 1
+
+
Enables voltage measurement autoranging for SMU channel A. Alternatively, the value 1 may be replaced with smua.AUTORANGE_ON.
This attribute sets the behavior of the source-measure unit's (SMU's) A/D internal reference measurements (autozero).
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset SMU reset Recall setup
+
+
Saved setup
+
+
2 (smuX.AUTOZERO_AUTO)
+
+
+
+
+
Usage
+
azMode = smuX.measure.autozero
+
smuX.measure.autozero = azMode
+
+
+
+
azMode
+
+
Indicates status of autozero; set to one of the following values:
+
0 or smuX.AUTOZERO_OFF: Autozero disabled
+
1 or smuX.AUTOZERO_ONCE: Performs autozero once, then disables autozero
+
2 or smuX.AUTOZERO_AUTO: Automatic checking of reference and zero measurements; an autozero is performed when needed
+
+
+
+
X
+
+
SMU channel (for example, smua.measure.autozero applies to SMU channel A)
+
+
+
+
+
Details
+
The integrating analog-to-digital converter (ADC) uses a ratio metric A/D conversion technique. To ensure the accuracy of readings, the instrument must periodically obtain fresh measurements of its internal ground and voltage reference. The time interval between updates to these reference measurements is determined by the integration aperture being used for measurements. Separate reference and zero measurements are used for each aperture.
+
By default, the instrument automatically checks these reference measurements whenever a signal measurement is made. If the reference measurements have expired when a signal measurement is made, the instrument will automatically take two more A/D conversions, one for the reference and one for the zero, before returning the result. Thus, occasionally, a measurement takes longer than normal.
+
This additional time can cause problems in sweeps and other test sequences in which measurement timing is critical. To avoid the extra time for the reference measurements in these situations, the smuX.measure.autozero attribute can be used to disable the automatic reference measurements. Keep in mind that disabling automatic reference measurements may allow the instrument to gradually drift out of specification.
+
To minimize the drift, a reference and zero measurement should be made just prior to the critical test sequence. The smuX.AUTOZERO_ONCE setting can be used to force a refresh of the reference and zero measurements used for the current aperture setting.
+
Autozero reference measurements for the last 10 used NPLC settings are stored in a reference cache. If an NPLC setting is selected and an entry for it is not in the cache, the oldest (least recently used) entry will be discarded to make room for the new entry.
+
The fast ADC (analog-to-digital converter) does not need or use the reference measurements associated with this attribute (only the integrating ADC). When this attribute is set to smuX.AUTOZERO_AUTO, the fast ADC will not require these reference measurements. However, if the fast ADC is selected, setting this attribute to smuX.AUTOZERO_ONCE will cause the integrating ADC to acquire a new set of reference measurements.
+
Example
+
+
+
+
smua.measure.autozero = 1
+
+
Performs autozero once for SMU channel A. Alternatively, the value 1 may be replaced with smua.AUTOZERO_ONCE.
Source‑measure unit (SMU) channel (for example, smua.measure.calibratev() applies to SMU channel A)
+
+
+
+
Y
+
+
SMU measurement function (v = voltage, i = current)
+
+
+
+
range
+
+
The measurement range to calibrate
+
+
+
+
cp1Measured
+
+
The value measured by this SMU for calibration point 1
+
+
+
+
cp1Reference
+
+
The reference measurement for calibration point 1 as measured externally
+
+
+
+
cp2Measured
+
+
The value measured by this SMU for calibration point 2
+
+
+
+
cp2Reference
+
+
The reference measurement for calibration point 2 as measured externally
+
+
+
+
+
Details
+
This function generates and activates new calibration constants for the given range. The positive and negative polarities of the instrument must be calibrated separately. Use a positive value for range to calibrate the positive polarity and a negative value for range to calibrate the negative polarity.
+
Typically the two calibration points used will be near zero for calibration point 1 and 90% of full scale for calibration point 2.
+
All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the active calibration set. Corruption of the calibration constants may result if this is not heeded.
+
The new calibration constants will be activated immediately but they will not be written to nonvolatile storage. Use smuX.cal.save() to commit the new constants to nonvolatile storage. The active calibration constants will stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile storage with the smuX.cal.restore() function.
+
This function will be disabled until a successful call to smuX.cal.unlock() is made.
SMU channel A calibrates voltage measurement using following values: 1 V calibration range, 1e-4 for +zero measurement reading, 1e-5 for +zero DMM measurement reading, 0.92 for +FS measurement reading, and 0.903 for the +FS DMM measurement reading.
This attribute sets the number of measurements performed when a measurement is requested.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset SMU reset Recall setup
+
+
Saved setup
+
+
1
+
+
+
+
+
Usage
+
count = smuX.measure.count
+
smuX.measure.count = count
+
+
+
+
count
+
+
Number of measurements
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.measure.count applies to SMU channel A)
+
+
+
+
+
Details
+
This attribute controls the number of measurements taken any time a measurement is requested. When using a reading buffer with a measure command, this attribute also controls the number of readings to be stored.
+
If smuX.measure.count is set to a value greater than 1, any measurement delay set by smuX.measure.delay will only occur before the first measurement, while the smuX.measure.interval controls the interval between successive measurements.
Set to your desired measurement delay value (for example, to specify an additional 10 ms measurement delay, set the value to 0.010)
+
You can also set it one of the following values:
+
0 or smuX.DELAY_OFF: No delay
+
-1 or smuX.DELAY_AUTO: Automatic delay value
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.measure.delay applies to SMU channel A)
+
+
+
+
+
Details
+
This attribute allows for additional delay (settling time) before taking a measurement. You can set mDelay to smuX.DELAY_OFF, smuX.DELAY_AUTO, or to a user-defined value (in seconds). A user‑defined value will set the delay used, regardless of range.
+
The smuX.DELAY_AUTO setting also causes a current range-dependent delay to be inserted when a current measurement is requested. This happens when a current measurement command is executed, when the measure action is being performed in a sweep, or after changing ranges during an autoranged measurement.
+
If smuX.measure.count is greater than 1, the measurement delay is only inserted before the first measurement.
This attribute sets the type of filter used for measurements when smuX.measure.filter.enable is enabled.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset SMU reset Recall setup
+
+
Saved setup
+
+
1 (smuX.FILTER_REPEAT_AVG)
+
+
+
+
+
Usage
+
filterType = smuX.measure.filter.type
+
smuX.measure.filter.type = filterType
+
+
+
+
filterType
+
+
The filter type to use when filtering is enabled. Set to one of the following values:
+
0 or smuX.FILTER_MOVING_AVG: Selects the moving average filter
+
1 or smuX.FILTER_REPEAT_AVG: Selects the repeat filter
+
2 or smuX.FILTER_MEDIAN: Selects the median filter
+
+
+
+
X
+
+
SMU channel (for example, smua.measure.filter.type applies to SMU Channel A)
+
+
+
+
+
Details
+
There are two averaging filter types and one median filter type available. Both repeating and moving types of averaging filters are available.
+
For the repeating filter (which is the power-on default), the stack (filter count) is filled, and the conversions are averaged to yield a reading. The stack is then cleared, and the process starts over.
+
The moving average filter uses a first-in, first-out stack. When the stack (filter count) becomes full, the measurement conversions are averaged, yielding a reading. For each subsequent conversion placed into the stack, the oldest conversion is discarded. The stack is re-averaged, yielding a new reading.
+
The median filter uses a first-in, first-out stack. When the stack (filter count) becomes full, the “middle-most” reading is returned. For each subsequent conversion placed into the stack, the oldest reading is discarded. The stack is then re-sorted, yielding a new reading. If the filter count is an even number, the reading returned is the average of the two middle readings.
+
Example
+
+
+
+
smua.measure.filter.type = 2
+
+
Selects the median filter for SMU channel A. Alternatively, the value 2 may be replaced with smua.FILTER_MEDIAN.
This attribute sets the interval between multiple measurements.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset SMU reset Recall setup
+
+
Saved setup
+
+
0 (0 s)
+
+
+
+
+
Usage
+
interval = smuX.measure.interval
+
smuX.measure.interval = interval
+
+
+
+
interval
+
+
The interval value (in seconds). Set to a value between 0 and 1
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.measure.interval applies to SMU channel A)
+
+
+
+
+
Details
+
This attribute sets the time interval between measurements when smuX.measure.count is set to a value greater than 1. The SMU will do its best to start each measurement when scheduled. If the SMU cannot keep up with the interval setting, measurements will be made as fast as possible.
+
If filtered measurements are being made, this interval is from the start of the first measurement for the filtered reading to the first measurement for a subsequent filtered reading. Extra measurements made to satisfy a filtered reading are not paced by this interval.
+
Example
+
+
+
+
smua.measure.interval = 0.5
+
+
Sets the measure interval for SMU channel A to 0.5.
This attribute sets the lowest measure range that will be used during autoranging.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset SMU reset Recall setup
+
+
Saved setup
+
+
Current: 100e‑9 (100 nA)
+
Voltage: 100e‑3 (100 mV)
+
+
+
+
+
Usage
+
lowRange = smuX.measure.lowrangeY
+
smuX.measure.lowrangeY = lowRange
+
+
+
+
lowRange
+
+
The lowest voltage or current measure range used during autoranging
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.measure.lowrangev applies to SMU channel A)
+
+
+
+
Y
+
+
SMU measure function (v = voltage, i = current)
+
+
+
+
+
Details
+
This attribute is used with autoranging to put a lower bound on the range used. Since lower ranges generally require greater settling times, setting a lowest range limit might make measurements require less settling time.
+
If the instrument is set to autorange and it is on a range lower than the one specified, the range will be changed to the lowRange range value.
This attribute sets the integration aperture for measurements.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset SMU reset Recall setup
+
+
Saved setup
+
+
1.0
+
+
+
+
+
Usage
+
nplc = smuX.measure.nplc
+
smuX.measure.nplc = nplc
+
+
+
+
nplc
+
+
The integration aperture; set from 0.001 to 25
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.measure.nplc applies to SMU channel A)
+
+
+
+
+
Details
+
When making measurements, the SMU uses one of two types of analog‑to‑digital converters. This attribute controls the integration aperture for the integrating analog‑to‑digital converter (ADC). This attribute is not used when the fast ADC is selected.
+
The integration aperture is based on the number of power line cycles (NPLC), where 1 PLC for 60 Hz is 16.67 ms (1/60) and 1 PLC for 50 Hz is 20 ms (1/50).
+
Example
+
+
+
+
smua.measure.nplc = 0.5
+
+
Sets the integration time for SMU channel A to 0.5/60 seconds.
This function starts an asynchronous (background) measurement.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
smuX.measure.overlappedY(rbuffer)
+
smuX.measure.overlappediv(ibuffer, vbuffer)
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)
+
+
+
+
Y
+
+
SMU measurement type (v = voltage, i = current, r = resistance, p = power)
+
+
+
+
rbuffer
+
+
A reading buffer object where the reading(s) will be stored
+
+
+
+
ibuffer
+
+
A reading buffer object where current reading(s) will be stored
+
+
+
+
vbuffer
+
+
A reading buffer object where voltage reading(s) will be stored
+
+
+
+
+
Details
+
This function will start a measurement and return immediately. The measurements, as they are performed, are stored in a reading buffer (along with any ancillary information also being acquired). If the instrument is configured to return multiple readings where one is requested, the readings will be available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.
+
The smuX.measure.overlappediv() function stores current readings in ibuffer and voltage readings in vbuffer.
+
This function is an overlapped command. Script execution will continue while the measurement(s) is made in the background. Attempts to access result values that have not yet been generated will cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurement(s) to complete before continuing.
+
If a given reading buffer contains any data, it will be cleared prior to taking any measurements, unless the reading buffer has been configured to append data.
+
Example
+
+
+
+
smua.measure.overlappedv(smua.nvbuffer1)
+
+
Starts background voltage measurements for SMU channel A.
This attribute contains the positive full‑scale value of the measure range for voltage or current.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset SMU reset Recall setup
+
+
Saved setup
+
+
Current: 100e-9 (100 nA)
+
Voltage: 100e-3 (100 mV)
+
+
+
+
+
Usage
+
rangeValue = smuX.measure.rangeY
+
smuX.measure.rangeY = rangeValue
+
+
+
+
rangeValue
+
+
Set to the maximum expected voltage or current to be measured
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)
+
+
+
+
Y
+
+
SMU measurement function (v = voltage, i = current)
+
+
+
+
+
Details
+
Reading this attribute returns the positive full-scale value of the measure range the SMU is currently using. Assigning a value to this attribute sets the SMU on a fixed range large enough to measure the assigned value. The instrument will select the best range for measuring a value of rangeValue.
+
This attribute is primarily intended to eliminate the time required by the automatic range selection performed by a measuring instrument. Because selecting a fixed range will prevent autoranging, an over-range condition can occur. For example, measuring 3.0 V on the Model 2651A 1 V range will cause an overrange. The value 9.91000E+37 is returned when this occurs.
+
If the source function is the same as the measurement function (for example, sourcing voltage and measuring voltage), the measurement range is locked to be the same as the source range. However, the setting for the measure range is retained. If the source function is changed (for example, from sourcing voltage to sourcing current), the retained measurement range will be used.
+
Model 2651A example: Assume the source function is voltage. The source range is 1 V and you set the measure range for 10 V. Since the source range is 1 V, the SMU will perform voltage measurements on the 1 V range. If you now change the source function to current, voltage measurements will be performed on the 10 V range.
+
Explicitly setting a measure range will disable measure autoranging for that function. Autoranging is controlled separately for each source and measurement function: source voltage, source current, measure voltage and measure current. Autoranging is enabled for all four by default.
+
Changing the range while the output is off will not update the hardware settings, but querying will return the range setting that will be used once the output is turned on. Setting a range while the output is on will take effect immediately.
+
With measure autoranging enabled, the range will be changed only when a measurement is taken. Querying the range after a measurement will return the range selected for that measurement.
+
Example
+
+
+
+
smua.measure.rangev = 0.5
+
+
Selects the 1 V measurement range for SMU channel A.
Returned value of the last (or only) reading of the measurement process
+
+
+
+
X
+
+
Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)
+
+
+
+
Y
+
+
SMU measurement function (v = voltage, i = current, r = resistance, p = power)
+
+
+
+
readingBuffer
+
+
A reading buffer object where all readings will be stored
+
+
+
+
iReading
+
+
The last reading of the current measurement process
+
+
+
+
vReading
+
+
The last reading of the voltage measurement process
+
+
+
+
iReadingBuffer
+
+
A reading buffer object where current readings will be stored
+
+
+
+
vReadingBuffer
+
+
A reading buffer object where voltage readings will be stored
+
+
+
+
+
Details
+
This function (without specifying a reading buffer) will only make one measurement and return that measurement as reading. To use the additional information acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings will be available in readingBuffer, but only the last measurement will be returned as reading.
+
Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.
+
The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).
+
The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU will ignore the smuX.measure.count attribute and only make one measurement.
+
The readingBuffer will be cleared before taking any measurements unless the buffer is configured to append data.
+
Example
+
+
+
+
smua.measure.count = 10
+
smua.measure.v(smua.nvbuffer1)
+
+
Performs ten voltage measurements using SMU channel A and stores them in a buffer.
This attribute turns relative measurements on or off.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset SMU reset Recall setup
+
+
Not saved
+
+
0 (smuX.REL_OFF)
+
+
+
+
+
Usage
+
relEnable = smuX.measure.rel.enableY
+
smuX.measure.rel.enableY = relEnable
+
+
+
+
relEnable
+
+
Relative measurement control. Set relEnable to one of the following values:
+
0 or smuX.REL_OFF: Disables relative measurements
+
1 or smuX.REL_ON: Enables relative measurements
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)
+
+
+
+
Y
+
+
SMU measurement function (v = voltage, i = current, r = resistance, p = power)
+
+
+
+
+
Details
+
This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings will be offset by the relative offset value specified by smuX.measure.rel.levelY. Specifically, each returned measured relative reading will be the result of the following calculation:
+
Relative reading = Actual measured reading - Relative offset value
+
Example
+
+
+
+
smua.measure.rel.enablev = smua.REL_ON
+
+
Enables relative voltage measurements for SMU channel A.
This attribute sets the offset value for relative measurements.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset SMU reset Recall setup
+
+
Not saved
+
+
0
+
+
+
+
+
Usage
+
relValue = smuX.measure.rel.levelY
+
smuX.measure.rel.levelY = relValue
+
+
+
+
relValue
+
+
Relative measurement offset value
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)
+
+
+
+
Y
+
+
SMU measurement function (v = voltage, i = current, r = resistance, p = power)
+
+
+
+
+
Details
+
This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings will be offset by the value of this attribute. Specifically, each returned measured relative reading will be the result of the following calculation:
+
Relative reading = Actual measured reading - Relative offset value
+
Example
+
+
+
+
smua.measure.rel.levelv = smua.measure.v()
+
+
Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.
Source‑measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)
+
+
+
+
Y
+
+
SMU measurement function (v = voltage, i = current, r = resistance, p = power)
+
+
+
+
sourceValue
+
+
Source value to be set after the measurement is made
+
+
+
+
iReading
+
+
The current reading before stepping the source
+
+
+
+
vReading
+
+
The voltage reading before stepping the source
+
+
+
+
+
Details
+
The smuX.measureYandstep() function performs a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but performs two measurements simultaneously; one for current (i) and one for voltage (v).
+
Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.
+
The specified source value should be appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.
+
Both source and measure autorange must be disabled before using this function. This function cannot be used if source highC mode is enabled (highC mode requires autoranging to be enabled).
+
This function is provided for very fast execution of source-measure loops. The measurement will be made prior to stepping the source. Prior to using this function, and before any loop this function may be used in, set the source value to its initial level.
+
Example
+
+
+
+
local ivalues = {}
+
smua.source.rangev = 1
+
smua.source.levelv = 0
+
smua.measure.rangei = 0.01
+
smua.source.output = smua.OUTPUT_ON
+
for index = 1, 10 do
+
ivalues[index] = smua.measureiandstep(index / 10)
+
end
+
ivalues[11] = smua.measure.i()
+
+
This use of the SMU channel A measure and step function measures current starting at a source value of 0 V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured.
This attribute contains the dedicated reading buffer.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Not applicable
+
+
See Details
+
+
Not applicable
+
+
+
+
+
Usage
+
bufferVar = smuX.nvbufferY
+
+
+
+
bufferVar
+
+
The dedicated reading buffer
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.nvbuffer1 applies to SMU channel A)
+
+
+
+
Y
+
+
SMU nonvolatile buffer (1 or 2)
+
+
+
+
+
Details
+
Each SMU channel contains two dedicated reading buffers: smuX.nvbuffer1 and smuX.nvbuffer2.
+
All routines that return measurements can also store them in either reading buffer. Overlapped measurements are always stored in a reading buffer. Synchronous measurements return either a single-point measurement or can be stored in a reading buffer if passed to the measurement command.
+
The dedicated reading buffers can be saved to internal nonvolatile memory (to retain data between power cycles) using the smuX.savebuffer() function.
+
Example
+
+
+
+
smua.measure.overlappedv(smua.nvbuffer1)
+
+
Store voltage readings from SMU channel A into SMU channel A dedicated reading buffer 1.
This attribute sets the state of the reading buffer's append mode.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Not applicable
+
+
See Details
+
+
0 (disabled)
+
+
+
+
+
Usage
+
state = bufferVar.appendmode
+
bufferVar.appendmode = state
+
+
+
+
state
+
+
The reading buffer append mode; set to one of the following:
+
0: Append mode off; new measure data overwrites the previous buffer content
1: Append mode on; appends new measure data to the present buffer content
+
+
+
bufferVar
+
+
The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer
+
+
+
+
+
Details
+
Assigning a value to this attribute enables or disables the buffer append mode. This value can only be changed with an empty buffer. Use bufferVar.clear() to empty the buffer.
+
For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.
+
If the append mode is set to 0, any stored readings in the buffer are cleared before new ones are stored. If append mode is set to 1, any stored readings remain in the buffer and new readings are added to the buffer after the stored readings.
+
With append mode on, the first new measurement is stored at rb[n+1], where n is the number of readings stored in buffer rb.
+
Example
+
+
+
+
buffer1.appendmode = 1
+
+
Append new readings to contents of the reading buffer named buffer1.
This attribute contains the timestamp of when the first reading was stored in the buffer.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Not applicable
+
+
See Details
+
+
0
+
+
+
+
+
Usage
+
basetime = bufferVar.basetimestamp
+
+
+
+
basetime
+
+
The timestamp of the first stored reading
+
+
+
+
bufferVar
+
+
The reading buffer; can be a dynamically allocated buffer (user‑defined), or a dedicated reading buffer (such as smua.nvbuffer1)
+
+
+
+
+
Details
+
This read-only attribute contains the timestamp (in seconds) of the first reading stored in a buffer (rb[1] stored in reading buffer rb). The timestamp is the number of seconds since 12:00 AM January 1, 1970 (UTC) that the measurement was performed and stored.
+
For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.
+
See the smuX.nvbufferY attribute for details on accessing dedicated reading buffers.
+
Example
+
+
+
+
basetime = smua.nvbuffer1.basetimestamp
+
+
+
print(basetime)
+
+
Read the timestamp for the first reading
+
stored in dedicated reading buffer 1.
+
Output: 1.2830e+09
+
The above output indicates that the timestamp is 1,283,000,000 seconds (which is Saturday, August 28, 2010 at 12:53:20 PM).
This attribute contains the capacity of the buffer.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Not applicable
+
+
See Details
+
+
Not applicable
+
+
+
+
+
Usage
+
bufferCapacity= bufferVar.capacity
+
+
+
+
bufferCapacity
+
+
The maximum number of readings the buffer can store
+
+
+
+
bufferVar
+
+
The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer
+
+
+
+
+
Details
+
This read-only attribute reads the number of readings that can be stored in the buffer.
+
For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.
+
The buffer's capacity does not change as readings fill the buffer. A dedicated reading buffer that only collects basic items can store over 140,000 readings. Turning on additional collection items, such as timestamps and source values, decreases the capacity of a dedicated reading buffer (for example, smua.nvbuffer1), but does not change the capacity of a user-defined dynamically allocated buffer. A user-defined dynamically allocated buffer has a fixed capacity that is set when the buffer is created.
+
See the smuX.nvbufferY attribute for details on accessing dedicated reading buffers. See the smuX.makebuffer() function for information on creating user-defined dynamically allocated reading buffers.
+
Example
+
+
+
+
bufferCapacity = smua.nvbuffer1.capacity
+
+
print(bufferCapacity)
+
+
Reads the capacity of dedicated reading buffer 1.
+
Output:
+
1.49789e+05
+
The above output indicates that the buffer can hold 149789 readings.
The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer
+
+
+
+
+
Details
+
This function clears all readings and associated recall attributes (for example, bufferVar.timestamps and bufferVar.statuses) from the specified buffer.
The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer
+
+
+
+
+
Details
+
This function clears all readings from the specified cache.
+
If you run successive operations that overwrite reading buffer data, the reading buffer may return stale cache data. This can happen when:
+
Initiating successive sweeps without reconfiguring the sweep measurements. Watch for this when running Lua code remotely on more than one node, because values in the reading buffer cache may change while the Lua code is running.
Overwriting data in the reading buffer by setting the bufferVar.fillmode attribute to smuX.FILL_WINDOW.
To avoid this, you can include explicit calls to the bufferVar.clearcache() function to remove stale values from the reading buffer cache.
+
Example
+
+
+
+
smua.nvbuffer1.clearcache()
+
+
Clears the reading buffer cache for dedicated reading buffer 1.
This attribute sets whether or not source values will be stored with the readings in the buffer.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Not applicable
+
+
See Details
+
+
0 (disabled)
+
+
+
+
+
Usage
+
state = bufferVar.collectsourcevalues
+
bufferVar.collectsourcevalues =state
+
+
+
+
state
+
+
Source value collection status; set to one of the following:
+
0: Source value collection disabled (off)
1: Source value collection enabled (on)
+
+
+
bufferVar
+
+
The reading buffer; can be a dynamically allocated buffer (user‑defined), or a dedicated reading buffer (such as smua.nvbuffer1)
+
+
+
+
+
Details
+
Assigning a value to this attribute enables or disables the storage of source values. Reading this attribute returns the state of source value collection. This value can only be changed with an empty buffer. Empty the buffer using the bufferVar.clear() function.
+
For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.
+
When on, source values will be stored with readings in the buffer. This requires four extra bytes of storage per reading. Turning on additional collection items, such as source values (this attribute) and timestamps, decreases the capacity of a dedicated reading buffer (for example, smua.nvbuffer1), but does not change the capacity of a user-defined dynamically allocated buffer.
+
This value, off or on, can only be changed when the buffer is empty. Empty the buffer using the bufferVar.clear() function.
+
Example
+
+
+
+
smua.nvbuffer1.collectsourcevalues = 1
+
+
Include source values with readings for dedicated reading buffer 1.
This attribute sets whether or not timestamp values will be stored with the readings in the buffer.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Not applicable
+
+
See Details
+
+
0 (disabled)
+
+
+
+
+
Usage
+
state = bufferVar.collecttimestamps
+
bufferVar.collecttimestamps = state
+
+
+
+
state
+
+
Timestamp value collection status; set to one of the following:
+
0: Timestamp value collection disabled (off)
1: Timestamp value collection enabled (on)
+
+
+
bufferVar
+
+
The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer
+
+
+
+
+
Details
+
Assigning a value to this attribute enables or disables the storage of timestamps. Reading this attribute returns the state of timestamp collection.
+
For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.
+
When on, timestamp values will be stored with readings in the buffer. This requires four extra bytes of storage per reading. Turning on additional collection items, such as timestamps (this attribute)and source values, decreases the capacity of a dedicated reading buffer (for example, smua.nvbuffer1), but does not change the capacity of a user-defined dynamically allocated buffer.
+
This value, off (0) or on (1), can only be changed when the buffer is empty. Empty the buffer using the bufferVar.clear() function.
+
Example
+
+
+
+
smua.nvbuffer1.collecttimestamps = 1
+
+
Include timestamps with readings for dedicated reading buffer 1.
This attribute contains the timestamp's resolution.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Not applicable
+
+
See Details
+
+
1e-6 (1 ms)
+
+
+
+
+
Usage
+
resolution = bufferVar.timestampresolution
+
+
+
+
resolution
+
+
Timestamp resolution in seconds
+
+
+
+
bufferVar
+
+
The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer
+
+
+
+
+
Details
+
Assigning a value to this attribute sets the resolution for the timestamps. Reading this attribute returns the timestamp resolution value.This value can only be changed with an empty buffer. Empty the buffer using the bufferVar.clear() function.
+
The finest timestamp resolution is 0.000001 seconds (1 µs). At this resolution, the reading buffer can store unique timestamps for up to 71 minutes. This value can be increased for very long tests.
+
The value specified when setting this attribute will be rounded to an even power of 2 µs.
+
For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.
+
Example
+
+
+
+
smua.nvbuffer1.timestampresolution = 0.000008
+
+
+
Sets the timestamp resolution of dedicated reading buffer 1 to 8 µs.
This attribute contains the state of the remote/local sense mode.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU reset Instrument reset Recall setup
+
+
Saved setup
+
+
0 (smuX.SENSE_LOCAL)
+
+
+
+
+
Usage
+
senseMode = smuX.sense
+
smuX.sense = senseMode
+
+
+
+
senseMode
+
+
The sense mode; set to one of the following:
+
0 or smuX.SENSE_LOCAL: Selects local sense (2-wire)
+
1 or smuX.SENSE_REMOTE: Selects remote sense (4-wire)
+
3 or smuX.SENSE_CALA: Selects calibration sense mode
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.sense applies to SMU channel A)
+
+
+
+
+
Details
+
Source-measure operations are performed using either 2-wire local sense connections or 4-wire remote sense connections. Writing to this attribute selects the sense mode.
+
The smuX.SENSE_CALA mode is only used for calibration and may only be selected when calibration is enabled.
+
The sense mode can be changed between local and remote while the output is on.
+
The calibration sense mode cannot be selected while the output is on.
+
Resetting the instrument selects the local sense mode.
This attribute contains the state of the source autorange control (on/off).
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU reset Instrument reset Recall setup
+
+
Saved setup
+
+
1 (smuX.AUTORANGE_ON)
+
+
+
+
+
Usage
+
sourceAutorange = smuX.source.autorangeY
+
smuX.source.autorangeY = sourceAutorange
+
+
+
+
sourceAutorange
+
+
The state of the source autorange control. Set to one of the following:
+
0 or smuX.AUTORANGE_OFF: Disables source autorange
+
1 or smuX.AUTORANGE_ON: Enables source autorange
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.source.autorangev applies to SMU channel A)
+
+
+
+
Y
+
+
SMU source function (v = voltage, i = current)
+
+
+
+
+
Details
+
This attribute indicates the source autorange state. Its value will be smuX.AUTORANGE_OFF when the SMU source circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.
+
Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed source range. The fixed range used will be the present SMU source circuit range.
+
Setting this attribute to smuX.AUTORANGE_ON puts the SMU source circuit into autorange mode. If the source output is on, the SMU will immediately change range to the range most appropriate for the value being sourced if that range is different from the present SMU range.
+
Autorange will disable if the source level is edited from the front panel. Setting the source range turns off autorange when set by using the smuX.source.rangeY attribute as well.
+
Resetting the instrument selects the smuX.AUTORANGE_ON.
This attribute contains the state of source compliance.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Not applicable
+
+
Not saved
+
+
Not applicable
+
+
+
+
+
Usage
+
compliance = smuX.source.compliance
+
+
+
+
compliance
+
+
The state of source compliance
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.source.compliance applies to SMU channel A)
+
+
+
+
+
Details
+
This read-only attribute contains the source compliance state (true or false).
+
true indicates that the limit function is in control of the source (source in compliance).
false indicates that the source function is in control of the output (source not in compliance).
Writing to this attribute will generate an error.
+
Reading this attribute also updates the status model and the front panel with generated compliance information. See Current Limit (ILMT) shown in the status model diagram for the Measurement event registers. The Voltage Limit (VLMT) is not shown in the status model diagram for the Measurement event registers, but is similar to the Current Limit (ILMT).
+
Example
+
+
+
+
compliance = smua.source.compliance
+
+
print(compliance)
+
+
Reads the source compliance state for SMU channel A.
+
Output: true
+
This output indicates that a configured limit has been reached (voltage, current, or power limit).
Set to your desired source delay value (for example, to specify an additional 10 ms source delay, set the value to 0.010)
+
Alternatively, you can set it one of the following values:
+
0 or smuX.DELAY_OFF: No delay
+
-1 or smuX.DELAY_AUTO: Automatic delay value
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.source.delay applies to SMU channel A)
+
+
+
+
+
Details
+
This attribute allows for additional delay (settling time) after an output step. Set sDelay to a user-defined value (in seconds). Alternatively, set sDelay to smuX.DELAY_OFF or smuX.DELAY_AUTO.
+
The smuX.DELAY_AUTO setting causes a range-dependent delay to be inserted when the source is changed. Range dependent delays are based on the output settling time values in the instrument's specifications.
+
Example
+
+
+
+
smua.source.delay = smua.DELAY_AUTO
+
+
Sets the delay for SMU channel A to automatic (a range-dependent delay is inserted when ever the source is changed).
Source‑measure unit (SMU) channel (for example, smua.source.calibratev() applies to SMU channel A)
+
+
+
+
Y
+
+
SMU source function (v = voltage, i = current)
+
+
+
+
range
+
+
The measurement range to calibrate
+
+
+
+
cp1expected
+
+
The source value programmed for calibration point 1
+
+
+
+
cp1reference
+
+
The reference measurement for calibration point 1 as measured externally
+
+
+
+
cp2expected
+
+
The source value programmed for calibration point 2
+
+
+
+
cp2reference
+
+
The reference measurement for calibration point 2 as measured externally
+
+
+
+
+
Details
+
This function generates and activates new calibration constants for the given range.
+
The positive and negative polarities of the source must be calibrated separately. Use a positive value for range to calibrate the positive polarity and a negative value for range to calibrate the negative polarity. Do not use 0.0 for a negative calibration point as 0.0 is considered a positive number.
+
Typically the two calibration points used will be near zero for calibration point 1 and 90% of full scale for calibration point 2. Full scale for calibration point 2 should be avoided if the SMU's source is substantially out of calibration.
+
The two reference measurements must be made with the source using the active calibration set. For example, source a value, measure it, and do not change the active calibration set before issuing this command.
+
The new calibration constants will be activated immediately but they will not be written to nonvolatile storage. Use smuX.cal.save() to commit the new constants to nonvolatile storage.
+
The active calibration constants will stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile storage with the smuX.cal.restore() function.
+
This function will be disabled until a successful call to smuX.cal.unlock() is made.
SMU channel A calibrates voltage source using the following values: calibrate the 1 V range, 1e-10 for +zero source output value, 1e-5 for +zero DMM measurement reading, 0.9 for +FS source output value, and 0.903 for the +FS DMM measurement reading.
This attribute sets the source function (V source or I source).
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU reset Instrument reset Recall setup
+
+
Saved setup
+
+
1 (smuX.OUTPUT_DCVOLTS)
+
+
+
+
+
Usage
+
sFunction = smuX.source.func
+
smuX.source.func = sFunction
+
+
+
+
sFunction
+
+
The source function. Set to one of the following values:
+
0 or smuX.OUTPUT_DCAMPS: Selects current source function
+
1 or smuX.OUTPUT_DCVOLTS: Selects voltage source function
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.source.func applies to SMU channel A)
+
+
+
+
+
Details
+
Reading this attribute gives the output function of the source for the specified SMU channel. Setting this attribute configures the specified SMU channel as either a voltage source or a current source.
+
Example
+
+
+
+
smua.source.func = smua.OUTPUT_DCAMPS
+
+
Selects the source current function for SMU channel A.
The source value; set to one of the following values:Voltage: 0 V to ±40 V
+
Current: 0 A to ±20 A
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.source.levelv applies to SMU channel A)
+
+
+
+
Y
+
+
SMU source function (v = voltage, i = current)
+
+
+
+
+
Details
+
This attribute configures the output level of the voltage or current source.
+
If the source is configured as a voltage source and the output is on, the new smuX.source.levelv setting will be sourced immediately. If the output is off or the source is configured as a current source, the voltage level will be sourced when the source is configured as a voltage source and the output is turned on.
+
If the source is configured as a current source and the output is on, the new smuX.source.leveli setting will be sourced immediately. If the output is off or the source is configured as a voltage source, the current level will be sourced when the source is configured as a current source and the output is turned on.
+
The sign of sourceLevel dictates the polarity of the source. Positive values generate positive voltage or current from the high terminal of the source relative to the low terminal. Negative values generate negative voltage or current from the high terminal of the source relative to the low terminal.
+
The reset() function sets the source levels to 0 V and 0 A.
This attribute sets the lowest source range that will be used during autoranging.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU reset Instrument reset Recall setup
+
+
Saved setup
+
+
Voltage: 100e‑3 (100 mV)
+
Current: 100e‑9 (100 nA)
+
+
+
+
+
Usage
+
sourceRangeLow = smuX.source.lowrangeY
+
smuX.source.lowrangeY = sourceRangeLow
+
+
+
+
sourceRangeLow
+
+
Set to the lowest voltage (in volts) or current (in amperes) range to be used
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.source.lowrangev applies to SMU channel A)
+
+
+
+
Y
+
+
SMU source function (v = voltage, i = current)
+
+
+
+
+
Details
+
This attribute is used with source autoranging to put a lower bound on the range used. Lower ranges generally require greater settling times. By setting a low-range value, sourcing small values might be able to be made with less settling time.
+
If the instrument is set to autorange and it is on a range lower than the one specified by sourceRangeLow, the source range will be changed to the range specified by sourceRangeLow.
+
Example
+
+
+
+
smua.source.lowrangev = 1
+
+
Sets volts low range for Model 2651A SMU channel A to 1 V. This prevents the source from using the 100 mV range when sourcing voltage.
This attribute sets the limit (current or voltage) used when the source‑measure unit (SMU) is in normal output-off mode.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU reset Instrument reset Recall setup
+
+
Saved setup
+
+
Current: 1e-3 (1 mA) Voltage: 40 (40 V)
+
+
+
+
+
Usage
+
sourceLimit = smuX.source.offlimitY
+
smuX.source.offlimitY = sourceLimit
+
+
+
+
sourceLimit
+
+
Set to the limit to be used when the SMU is in normal output-off mode
+
+
+
+
X
+
+
SMU channel (for example, smua.source.offlimiti applies to SMU channel A)
+
+
+
+
Y
+
+
SMU source function (v = voltage, i = current)
+
+
+
+
+
Details
+
Setting the current limit to lower than 1 mA may interfere with operation of the contact check function. See smuX.contact.check() and smuX.contact.r() for details.
+
Example
+
+
+
+
smua.source.offlimiti = 10e-3
+
+
Changes the normal output-off mode limit to 10 mA for SMU channel A.
The output-off setting; set to one of the following values:
+
0 or smuX.OUTPUT_NORMAL: Configures the source function according to smuX.source.offfunc attribute
+
1 or smuX.OUTPUT_ZERO: Configures source to output 0 V as smuX.OUTPUT_NORMAL but has different compliance handling (see the Details below)
+
2 or smuX.OUTPUT_HIGH_Z: Opens the output relay when the output is turned off
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.source.offmode applies to SMU channel A)
+
+
+
+
+
Details
+
Reading this attribute gives the output-off mode of the source. Setting this attribute configures the SMU output-off mode.
+
The default sourceOffMode is smuX.OUTPUT_NORMAL. In this mode, the source function will be configured according to the smuX.source.offfunc attribute. The smuX.source.offfunc attribute controls whether the SMU is configured as a 0 V voltage source or a 0 A current source. When the SMU is operating as a 0 A current source, the smuX.source.offlimitv attribute sets the voltage limit, just as the smuX.source.offlimiti attribute sets the current limit when the SMU is operating as a 0 V voltage source.
+
When the offmode is set to smuX.OUTPUT_ZERO, the source will be configured to output 0 V just as smuX.OUTPUT_NORMAL mode with smuX.source.offfunc = smuX.OUTPUT_DCVOLTS. If the source function is voltage, the current limit will not be changed. If the source function is current, the current limit will be set to the current source level or 10 percent of the current source range, whichever is greater.
+
When offmode is set to smuX.OUTPUT_HIGH_Z, the SMU will open the output relay when the output is turned off.
+
Example
+
+
+
+
smua.source.offmode = smua.OUTPUT_HIGH_Z
+
+
Sets the output‑off operation for SMU channel A to open the output relay when the output is turned off.
This attribute sets source output state (on or off).
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU reset Instrument reset Recall setup
+
+
Not saved
+
+
0 (smuX.OUTPUT_OFF)
+
+
+
+
+
Usage
+
sourceOutput = smuX.source.output
+
smuX.source.output = sourceOutput
+
+
+
+
sourceOutput
+
+
The source's output state setting; set to one of the following values:
+
0 or smuX.OUTPUT_OFF: Turns off the source output
+
1 or smuX.OUTPUT_ON: Turns on the source output
+
2 or smuX.OUTPUT_HIGH_Z: Turns off the output in high Z mode (allows you to go to high Z mode without first setting the smuX.source.offmode attribute to smuX.OUTPUT_HIGH_Z)
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.source.output applies to SMU channel A)
+
+
+
+
+
Details
+
Reading this attribute gives the output state of the source. Setting this attribute will turn the output of the source on or off. The default for the source is off. When the output is turned on, the SMU will source either voltage or current as dictated by the smuX.source.func setting.
+
Setting this attribute equal to smuX.OUTPUT_HIGH_Z will cause the output to turn off and go to the High Z mode. If the smuX.source.output is then read it will return 0.
This attribute controls output enable action of the source.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU reset Instrument reset Recall setup
+
+
Saved setup
+
+
0 (smuX.OE_NONE)
+
+
+
+
+
Usage
+
outputAction = smuX.source.outputenableaction
+
smuX.source.outputenableaction = outputAction
+
+
+
+
outputAction
+
+
The source's output enable action. Set to one of the following values:
+
0 or smuX.OE_NONE: No action
+
1 or smuX.OE_OUTPUT_OFF: Turns the source output off
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.source.outputenableaction applies to SMU channel A)
+
+
+
+
+
Details
+
This attribute controls the SMU action taken when the output enable line is deasserted.
+
When set to smuX.OE_NONE, the SMU will take no action when the output enable line goes low (deasserted).
+
When set to smuX.OE_OUTPUT_OFF and the output enable line is de-asserted, the SMU will turn its output off as if the smuX.source.output = smuX.OUTPUT_OFF command had been received.
+
The SMU will not automatically turn its output on when the output enable line returns to the high state.
+
If the output enable line is not asserted when this attribute is set to smuX.OE_OUTPUT_OFF and the output is on, the output will turn off immediately.
+
Detection of the output enable line going low will not abort any running scripts. This may cause execution errors.
Set to the maximum expected voltage or current to be sourced
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)
+
+
+
+
Y
+
+
SMU source function (v = voltage, i = current)
+
+
+
+
+
Details
+
This attribute contains a value that sets the source‑measure unit (SMU) to a fixed range large enough to source the value. When read, the attribute contains the range the instrument is presently on when in autorange.
+
Assigning a value to this attribute sets the SMU to a fixed range large enough to source the assigned value. The instrument will select the best range for sourcing a value of rangeValue.
+
Reading this attribute returns the positive full-scale value of the source range the SMU is currently using. With source autoranging enabled, the output level controls the range. Querying the range after the level is set will return the range the unit chose as appropriate for that source level.
+
This attribute is primarily intended to eliminate the time required by the automatic range selection performed by a sourcing instrument. Because selecting a fixed range will prevent autoranging, an overrange condition can occur. For example, sourcing 3.0 V on the Model 2651A 1 V range will cause an overrange condition.
Set to the source settling mode. Set to one of the following values:
+
0 or smuX.SETTLE_SMOOTH: Turns off additional settling operations (default)
+
1 or smuX.SETTLE_FAST_RANGE: Instructs the source‑measure unit (SMU) to use a faster procedure when changing ranges
+
2 or smuX.SETTLE_FAST_POLARITY: Instructs the SMU to change polarity without going to zero
+
3 or smuX.SETTLE_DIRECT_IRANGE: Instructs the SMU to change the current range directly
+
128 or smuX.SETTLE_FAST_ALL: Enables all smuX.SETTLE_FAST_* operations
+
+
+
+
X
+
+
SMU channel (for example, smua.source.settling applies to SMU channel A)
+
+
+
+
+
Details
+
Using smuX.SETTLE_FAST_RANGE may cause the SMU to exceed the range change overshoot specification.
+
smuX.SETTLE_FAST_POLARITY does not go to zero when changing polarity and may create inconsistencies at the zero crossing.
+
smuX.SETTLE_DIRECT_IRANGE switches the SMU directly to the target range instead of the default “range-by-range” method. This option is mutually exclusive of any other smuX.SETTLE_FAST_* commands.
Set to the source settling mode. Set to one of the following values:
+
0 or smuX.DISABLE: Turns off sink mode
+
1 or smuX.ENABLE: Turns on sink mode
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.source.sink applies to SMU channel A)
+
+
+
+
+
Details
+
This attribute enables or disables sink mode. When enabled, sink mode reduces the source limit inaccuracy seen when operating in quadrants II and IV (quadrants I and III will show this source limit inaccuracy).
This attribute sets the arm count in the trigger model.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU reset Instrument reset Recall setup
+
+
Not saved
+
+
1
+
+
+
+
+
Usage
+
triggerArmCount = smuX.trigger.arm.count
+
smuX.trigger.arm.count = triggerArmCount
+
+
+
+
triggerArmCount
+
+
The arm count in the trigger model
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.trigger.arm.count applies to SMU channel A)
+
+
+
+
+
Details
+
During a sweep, the SMU iterates through the arm layer of the trigger model this many times. After performing this many iterations, the SMU returns to an idle state.
+
If this count is set to zero, the SMU stays in the trigger model indefinitely until aborted.
+
Example
+
+
+
+
smua.trigger.arm.count = 5
+
+
Sets the SMU channel A to iterate through the arm layer of the trigger model five times and then return to the idle state.
This function sets the arm event detector to the detected state.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
smuX.trigger.arm.set()
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.trigger.arm.set() applies to SMU channel A)
+
+
+
+
+
Details
+
The SMU will automatically clear all the event detectors when the smuX.trigger.initiate() function is executed. This function should be called after the sweep is initiated.
+
A common example of when this function can be used is when you want the SMU to immediately perform an action the first time through the trigger model even if a programmed trigger event does not occur.
+
This function can also be used to start actions on the SMU in case of a missed trigger event.
+
Example
+
+
+
+
smua.trigger.arm.set()
+
+
+
Sets the arm event detector to the detected state for SMU channel A.
This attribute selects the event that will cause the arm event detector to enter the detected state.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU reset Instrument reset Recall setup
+
+
Not saved
+
+
0
+
+
+
+
+
Usage
+
eventID = smuX.trigger.arm.stimulus
+
smuX.trigger.arm.stimulus = eventID
+
+
+
+
eventID
+
+
Event that triggers the arm detector
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.trigger.arm.stimulus applies to SMU channel A)
+
+
+
+
+
Details
+
Set this attribute to the event ID of any trigger event generator to wait for that event.
+
Set this attribute to zero to bypass waiting for events at the arm event detector (the SMU continues uninterrupted through the remote trigger model). Set eventID to one of the existing trigger event IDs shown in the following table.
+
+
+
+
+
+
+
Trigger event IDs*
+
+
+
+
Event ID
+
+
Event description
+
+
+
+
smua.trigger.SWEEPING_EVENT_ID
+
+
Occurs when the source‑measure unit (SMU) transitions from the idle state to the arm layer of the trigger model
+
+
+
+
smua.trigger.ARMED_EVENT_ID
+
+
Occurs when the SMU moves from the arm layer to the trigger layer of the trigger model
+
+
+
+
smua.trigger.SOURCE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a source action
+
+
+
+
smua.trigger.MEASURE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a measure action
+
+
+
+
smua.trigger.PULSE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a pulse
+
+
+
+
smua.trigger.SWEEP_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a sweep
+
+
+
+
smua.trigger.IDLE_EVENT_ID
+
+
Occurs when the SMU returns to the idle state
+
+
+
+
digio.trigger[N].EVENT_ID
+
+
Occurs when an edge is detected on a digital I/O line
+
+
+
+
tsplink.trigger[N].EVENT_ID
+
+
Occurs when an edge is detected on a TSP‑Link line
+
+
+
+
lan.trigger[N].EVENT_ID
+
+
Occurs when the appropriate LXI trigger packet is received on LAN trigger object N
+
+
+
+
display.trigger.EVENT_ID
+
+
Occurs when the TRIG key on the front panel is pressed
+
+
+
+
trigger.EVENT_ID
+
+
Occurs when a *TRG command is received on the remote interface
+
(GPIB only) Occurs when a GET bus command is received
+
(VXI-11 only) Occurs with the VXI-11 command device_trigger; reference the VXI-11 standard for additional details on the device trigger operation
+
+
+
+
trigger.blender[N].EVENT_ID
+
+
Occurs after a collection of events is detected
+
+
+
+
trigger.timer[N].EVENT_ID
+
+
Occurs when a delay expires
+
+
+
+
+
+
+
+
* Use the name of the trigger event ID to set the stimulus value rather than the numeric value. Using the name makes the code compatible for future upgrades (for example, if the numeric values must change when enhancements are added to the instrument).
+
+
+
+
+
+
Example
+
+
+
+
smua.trigger.arm.stimulus =
+
trigger.timer[1].EVENT_ID
+
+
An event on trigger timer 1 causes the arm event detector to enter the detected state.
This attribute turns automatic clearing of the event detectors on or off.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU reset Instrument reset Recall setup
+
+
Not saved
+
+
0 (smuX.DISABLE)
+
+
+
+
+
Usage
+
autoClear = smuX.trigger.autoclear
+
smuX.trigger.autoclear = autoClear
+
+
+
+
autoClear
+
+
Auto clear setting; set to one of the following values:
+
0 or smuX.DISABLE: Turns off automatic clearing of the event detectors
+
1 or smuX.ENABLE: Turns on automatic clearing of the event detectors
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.trigger.autoclear applies to SMU channel A)
+
+
+
+
+
Details
+
This attribute is used to enable or disable automatic clearing of the trigger model state machine event detectors when the SMU transitions from the arm layer to the trigger layer.
+
Only the detected state of the event detectors will be cleared.
+
The overrun status of the event detectors are not automatically cleared when the SMU transitions from the arm layer to the trigger layer.
+
The event detectors are always cleared when a sweep is initiated.
This attribute sets the trigger count in the trigger model.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU reset Instrument reset Recall setup
+
+
Not saved
+
+
1
+
+
+
+
+
Usage
+
triggerCount = smuX.trigger.count
+
smuX.trigger.count = triggerCount
+
+
+
+
triggerCount
+
+
The trigger count is the number of times the source‑measure unit (SMU) will iterate in the trigger layer for any given sweep
+
+
+
+
X
+
+
SMU channel (for example, smua.trigger.count applies to SMU channel A)
+
+
+
+
+
Details
+
During a sweep, the SMU iterates through the trigger layer of the trigger model this many times. After performing this many iterations, the SMU returns to the arm layer.
+
If this count is set to zero (0), the SMU stays in the trigger model indefinitely until aborted.
This attribute enables or disables pulse mode sweeps.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU reset Instrument reset Recall setup
+
+
Not saved
+
+
1 (smuX.SOURCE_HOLD)
+
+
+
+
+
Usage
+
pulseAction = smuX.trigger.endpulse.action
+
smuX.trigger.endpulse.action = pulseAction
+
+
+
+
pulseAction
+
+
The pulse mode setting; set to one of the following values (see details for definition):
+
1 or smuX.SOURCE_HOLD
+
0 or smuX.SOURCE_IDLE
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.trigger.endpulse.action applies to SMU channel A)
+
+
+
+
+
Details
+
When set to smuX.SOURCE_HOLD, this attribute disables pulse mode sweep, holding the source level for remainder of step. When set to smuX.SOURCE_IDLE, this attribute enables pulse mode sweep, setting the source level to the programmed (idle) level at the end of the pulse.
+
Example
+
+
+
+
smua.trigger.endpulse.action = smua.SOURCE_IDLE
+
smua.trigger.endpulse.stimulus =
+
trigger.timer[1].EVENT_ID
+
+
Configure end pulse action to achieve a pulse and configures trigger timer 1 to control the end of pulse.
This function sets the end pulse event detector to the detected state.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
smuX.trigger.endpulse.set()
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.trigger.endpulse.set() applies to SMU channel A)
+
+
+
+
+
Details
+
This function sets the end pulse event detector to the detected state.
+
The SMU automatically clears all the event detectors when the smuX.trigger.initiate() function is executed. This function should be called after the sweep is initiated. Make sure that if the event detectors are configured to clear automatically (because the smuX.trigger.autoclear attribute is set to smuX.ENABLE) that this command is issued after the SMU has entered the trigger layer.
This attribute defines which event will cause the end pulse event detector to enter the detected state.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU reset Instrument reset Recall setup
+
+
Not saved
+
+
0
+
+
+
+
+
Usage
+
eventID = smuX.trigger.endpulse.stimulus
+
smuX.trigger.endpulse.stimulus = eventID
+
+
+
+
eventID
+
+
Set to the event that triggers the end pulse source off action
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.trigger.endpulse.stimulus applies to SMU channel A)
+
+
+
+
+
Details
+
Set this attribute to the event ID of any trigger event generator to wait for that event. To bypass waiting for an event, set this attribute's value to 0. Set eventID to one of the existing trigger event IDs shown in the following table.
+
+
+
+
+
+
+
Trigger event IDs*
+
+
+
+
Event ID
+
+
Event description
+
+
+
+
smua.trigger.SWEEPING_EVENT_ID
+
+
Occurs when the source‑measure unit (SMU) transitions from the idle state to the arm layer of the trigger model
+
+
+
+
smua.trigger.ARMED_EVENT_ID
+
+
Occurs when the SMU moves from the arm layer to the trigger layer of the trigger model
+
+
+
+
smua.trigger.SOURCE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a source action
+
+
+
+
smua.trigger.MEASURE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a measure action
+
+
+
+
smua.trigger.PULSE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a pulse
+
+
+
+
smua.trigger.SWEEP_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a sweep
+
+
+
+
smua.trigger.IDLE_EVENT_ID
+
+
Occurs when the SMU returns to the idle state
+
+
+
+
digio.trigger[N].EVENT_ID
+
+
Occurs when an edge is detected on a digital I/O line
+
+
+
+
tsplink.trigger[N].EVENT_ID
+
+
Occurs when an edge is detected on a TSP‑Link line
+
+
+
+
lan.trigger[N].EVENT_ID
+
+
Occurs when the appropriate LXI trigger packet is received on LAN trigger object N
+
+
+
+
display.trigger.EVENT_ID
+
+
Occurs when the TRIG key on the front panel is pressed
+
+
+
+
trigger.EVENT_ID
+
+
Occurs when a *TRG command is received on the remote interface
+
(GPIB only) Occurs when a GET bus command is received
+
(VXI-11 only) Occurs with the VXI-11 command device_trigger; reference the VXI-11 standard for additional details on the device trigger operation
+
+
+
+
trigger.blender[N].EVENT_ID
+
+
Occurs after a collection of events is detected
+
+
+
+
trigger.timer[N].EVENT_ID
+
+
Occurs when a delay expires
+
+
+
+
+
+
+
+
* Use the name of the trigger event ID to set the stimulus value rather than the numeric value. Using the name makes the code compatible for future upgrades (for example, if the numeric values must change when enhancements are added to the instrument).
+
+
+
+
+
+
Example
+
+
+
+
smua.trigger.endpulse.action = smua.SOURCE_IDLE
+
smua.trigger.endpulse.stimulus =
+
trigger.timer[1].EVENT_ID
+
+
Configure end pulse action to achieve a pulse and selects the event trigger.timer[1].EVENT_ID that will cause the arm event detector to enter the detected state.
This attribute sets the action of the source at the end of a sweep.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU reset Instrument reset Recall setup
+
+
Not saved
+
+
0 (smuX.SOURCE_IDLE)
+
+
+
+
+
Usage
+
action = smuX.trigger.endsweep.action
+
smuX.trigger.endsweep.action = action
+
+
+
+
action
+
+
The source action at the end of a sweep; set to one of the following values:
+
0 or smuX.SOURCE_IDLE: Sets the source level to the programmed (idle) level at the end of the sweep
+
1 or smuX.SOURCE_HOLD: Sets the source level to stay at the level of the last step
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.trigger.endsweep.action applies to SMU channel A)
+
+
+
+
+
Details
+
Use this attribute to configure the source action at the end of the sweep. The SMU can be programmed to return to the idle source level or hold the last value of the sweep.
+
Example
+
+
+
+
smua.trigger.endsweep.action = smua.SOURCE_IDLE
+
+
Sets SMU channel A to return the source back to the idle source level at the end of a sweep.
Source‑measure unit (SMU) channel (for example, smua.trigger.initiate() applies to SMU channel A)
+
+
+
+
+
Details
+
This function causes the SMU to clear the four trigger model event detectors and enter its trigger model state machine (moves the SMU from the idle state into the arm layer).
+
To perform source actions during the sweep, it is necessary to configure and enable one of the sweep source actions, smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY(), and measure actions (smuX.trigger.measure.Y(), before calling this function.
+
If you run this function more than once without reconfiguring the sweep measurements, the caches on the configured measurement reading buffers will hold stale data. If you do run this function repeatedly without reconfiguring the sweep measurement, use the bufferVar.clearcache() function to remove stale values from the reading buffer cache.
+
This function initiates an overlapped operation.
+
Example
+
+
+
+
smua.trigger.initiate()
+
+
+
Starts a preconfigured sweep and clears the event detectors for SMU channel A).
This attribute controls measurement actions during a sweep.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU reset Instrument reset Recall setup
+
+
Not saved
+
+
0 (smuX.DISABLE)
+
+
+
+
+
Usage
+
action = smuX.trigger.measure.action
+
smuX.trigger.measure.action = action
+
+
+
+
action
+
+
The sweep measure action; set to one of the following values:
+
0 or smuX.DISABLE: Do not make measurements during the sweep
+
1 or smuX.ENABLE: Make measurements during the sweep
+
2 or smuX.ASYNC: Make measurements during the sweep, but asynchronously
+
with the source area of the trigger model
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.trigger.measure.action applies to SMU channel A)
+
+
+
+
+
Details
+
With this attribute enabled (setting action to smuX.ENABLE or smuX.ASYNC), configure the measurement with one of the smuX.trigger.measure.Y() functions.
+
If this attribute is set to smuX.ASYNC:
+
Asynchronous sweep measurements can only be used with measure autoranging turned off. To turn measure autoranging off for all measurements during the sweep, set thesmuX.measure.autorangeY attribute to smuX.AUTORANGE_OFF.
If the integrating ADC is selected (smuX.measure.adc attribute is set to smuX.ADC_INTEGRATE), autozero must also be turned off. To turn off autozero, set the smuX.measure.autozero attribute to smuX.AUTOZERO_OFF or smuX.AUTOZERO_ONCE.
If either of the above items are incorrectly configured, the smuX.trigger.initiate() function will generate an error.
This function sets the measure event detector to the detected state.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
smuX.trigger.measure.set()
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.trigger.measure.set() applies to SMU channel A)
+
+
+
+
+
Details
+
This function is useful whenever you want the SMU to continue operation without waiting for a programmed trigger event. When called, this function immediately satisfies the event detector, allowing the SMU to continue through the trigger model.
+
A common example of when this function can be used is when you want the SMU to immediately perform an action the first time through the trigger model even if a programmed trigger event does not occur. Make sure that if the event detectors are configured to clear automatically (because the smuX.trigger.autoclear attribute is set to smuX.ENABLE) that this command is issued after the SMU has entered the trigger layer. This function can also be used to start actions on the SMU in case of a missed trigger event.
+
The SMU will automatically clear all event detectors when the smuX.trigger.initiate() function is executed. This function should be called after the sweep is initiated.
This attribute selects which event will cause the measure event detector to enter the detected state.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU reset Instrument reset Recall setup
+
+
Not saved
+
+
0
+
+
+
+
+
Usage
+
eventID = smuX.trigger.measure.stimulus
+
smuX.trigger.measure.stimulus = eventID
+
+
+
+
eventID
+
+
Event that triggers the measure detector
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.trigger.measure.stimulus applies to SMU channel A)
+
+
+
+
+
Details
+
Set this attribute to the event ID of any trigger event generator to wait for that event. When set, the SMU waits for the event at the measure event detector portion of the trigger model.
+
Set this attribute to zero to bypass waiting for an event (the SMU continues uninterrupted through the remote trigger model). Set eventID to one of the existing trigger event IDs shown in the following table.
+
+
+
+
+
+
+
Trigger event IDs*
+
+
+
+
Event ID
+
+
Event description
+
+
+
+
smua.trigger.SWEEPING_EVENT_ID
+
+
Occurs when the source‑measure unit (SMU) transitions from the idle state to the arm layer of the trigger model
+
+
+
+
smua.trigger.ARMED_EVENT_ID
+
+
Occurs when the SMU moves from the arm layer to the trigger layer of the trigger model
+
+
+
+
smua.trigger.SOURCE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a source action
+
+
+
+
smua.trigger.MEASURE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a measure action
+
+
+
+
smua.trigger.PULSE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a pulse
+
+
+
+
smua.trigger.SWEEP_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a sweep
+
+
+
+
smua.trigger.IDLE_EVENT_ID
+
+
Occurs when the SMU returns to the idle state
+
+
+
+
digio.trigger[N].EVENT_ID
+
+
Occurs when an edge is detected on a digital I/O line
+
+
+
+
tsplink.trigger[N].EVENT_ID
+
+
Occurs when an edge is detected on a TSP‑Link line
+
+
+
+
lan.trigger[N].EVENT_ID
+
+
Occurs when the appropriate LXI trigger packet is received on LAN trigger object N
+
+
+
+
display.trigger.EVENT_ID
+
+
Occurs when the TRIG key on the front panel is pressed
+
+
+
+
trigger.EVENT_ID
+
+
Occurs when a *TRG command is received on the remote interface
+
(GPIB only) Occurs when a GET bus command is received
+
(VXI-11 only) Occurs with the VXI-11 command device_trigger; reference the VXI-11 standard for additional details on the device trigger operation
+
+
+
+
trigger.blender[N].EVENT_ID
+
+
Occurs after a collection of events is detected
+
+
+
+
trigger.timer[N].EVENT_ID
+
+
Occurs when a delay expires
+
+
+
+
+
+
+
+
* Use the name of the trigger event ID to set the stimulus value rather than the numeric value. Using the name makes the code compatible for future upgrades (for example, if the numeric values must change when enhancements are added to the instrument).
This function configures the measurements to be made in a subsequent sweep.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
smuX.trigger.measure.Y(rbuffer)
+
smuX.trigger.measure.iv(ibuffer, vbuffer)
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)
+
+
+
+
Y
+
+
SMU measurement type (v = voltage, i = current, r = resistance, p = power)
+
+
+
+
rbuffer
+
+
A reading buffer object where the readings will be stored
+
+
+
+
ibuffer
+
+
A reading buffer object where current readings will be stored
+
+
+
+
vbuffer
+
+
A reading buffer object where voltage readings will be stored
+
+
+
+
+
Details
+
The measurements, as they are performed, are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings will be available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.
+
The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.
+
If a given reading buffer contains any data, it will be cleared prior to taking any measurements, unless the reading buffer has been configured to append data.
+
The SMU only retains the last call to any one of these functions and only that measure action will be performed.
+
After configuring the measurements to make with this function, remember to enable the measure action by setting smuX.trigger.measure.action = smuX.ENABLE.
+
Example
+
+
+
+
smua.trigger.measure.v(vbuffername)
+
smua.trigger.measure.action = smua.ENABLE
+
+
Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.
This constant contains the source complete event number.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Constant
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
eventID = smuX.trigger.SOURCE_COMPLETE_EVENT_ID
+
+
+
+
eventID
+
+
The source action complete event number
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.trigger.SOURCE_COMPLETE_EVENT_ID applies to SMU channel A)
+
+
+
+
+
Details
+
Set the stimulus of any trigger event detector to the value of this constant to have it respond to source complete events from this source‑measure unit (SMU).
This attribute enables or disables sweeping the source (on or off).
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU reset Instrument reset Recall setup
+
+
Not saved
+
+
0 (smuX.DISABLE)
+
+
+
+
+
Usage
+
action = smuX.trigger.source.action
+
smuX.trigger.source.action = action
+
+
+
+
action
+
+
Sweep source action. Set to one of the following values:
+
0 or smuX.DISABLE: Do not sweep the source
+
1 or smuX.ENABLE: Sweep the source
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.trigger.source.action applies to SMU channel A)
+
+
+
+
+
Details
+
This attribute is used to enable or disable source level changes during a sweep. In addition to enabling the action before initiating the sweep, make sure to configure it using smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY().
+
Example
+
+
+
+
smua.trigger.source.listv({3, 1, 4, 5, 2})
+
+
+
smua.trigger.source.action = smua.ENABLE
+
+
Configure list sweep for SMU channel A (sweep through
Source limit during triggered operation; set to the desired source limit during triggered operation, smuX.LIMIT_AUTO, or smuX.LIMIT_OFF (for smuX.trigger.source.limiti)
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.trigger.source.limitv applies to SMU channel A)
+
+
+
+
Y
+
+
SMU output function (v = voltage, i = current)
+
+
+
+
+
Details
+
Use this attribute to perform extended operating area (EOA) pulse mode sweeps.
+
If this attribute is set to smuX.LIMIT_AUTO (or 0), the SMU will use the normal limit setting during sweeping. If this attribute is set to any other numeric value, the SMU will switch in this limit at the start of the source action and will switch back to the normal limit setting at the end of the end pulse action.
+
Normally, the limit range is automatically adjusted in accordance with the desired limit value. During sweeping, however, the limit range is fixed in order to avoid the delays associated with changing range. This fixed limit range is determined by the maximum limit value needed during the sweep; that is, the greater of either the normal limit value (as specified by smuX.source.limitY) or the sweep limit value (as specified by smuX.trigger.source.limitY). Note that the minimum limit value that can be enforced during the sweep is equal to 10 percent of the full scale value of the fixed limit range. If the smaller limit value (normal or sweep) falls below this 10% threshold, the 10 percent value will be enforced instead. Likewise, if the limit value were to fall below the 10 percent threshold as a result of power compliance, the 10 percent value will be enforced instead.
+
To disable the source current limit during triggered operation, set the smuX.trigger.source.limiti attribute equal to smuX.LIMIT_OFF (or "off").
+
When using the EOA, the SMU will automatically start the end pulse action if the SMU is not triggered before its maximum pulse width. It will also delay the source action if necessary to limit the pulse duty cycle to stay within the capabilities of the SMU.
+
Example
+
+
+
+
smua.trigger.source.limitv = 10
+
+
Sets the voltage sweep limit of SMU channel A to 10 V.
Source‑measure unit (SMU) channel (for example, smua.trigger.source.linearv(0, 10, 11) applies to SMU channel A)
+
+
+
+
Y
+
+
SMU source function (v = voltage, i = current)
+
+
+
+
startValue
+
+
Source value of the first point
+
+
+
+
endValue
+
+
Source value of the last point
+
+
+
+
points
+
+
The number of points used to calculate the step size
+
+
+
+
+
Details
+
This function configures the source action to be a linear source sweep in a subsequent sweep. During the sweep, the source will generate a uniform series of ascending or descending voltage or current changes called steps. The number of source steps is one less than the number of sourced points.
+
The points parameter does not set the number of steps in a sweep, but rather is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source will restart at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU will satisfy the trigger count by restarting the sweep values from the beginning.
+
If the subsequent sweep has fewer points than specified in points, endValue will not be reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU will satisfy the trigger count and ignore the remaining source values.
+
In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep will return a stable value for the first measured point without penalizing remaining points in the sweep.
+
With linear sweeps it is acceptable to maintain a fixed source resolution over the entire sweep. To prevent source range changes during the sweep (especially when sweeping through 0.0), set the source range to a fixed range appropriate for the larger of either startValue or endValue.
+
The SMU will only store the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.
+
Source functions cannot be changed within a sweep.
+
After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.
+
Example
+
+
+
+
smua.trigger.source.linearv(0, 10, 11)
+
+
+
Sweeps SMU channel A from 0 V to 10 V in 1 V steps.
This function configures an array-based source sweep.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
smuX.trigger.source.listY(sweepList)
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.trigger.source.listv({5}) applies to SMU channel A)
+
+
+
+
Y
+
+
SMU source function (v = voltage, i = current)
+
+
+
+
sweepList
+
+
An array of source values
+
+
+
+
+
Details
+
This function configures the source action to be a list sweep in a subsequent sweep. During the sweep, the source will output the sequence of source values given in the sweepList array.
+
If the subsequent sweep has more points than specified in sweepList, the source will restart at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU will satisfy the trigger count by restarting the sweep values from the beginning.
+
If the subsequent sweep has fewer points than specified in sweepList, the extra values will be ignored. This means that if the trigger count is less than the number of source values configured, the SMU will satisfy the trigger count and ignore the remaining source values.
+
In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep will return a stable value for the first measured point without penalizing remaining points in the sweep.
+
The SMU will only store the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.
+
Source functions cannot be changed within a sweep.
+
After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.
+
Example
+
+
+
+
smua.trigger.source.listv({3, 1, 4, 5, 2})
+
+
+
Sweeps SMU channel A through 3 V, 1 V, 4 V, 5 V, and 2 V.
Source-measure unit (SMU) channel (for example, smua.trigger.source.logv(1, 10, 11, 0) applies to SMU channel A)
+
+
+
+
Y
+
+
SMU source function (v = voltage, i = current)
+
+
+
+
startValue
+
+
Source value of the first point
+
+
+
+
endValue
+
+
Source value of the last point
+
+
+
+
points
+
+
The number of points used to calculate the step size
+
+
+
+
asymptote
+
+
The asymptotic offset value
+
+
+
+
+
Details
+
This function configures the source action to be a geometric source sweep in a subsequent sweep. During the sweep, the source generates a geometric series of ascending or descending voltage or current changes called steps. Each step is larger or smaller than the previous step by a fixed proportion. The constant of proportionality is determined by the starting value, the ending value, the asymptote, and the number of steps in the sweep. The number of source steps is one less than the number of sourced points.
+
The points parameter does not set the number of steps in a sweep, but rather is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning.
+
If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.
+
In cases where the first sweep point is nonzero, it may be necessary to precharge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.
+
With logarithmic sweeps, it is usually necessary to allow the source to autorange to maintain good source accuracy when sweeping over more than one decade or across range boundaries.
+
The asymptote parameter can be used to customize the inflection and offset of the source value curve. This allows log sweeps to cross zero. Setting this parameter to zero provides a conventional logarithmic sweep. The asymptote value is the value that the curve has at either positive or negative infinity, depending on the direction of the sweep.
+
The asymptote value must not be equal to or between the starting and ending values. It must be outside the range defined by the starting and ending values.
+
The SMU stores only the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.
+
Source functions cannot be changed within a sweep.
+
After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.
+
Example
+
+
+
+
smua.trigger.source.logv(1, 10, 11, 0)
+
+
+
Sweeps SMU channel A from 1 V to 10 V in 10 steps with an asymptote of 0 V.
This function sets the source event detector to the detected state.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
smuX.trigger.source.set()
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.trigger.source.set() applies to SMU channel A)
+
+
+
+
+
Details
+
This function sets the source event detector to the detected state.
+
The SMU automatically clears all event detectors when the smuX.trigger.initiate() function is executed. This function should be called after the sweep is initiated. Make sure that if the event detectors are configured to clear automatically (because the smuX.trigger.autoclear attribute is set to smuX.ENABLE) that this command is issued after the SMU has entered the trigger layer.
This attribute defines which event causes the source event detector to enter the detected state.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU reset Instrument reset Recall setup
+
+
Not saved
+
+
0
+
+
+
+
+
Usage
+
eventID = smuX.trigger.source.stimulus
+
smuX.trigger.source.stimulus = eventID
+
+
+
+
eventID
+
+
Set to the event that triggers the end pulse source off action
+
+
+
+
X
+
+
Source‑measure (SMU) channel (for example, smua.trigger.source.stimulus applies to SMU channel A)
+
+
+
+
+
Details
+
Set this attribute to the event ID of any trigger event generator to wait for that event. When set, the SMU waits for the event at the source event detector portion of the trigger model. To bypass waiting for an event, set this attribute's value to zero (0). Set eventID to one of the existing trigger event IDs shown in the following table.
+
+
+
+
+
+
+
Trigger event IDs*
+
+
+
+
Event ID
+
+
Event description
+
+
+
+
smua.trigger.SWEEPING_EVENT_ID
+
+
Occurs when the source‑measure unit (SMU) transitions from the idle state to the arm layer of the trigger model
+
+
+
+
smua.trigger.ARMED_EVENT_ID
+
+
Occurs when the SMU moves from the arm layer to the trigger layer of the trigger model
+
+
+
+
smua.trigger.SOURCE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a source action
+
+
+
+
smua.trigger.MEASURE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a measure action
+
+
+
+
smua.trigger.PULSE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a pulse
+
+
+
+
smua.trigger.SWEEP_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a sweep
+
+
+
+
smua.trigger.IDLE_EVENT_ID
+
+
Occurs when the SMU returns to the idle state
+
+
+
+
digio.trigger[N].EVENT_ID
+
+
Occurs when an edge is detected on a digital I/O line
+
+
+
+
tsplink.trigger[N].EVENT_ID
+
+
Occurs when an edge is detected on a TSP‑Link line
+
+
+
+
lan.trigger[N].EVENT_ID
+
+
Occurs when the appropriate LXI trigger packet is received on LAN trigger object N
+
+
+
+
display.trigger.EVENT_ID
+
+
Occurs when the TRIG key on the front panel is pressed
+
+
+
+
trigger.EVENT_ID
+
+
Occurs when a *TRG command is received on the remote interface
+
(GPIB only) Occurs when a GET bus command is received
+
(VXI-11 only) Occurs with the VXI-11 command device_trigger; reference the VXI-11 standard for additional details on the device trigger operation
+
+
+
+
trigger.blender[N].EVENT_ID
+
+
Occurs after a collection of events is detected
+
+
+
+
trigger.timer[N].EVENT_ID
+
+
Occurs when a delay expires
+
+
+
+
+
+
+
+
* Use the name of the trigger event ID to set the stimulus value rather than the numeric value. Using the name makes the code compatible for future upgrades (for example, if the numeric values must change when enhancements are added to the instrument).
This function loads and runs a script on a remote TSP-enabled instrument.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
tspnet.tsp.runscript(connectionID, script)
+
tspnet.tsp.runscript(connectionID, name, script)
+
+
+
+
connectionID
+
+
Integer value used as an identifier for other tspnet commands
+
+
+
+
name
+
+
The name that is assigned to the script
+
+
+
+
script
+
+
The body of the script as a string
+
+
+
+
+
Details
+
This function is appropriate only for TSP-enabled instruments.
+
This function downloads a script to a remote instrument and runs it. It automatically adds the appropriate loadscript and endscript commands around the script, captures any errors, and reads back any prompts. No additional substitutions are done on the text.
+
The script is automatically loaded, compiled, and run.
+
Any output from previous commands is discarded.
+
This command does not wait for the script to complete.
+
If you do not want the script to do anything immediately, make sure the script only defines functions for later use. Use the tspnet.execute() function to execute those functions at a later time.
+
If no name is specified, the script will be loaded as the anonymous script.
+
Example
+
+
+
+
tspnet.tsp.runscript(myconnection, "mytest",
+
"print([[start]]) for d = 1, 10 do print([[work]]) end print([[end]])")
+
+
+
+
Load and run a script entitled mytest on the TSP‑enabled instrument connected with myconnection.
This attribute is the group number of a TSP‑Link node.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Not applicable
+
+
Not saved
+
+
0
+
+
+
+
+
Usage
+
groupNumber = tsplink.group
+
tsplink.group = groupNumber
+
+
+
+
groupNumber
+
+
The group number of the TSP-Link node (0 to 64)
+
+
+
+
+
Details
+
To remove the node from all groups, set the attribute value to 0.
+
When the node is turned off, the group number for that node changes to 0.
+
The master node can be assigned to any group. You can also include other nodes in the group that includes the master. Note that any nodes that are set to 0 are automatically included in the group that contains the master node, regardless of the group that is assigned to the master node.
+
Example
+
+
+
+
tsplink.group = 3
+
+
Assign the instrument to TSP-Link group number 3.
+
+
+
+
+
Also see
+
Using groups to manage nodes on TSP-Link network
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This attribute reads the node number assigned to the master node.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Not applicable
+
+
Not applicable
+
+
Not applicable
+
+
+
+
+
Usage
+
masterNodeNumber = tsplink.master
+
+
+
+
masterNodeNumber
+
+
The node number of the master node
+
+
+
+
+
Details
+
After doing a TSP-Link reset (tsplink.reset()), use this attribute to access the node number of the master in a set of instruments connected over TSP-Link.
+
Example
+
+
+
+
LinkMaster = tsplink.master
+
+
Store the TSP-Link master node number in a variable called LinkMaster.
This function reads the TSP-Link® synchronization lines as a digital I/O port.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
data = tsplink.readport()
+
+
+
+
data
+
+
Numeric value returned indicating which register bits are set
+
+
+
+
+
Details
+
The binary equivalent of the returned value indicates the input pattern on the I/O port. The least significant bit of the binary number corresponds to line 1 and bit B3 corresponds to line 3. For example, a returned value of 2 has a binary equivalent of 010. Line 2 is high (1), and the other 2 lines are low (0).
This function initializes (resets) all nodes (instruments) in the TSP‑Link system.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
nodesFound = tsplink.reset()
+
nodesFound = tsplink.reset(expectedNodes)
+
+
+
+
nodesFound
+
+
The number of nodes actually found on the system
+
+
+
+
expectedNodes
+
+
The number of nodes expected on the system (1 to 64)
+
+
+
+
+
Details
+
This function erases all knowledge of other nodes connected on the TSP-Link system and regenerates the system configuration. This function must be called at least once before any remote nodes can be accessed. If the node number for any instrument is changed, the TSP-Link nodes must be initialized again.
+
If expectedNodes is not given, this function generates an error if no other nodes are found on the TSP‑Link network.
+
If nodesFound is less than expectedNodes, an error is generated. Note that the node on which the command is running is counted as a node. For example, giving an expected node count of 1 will not generate any errors, even if there are no other nodes on the TSP-Link network.
+
Also returns the number of nodes found.
+
Example
+
+
+
+
nodesFound = tsplink.reset(2)
+
print("Nodes found = " .. nodesFound)
+
+
Perform a TSP-Link reset and indicate how many nodes are found.
+
Sample output if found 2 nodes: Nodes found = 2
+
Sample output if fewer nodes are found and if localnode.showerrors = 1: 1219, TSP-Link found fewer nodes than expected Nodes found = 1
This function clears the event detector for a trigger.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
tsplink.trigger[N].clear()
+
+
+
+
N
+
+
The trigger line (1 to 3)
+
+
+
+
+
Details
+
The event detector for a trigger recalls if a trigger event has been detected since the last tsplink.trigger[N].wait() call. This function clears a trigger event detector, discards the previous history of the trigger line, and clears the tsplink.trigger[N].overrun attribute.
This attribute defines the trigger operation and detection mode.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset Recall setup TSP-Link trigger N reset
+
+
Not saved
+
+
0 (tsplink.TRIG_BYPASS)
+
+
+
+
+
Usage
+
mode = tsplink.trigger[N].mode
+
tsplink.trigger[N].mode = mode
+
+
+
+
mode
+
+
The trigger mode
+
+
+
+
N
+
+
The trigger line (1 to 3)
+
+
+
+
+
Details
+
This attribute controls the mode in which the trigger event detector and the output trigger generator operate on the given trigger line.
+
The setting for mode can be one of the following values:
+
+
+
+
Mode
+
+
Number value
+
+
Description
+
+
+
+
tsplink.TRIG_BYPASS
+
+
0
+
+
Allows direct control of the line as a digital I/O line.
+
+
+
+
tsplink.TRIG_FALLING
+
+
1
+
+
Detects falling‑edge triggers as input. Asserts a TTL-low pulse for output.
+
+
+
+
tsplink.TRIG_RISING
+
+
2
+
+
If the programmed state of the line is high, the tsplink.TRIG_RISING mode behaves similar to tsplink.TRIG_RISINGA. If the programmed state of the line is low, the tsplink.TRIG_RISING mode behaves similar to tsplink.TRIG_RISINGM. Use tsplink.TRIG_RISINGA if the line is in the high output state. Use tsplink.TRIG_RISINGM if the line is in the low output state.
+
+
+
+
tsplink.TRIG_EITHER
+
+
3
+
+
Detects rising‑ or falling‑edge triggers as input. Asserts a TTL‑low pulse for output.
+
+
+
+
tsplink.TRIG_SYNCHRONOUSA
+
+
4
+
+
Detects the falling‑edge input triggers and automatically latches and drives the trigger line low.
+
+
+
+
tsplink.TRIG_SYNCHRONOUS
+
+
5
+
+
Detects the falling‑edge input triggers and automatically latches and drives the trigger line low. Asserts a TTL-low pulse as an output trigger.
+
+
+
+
tsplink.TRIG_SYNCHRONOUSM
+
+
6
+
+
Detects rising‑edge triggers as an input. Asserts a TTL‑low pulse for output.
+
+
+
+
tsplink.TRIG_RISINGA
+
+
7
+
+
Detects rising‑edge triggers as input. Asserts a TTL‑low pulse for output.
+
+
+
+
tsplink.TRIG_RISINGM
+
+
8
+
+
Edge detection as an input is not available. Generates a TTL‑high pulse as an output trigger.
+
+
+
+
+
+
When programmed to any other mode, the output state of the I/O line is controlled by the trigger logic, and the user-specified output state of the line is ignored.
+
When the trigger mode is set to tsplink.TRIG_RISING, the user‑specified output state of the line will be examined. If the output state selected when the mode is changed is high, the actual mode used will be tsplink.TRIG_RISINGA. If the output state selected when the mode is changed is low, the actual mode used will be tsplink.TRIG_RISINGM.
+
The custom variable mode stores the trigger mode as a numeric value when the attribute is read.
+
To control the line state, use the tsplink.TRIG_BYPASS mode with the tsplink.writebit() and the tsplink.writeport() commands.
+
Example
+
+
+
+
tsplink.trigger[3].mode = tsplink.TRIG_RISINGM
+
+
Sets the trigger mode for synchronization line 3 to tsplink.TRIG_RISINGM.
This function releases a latched trigger on the given TSP‑Link trigger line.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
tsplink.trigger[N].release()
+
+
+
+
N
+
+
The trigger line (1 to 3)
+
+
+
+
+
Details
+
Releases a trigger that was asserted with an indefinite pulse width, as well as a trigger that was latched in response to receiving a synchronous mode trigger.
Trigger detection indication; set to one of the following values:
+
true: A trigger is detected during the timeout period
+
false: A trigger is not detected during the timeout period
+
+
+
+
N
+
+
The trigger line (1 to 3)
+
+
+
+
timeout
+
+
The timeout value in seconds
+
+
+
+
+
Details
+
This function waits up to the timeout value for an input trigger. If one or more trigger events were detected since the last time tsplink.trigger[N].wait() or tsplink.trigger[N].clear() was called, this function returns immediately.
+
After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.
+
Example
+
+
+
+
triggered = tsplink.trigger[3].wait(10)
+
print(triggered)
+
+
+
Waits up to 10 seconds for a trigger on TSP-Link® line 3.
+
If false is returned, no trigger was detected during the 10-second timeout.
This function writes to all TSP‑Link synchronization lines.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
tsplink.writeport(data)
+
+
+
+
data
+
+
Value to write to the port (0 to 7)
+
+
+
+
+
Details
+
The binary representation of data indicates the output pattern that is written to the I/O port. For example, a data value of 2 has a binary equivalent of 010. Line 2 is set high (1), and the other two lines are set low (0).
+
Write‑protected lines are not changed.
+
The reset() function does not affect the present states of the trigger lines.
+
Use the tsplink.writebit() and tsplink.writeport() commands to control the output state of the synchronization line when trigger operation is set to tsplink.TRIG_BYPASS.
+
Example
+
+
+
+
tsplink.writeport(3)
+
+
Sets the synchronization lines 1 and 2 high (binary 011).
Carefully consider and configure the appropriate output-off state, source, and compliance levels before connecting the Model 2651A to a device that can deliver energy (for example, other voltage sources, batteries, capacitors, solar cells, or other Model 2651A instruments ). Program recommended instrument settings before making connections to the device. Failure to consider the output-off state, source, and compliance levels may result in damage to the instrument or to the device under test (DUT).
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This attribute selects whether the blender operates in OR mode or AND mode.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset Trigger blender N reset Recall setup
+
+
Not saved
+
+
false (AND mode)
+
+
+
+
+
Usage
+
orenable = trigger.blender[N].orenable
+
trigger.blender[N].orenable = orenable
+
+
+
+
orenable
+
+
The orenable mode:
+
true: OR mode
false: AND mode
+
+
+
N
+
+
The trigger blender (1 to 4)
+
+
+
+
+
Details
+
This attribute selects whether the blender waits for any one event (the “OR” mode) or waits for all selected events (the “AND” mode) before signaling an output event.
This attribute indicates whether or not an event was ignored because of the event detector state.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Instrument reset Trigger blender N clear Trigger blender N reset
+
+
Not applicable
+
+
Not applicable
+
+
+
+
+
Usage
+
overrun = trigger.blender[N].overrun
+
+
+
+
overrun
+
+
Trigger blender overrun state
+
+
+
+
N
+
+
The trigger event blender (1 to 4)
+
+
+
+
+
Details
+
Indicates if an event was ignored because the event detector was already in the detected state when the event occurred. This is an indication of the state of the event detector that is built into the event blender itself.
+
This attribute does not indicate if an overrun occurred in any other part of the trigger model or in any other trigger object that is monitoring the event. It also is not an indication of an action overrun.
This function waits for a blender trigger event to occur.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
triggered = trigger.blender[N].wait(timeout)
+
+
+
+
triggered
+
+
Trigger detection indication for blender
+
+
+
+
N
+
+
The trigger blender (1 to 4) on which to wait
+
+
+
+
timeout
+
+
Maximum amount of time in seconds to wait for the trigger blender event
+
+
+
+
+
Details
+
This function waits for an event blender trigger event. If one or more trigger events were detected since the last time trigger.blender[N].wait() or trigger.blender[N].clear() was called, this function returns immediately.
+
After detecting a trigger with this function, the event detector automatically resets and rearms. This is true regardless of the number of events detected.
This function clears the command interface trigger event detector.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
trigger.clear()
+
Details
+
The trigger event detector indicates if an event has been detected since the last trigger.wait() call. This function clears the trigger's event detector and discards the previous history of command interface trigger events.
This attribute indicates if an event was ignored because of the event detector state.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Instrument reset Recall setup Trigger timer N clear Trigger timer N reset
+
+
Not applicable
+
+
false
+
+
+
+
+
Usage
+
overrun = trigger.timer[N].overrun
+
+
+
+
overrun
+
+
Trigger overrun state
+
+
+
+
N
+
+
Trigger timer number (1 to 4)
+
+
+
+
+
Details
+
This attribute indicates if an event was ignored because the event detector was already in the detected state when the event occurred.
+
This is an indication of the state of the event detector built into the timer itself. It does not indicate if an overrun occurred in any other part of the trigger model or in any other construct that is monitoring the delay completion event. It also is not an indication of a delay overrun.
+
Example
+
+
+
+
print(trigger.timer[1].overrun)
+
+
If an event was ignored, the output is true.
+
If the event was not ignored, the output is false.
Maximum amount of time in seconds to wait for the trigger
+
+
+
+
+
Details
+
If one or more trigger events were detected since the last time trigger.timer[N].wait() or trigger.timer[N].clear() was called, this function returns immediately.
+
After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.
+
Example
+
+
+
+
triggered = trigger.timer[3].wait(10)
+
print(triggered)
+
+
Waits up to 10 seconds for a trigger on timer 3.
+
If false is returned, no trigger was detected during the 10-second timeout.
This function waits for a command interface trigger event.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
triggered = trigger.wait(timeout)
+
+
+
+
triggered
+
+
true: A trigger was detected during the timeout period
+
false: No triggers were detected during the timeout period
+
+
+
+
timeout
+
+
Maximum amount of time in seconds to wait for the trigger
+
+
+
+
+
Details
+
This function waits up to timeout seconds for a trigger on the active command interface. A command interface trigger occurs when:
+
A GPIB GET command is detected (GPIB only)
A VXI-11 device_trigger method is invoked (VXI-11 only)
A *TRG message is received
If one or more of these trigger events were previously detected, this function returns immediately.
+
After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.
+
Example
+
+
+
+
triggered = trigger.wait(10)
+
print(triggered)
+
+
Waits up to 10 seconds for a trigger.
+
If false is returned, no trigger was detected during the 10‑second timeout.
This attribute stores the status byte condition register.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Not applicable
+
+
Not saved
+
+
Not applicable
+
+
+
+
+
Usage
+
statusByte = status.condition
+
+
+
+
statusByte
+
+
The status byte; a zero (0) indicates no bits set; other values indicate various bit settings
+
+
+
+
+
Details
+
This attribute is used to read the status byte, which is returned as a numeric value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000 0001. This value indicates that bit B0 and bit B7 are set.
+
+
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
+
+
+
* Least significant bit ** Most significant bit
+
The returned value can indicate one or more status events occurred. When an enabled status event occurs, a summary bit is set in this register to indicate the event occurrence.
+
The individual bits of this register have the following meanings:
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
status.MEASUREMENT_SUMMARY_BIT
+
status.MSB
+
+
Set summary bit indicates that an enabled measurement event has occurred.
+
Bit B0 decimal value: 1
+
+
+
+
B1
+
+
status.SYSTEM_SUMMARY_BIT
+
status.SSB
+
+
Set summary bit indicates that an enabled system event has occurred.
+
Bit B1 decimal value: 2
+
+
+
+
B2
+
+
status.ERROR_AVAILABLE
+
status.EAV
+
+
Set summary bit indicates that an error or status message is present in the Error Queue.
+
Bit B2 decimal value: 4
+
+
+
+
B3
+
+
status.QUESTIONABLE_SUMMARY_BIT
+
status.QSB
+
+
Set summary bit indicates that an enabled questionable event has occurred.
+
Bit B3 decimal value: 8
+
+
+
+
B4
+
+
status.MESSAGE_AVAILABLE
+
status.MAV
+
+
Set summary bit indicates that a response message is present in the Output Queue.
+
Bit B4 decimal value: 16
+
+
+
+
B5
+
+
status.EVENT_SUMMARY_BIT
+
status.ESB
+
+
Set summary bit indicates that an enabled standard event has occurred.
+
Bit B5 decimal value: 32
+
+
+
+
B6
+
+
status.MASTER_SUMMARY_STATUS
+
status.MSS
+
+
Request Service (RQS)/Master Summary Status (MSS). Depending on how it is used, bit B6 of the status byte register is either the Request for Service (RQS) bit or the Master Summary Status (MSS) bit:
+
When using the GPIB or VXI-11 serial poll sequence of the Model 2651A to obtain the status byte (serial poll byte), B6 is the RQS bit. The set bit indicates that the Request Service (RQS) bit of the status byte (serial poll byte) is set and a serial poll (SRQ) has occurred.
When using the status.condition register command or the *STB? common command to read the status byte, B6 is the MSS bit. Set bit indicates that an enabled summary bit of the status byte register is set.
Bit B6 decimal value: 64
+
+
+
+
B7
+
+
status.OPERATION_SUMMARY_BIT
+
status.OSB
+
+
Set summary bit indicates that an enabled operation event has occurred.
+
Bit B7 decimal value: 128
+
+
+
+
+
In addition to the above constants, when more than one bit of the register is set, statusByte equals the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).
+
+
+
+
Bit
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
128
+
+
64
+
+
32
+
+
16
+
+
8
+
+
4
+
+
2
+
+
1
+
+
+
+
Weights
+
+
(27)
+
+
(26)
+
+
(25)
+
+
(24)
+
+
(23)
+
+
(22)
+
+
(21)
+
+
(20)
+
+
+
+
+
Example
+
+
+
+
statusByte = status.condition
+
print(statusByte)
+
+
Returns statusByte.
+
Sample output:
+
1.29000e+02
+
Converting this output (129) to its binary equivalent yields 1000 0001
+
Therefore, this output indicates that the set bits of the status byte condition register are presently B0 (MSS) and B7 (OSB).
The measurement event register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
+
Details
+
These attributes read or write the measurement event registers.
+
Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.
+
For example, assume value 257 is returned for the enable register. The binary equivalent is 0000 0001 0000 0001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
+
+
+
* Least significant bit ** Most significant bit
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
Set bit indicates that a bit in the measurement instrument summary register is set.
+
Bit B13 decimal value: 8192
+
+
+
+
B14-B15
+
+
Not used
+
+
Not applicable
+
+
+
+
+
As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV.
+
In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).
The measurement event register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 2
+
+
+
+
+
Details
+
These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000 0000 0000 0010. This value indicates that bit B1 (SMUA) is set.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
Not used
+
+
Not applicable.
+
+
+
+
B1
+
+
status.measurement.buffer_available.SMUA
+
+
Set bit indicates that there is at least one reading stored in either or both of the dedicated reading buffers.
+
Bit B1 decimal value: 2
+
Binary value: 0000 0010
+
+
+
+
B2-B15
+
+
Not used
+
+
Not applicable.
+
+
+
+
+
As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.
+
In addition to the above constant, measurementRegister can be set to the decimal equivalent of the bit to set.
+
Example
+
+
+
+
status.measurement.buffer_available.enable =
+
status.measurement.buffer_available.SMUA
+
+
+
Sets the SMUA bit of the measurement event buffer available summary enable register.
The measurement event current limit summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 2
+
+
+
+
+
Details
+
These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000 0000 0000 0010. This value indicates that bit B1 (SMUA) is set.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
Not used
+
+
Not applicable.
+
+
+
+
B1
+
+
status.measurement.current_limit.SMUA
+
+
Set bit indicates that the current limit was exceeded.
+
Bit B1 decimal value: 2
+
Binary value: 0000 0010
+
+
+
+
B2-B15
+
+
Not used
+
+
Not applicable.
+
+
+
+
+
As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.
+
In addition to the above constant, measurementRegister can be set to the decimal equivalent of the bit to set.
+
Example
+
+
+
+
status.measurement.current_limit.enable =
+
status.measurement.current_limit.SMUA
+
+
Sets the SMUA bit of the measurement event current limit summary enable register.
The measurement event instrument summary register status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
+
Details
+
These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000 0000 0000 0010. This value indicates that bit B1 (SMUA) is set.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
Not used
+
+
Not applicable.
+
+
+
+
B1
+
+
status.measurement.instrument.SMUA
+
+
Set bit indicates one or more enabled bits of the measurement event SMU A summary register is set.
+
Bit B1 decimal value: 2
+
Binary value: 0000 0010
+
+
+
+
B2-B15
+
+
Not used
+
+
Not applicable.
+
+
+
+
+
As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.
+
In addition to the above constant, measurementRegister can be set to the decimal equivalent of the bit to set.
+
Example
+
+
+
+
status.measurement.instrument.enable =
+
status.measurement.instrument.SMUA
+
+
Sets the SMU A bit of the measurement event instrument summary enable register using a constant.
The instrument measurement status SMU X summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
X
+
+
Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)
+
+
+
+
+
Details
+
These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000 0001 0000 0001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
+
+
+
* Least significant bit ** Most significant bit
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
+
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0*
+
+
status.measurement.instrument.smuX.VOLTAGE_LIMIT
+
status.measurement.instrument.smuX.VLMT
+
+
Set bit indicates that the voltage limit was exceeded.
+
Bit B0 decimal value: 1
+
+
+
+
B1*
+
+
status.measurement.instrument.smuX.CURRENT_LIMIT
+
status.measurement.instrument.smuX.ILMT
+
+
Set bit indicates that the current limit was exceeded.
Set bit indicates that there is at least one reading stored in either or both of the dedicated reading buffers.
+
Bit B8 decimal value: 256
+
+
+
+
B9-B15
+
+
Not used
+
+
Not applicable.
+
+
+
+
* This bit will be updated only when a measurement is taken or smuX.source.compliance is invoked.
+
+
+
+
+
As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable= status.measurement.instrument.smua.VLMT.
+
In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).
+
+
+
+
Bit
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
128
+
+
64
+
+
32
+
+
16
+
+
8
+
+
4
+
+
2
+
+
1
+
+
+
+
Weights
+
+
(27)
+
+
(26)
+
+
(25)
+
+
(24)
+
+
(23)
+
+
(22)
+
+
(21)
+
+
(20)
+
+
+
+
+
+
+
+
Bit
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
32,768
+
+
16,384
+
+
8,192
+
+
4,096
+
+
2,048
+
+
1024
+
+
512
+
+
256
+
+
+
+
Weights
+
+
(215)
+
+
(214)
+
+
(213)
+
+
(212)
+
+
(211)
+
+
(210)
+
+
(29)
+
+
(28)
+
+
+
+
+
Example
+
+
+
+
status.measurement.instrument.smua.enable =
+
status.measurement.instrument.smua.VLMT
+
+
Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.
The measurement reading overflow summary register status. A zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 2
+
+
+
+
+
Details
+
These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000 0000 0000 0010. This value indicates that bit B1 (SMUA) is set.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
Not used
+
+
Not applicable.
+
+
+
+
B1
+
+
status.measurement.reading_overflow.SMUA
+
+
Set bit indicates that an overflow reading has been detected.
+
Bit B1 decimal value: 2
+
Binary value: 0000 0010
+
+
+
+
B2-B15
+
+
Not used
+
+
Not applicable.
+
+
+
+
+
As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.
+
In addition to the above constant, measurementRegister can be set to the numeric equivalent of the bit to set.
+
Example
+
+
+
+
status.measurement.reading_overflow.enable =
+
status.measurement.reading_overflow.SMUA
+
+
Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.
The measurement voltage limit summary register status. A zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 2
+
+
+
+
+
Details
+
These attributes are used to read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
Not used
+
+
Not applicable.
+
+
+
+
B1
+
+
status.measurement.voltage_limit.SMUA
+
+
Set bit indicates that the voltage limit was exceeded.
+
Bit B1 decimal value: 2
+
Binary value: 0000 0010
+
+
+
+
B2-B15
+
+
Not used
+
+
Not applicable.
+
+
+
+
+
As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.
+
In addition to the above constant, measurementRegister can be set to the numeric equivalent of the bit to set.
+
Example
+
+
+
+
status.measurement.voltage_limit.enable =
+
status.measurement.voltage_limit.SMUA
+
+
Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.
This attribute stores the system node enable register.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
+
Usage
+
nodeEnableRegister = status.node_enable
+
status.node_enable = nodeEnableRegister
+
+
+
+
nodeEnableRegister
+
+
The system node enable register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
+
Details
+
This attribute is used to read or write to the system node enable register. Reading the system node enable register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, assume the value of 1.29000e+02 (which is 129) is returned for the system node enable register, the binary equivalent is 1000 0001. This value indicates that bit B0 and bit B7 are set.
+
+
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
**
+
+
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
+
+
+
* Least significant bit ** Most significant bit
+
Assigning a value to this attribute enables one or more status events. When an enabled status event occurs, a summary bit is set in the appropriate system summary register. The register and bit that is set depends on the TSP-Link node number assigned to this instrument.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
status.MEASUREMENT_SUMMARY_BIT status.MSB
+
+
Set summary bit indicates that an enabled measurement event has occurred.
+
Bit B0 decimal value: 1
+
+
+
+
B1
+
+
Not used
+
+
Not applicable.
+
+
+
+
B2
+
+
status.ERROR_AVAILABLE status.EAV
+
+
Set summary bit indicates that an error or status message is present in the Error Queue.
+
Bit B2 decimal value: 4
+
+
+
+
B3
+
+
status.QUESTIONABLE_SUMMARY_BIT status.QSB
+
+
Set summary bit indicates that an enabled questionable event has occurred.
+
Bit B3 decimal value: 8
+
+
+
+
B4
+
+
status.MESSAGE_AVAILABLE status.MAV
+
+
Set summary bit indicates that a response message is present in the Output Queue.
+
Bit B4 decimal value: 16
+
+
+
+
B5
+
+
status.EVENT_SUMMARY_BIT status.ESB
+
+
Set summary bit indicates that an enabled standard event has occurred.
+
Bit B5 decimal value: 32
+
+
+
+
B6
+
+
status.MASTER_SUMMARY_STATUS status.MSS
+
+
Set bit indicates that an enabled Master Summary Status (MSS) bit of the Status Byte Register is set.
+
Bit B6 decimal value: 64
+
+
+
+
B7
+
+
status.OPERATION_SUMMARY_BIT status.OSB
+
+
Set summary bit indicates that an enabled operation event has occurred.
+
Bit B7 decimal value: 128
+
+
+
+
+
As an example, to set the B0 bit of the system node enable register, set status.node_enable = status.MSB.
+
In addition to the above values, nodeEnableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set nodeEnableRegister to the sum of their decimal weights. For example, to set bits B0 and B7, set nodeEnableRegister to 129 (1 + 128).
+
+
+
+
Bit
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
128
+
+
64
+
+
32
+
+
16
+
+
8
+
+
4
+
+
2
+
+
1
+
+
+
+
Weights
+
+
(27)
+
+
(26)
+
+
(25)
+
+
(24)
+
+
(23)
+
+
(22)
+
+
(21)
+
+
(20)
+
+
+
+
+
Example 1
+
+
+
+
nodeEnableRegister = status.MSB + status.OSB
+
status.node_enable = nodeEnableRegister
+
+
Sets the MSB and OSB bits of the system node enable register using constants.
+
+
+
+
+
Example 2
+
+
+
+
-- decimal 129 = binary 10000001
+
nodeEnableRegister = 129
+
status.node_enable = nodeEnableRegister
+
+
Sets the MSB and OSB bits of the system node enable register using a decimal value.
This attribute stores the status node event register.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Not applicable
+
+
Not saved
+
+
0
+
+
+
+
+
Usage
+
nodeEventRegister = status.node_event
+
+
+
+
nodeEventRegister
+
+
The node event register's status; a zero (0) indicates no bits set; other values indicate various bit settings
+
+
+
+
+
Details
+
This attribute is used to read the status node event register, which is returned as a numeric value (reading this register returns a value). The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000 0001. This value indicates that bit B0 and bit B7 are set.
+
+
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
+
+
+
* Least significant bit ** Most significant bit
+
The returned value can indicate one or more status events occurred.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
status.MEASUREMENT_SUMMARY_BIT status.MSB
+
+
Set summary bit indicates that an enabled measurement event has occurred.
+
Bit B0 decimal value: 1
+
+
+
+
B1
+
+
Not used
+
+
Not applicable
+
+
+
+
B2
+
+
status.ERROR_AVAILABLE status.EAV
+
+
Set summary bit indicates that an error or status message is present in the Error Queue.
+
Bit B2 decimal value: 4
+
+
+
+
B3
+
+
status.QUESTIONABLE_SUMMARY_BIT status.QSB
+
+
Set summary bit indicates that an enabled questionable event has occurred.
+
Bit B3 decimal value: 8
+
+
+
+
B4
+
+
status.MESSAGE_AVAILABLE status.MAV
+
+
Set summary bit indicates that a response message is present in the Output Queue.
+
Bit B4 decimal value: 16
+
+
+
+
B5
+
+
status.EVENT_SUMMARY_BIT status.ESB
+
+
Set summary bit indicates that an enabled standard event has occurred.
+
Bit B5 decimal value: 32
+
+
+
+
B6
+
+
status.MASTER_SUMMARY_STATUS status.MSS
+
+
Set bit indicates that an enabled Master Summary Status (MSS) bit of the Status Byte register is set.
+
Bit B6 decimal value: 64
+
+
+
+
B7
+
+
status.OPERATION_SUMMARY_BIT status.OSB
+
+
Set summary bit indicates that an enabled operation event has occurred.
+
Bit B7 decimal value: 128
+
+
+
+
+
+
In addition to the above constants, nodeEventRegister can be set to the decimal equivalent of the bit(s) set. When more than one bit of the register is set, nodeEventRegister contains the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).
+
+
+
+
Bit
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
128
+
+
64
+
+
32
+
+
16
+
+
8
+
+
4
+
+
2
+
+
1
+
+
+
+
Weights
+
+
(27)
+
+
(26)
+
+
(25)
+
+
(24)
+
+
(23)
+
+
(22)
+
+
(21)
+
+
(20)
+
+
+
+
+
Example
+
+
+
+
nodeEventRegister = status.node_event
+
print(nodeEventRegister)
+
+
Reads the status node event register.
+
Sample output:
+
1.29000e+02
+
Converting this output (129) to its binary equivalent yields 1000 0001
+
Therefore, this output indicates that the set bits of the status byte condition register are presently B0 (MSB) and B7 (OSB).
These attributes manage the status model's operation status register set.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute
+
+
- -
+
+
- -
+
+
- -
+
+
- -
+
+
+
+
.condition (R)
+
+
Yes
+
+
Not applicable
+
+
Not saved
+
+
Not applicable
+
+
+
+
.enable (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.event (R)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.ntr (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.ptr (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
31,769 (All bits set)
+
+
+
+
+
Usage
+
operationRegister = status.operation.condition
+
operationRegister = status.operation.enable
+
operationRegister = status.operation.event
+
operationRegister = status.operation.ntr
+
operationRegister = status.operation.ptr
+
status.operation.enable = operationRegister
+
status.operation.ntr = operationRegister
+
status.operation.ptr = operationRegister
+
+
+
+
operationRegister
+
+
The operation status register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
+
Details
+
These attributes read or write the operation status registers.
+
Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101 0000 0000 0000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
1
+
+
0
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
+
+
+
* Least significant bit ** Most significant bit
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
status.operation.CALIBRATING
+
status.operation.CAL
+
+
Set bit indicates that the summary bit of the status.operation.calibrating register has been set.
+
Bit B0 decimal value: 1
+
+
+
+
B1-B2
+
+
Not used
+
+
Not applicable
+
+
+
+
B3
+
+
status.operation.SWEEPING
+
status.operation.SWE
+
+
Set bit indicates that the summary bit from the status.operation.sweeping register is set.
+
Bit B3 decimal value: 8
+
+
+
+
B4
+
+
status.operation.MEASURING
+
status.operation.MEAS
+
+
Set bit indicates that the summary bit of the status.operation.measuring register is set.
+
Bit B4 decimal value: 16
+
+
+
+
B5-B9
+
+
Not used
+
+
Not applicable
+
+
+
+
B10
+
+
status.operation.TRIGGER_OVERRUN
+
status.operation.TRGOVR
+
+
Set bit indicates that the summary bit from the
+
status.operation.trigger_overrun register is set.
+
Bit B10 decimal value: 1024
+
+
+
+
B11
+
+
status.operation.REMOTE_SUMMARY
+
status.operation.REM
+
+
Set bit indicates that the summary bit of the status.operation.remote register is set.
+
Bit B11 decimal value: 2048
+
+
+
+
B12
+
+
status.operation.USER
+
+
Set bit indicates that the summary bit from the status.operation.user register is set.
+
Bit B12 decimal value: 4096
+
+
+
+
B13
+
+
status.operation.INSTRUMENT_SUMMARY
+
status.operation.INST
+
+
Set bit indicates that the summary bit from the status.operation.instrument register is set.
+
Bit B13 decimal value: 8192
+
+
+
+
B14
+
+
status.operation.ROGRAM_RUNNING
+
status.operation.PROG
+
+
Set bit indicates that a command or program is running.
+
Bit B14 decimal value: 16,384
+
+
+
+
B15
+
+
Not used
+
+
Not applicable
+
+
+
+
+
As an example, to set bit B12 of the operation status enable register, set status.operation.enable= status.operation.USER.
+
In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4096 + 16,384).
+
+
+
+
Bit
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
128
+
+
64
+
+
32
+
+
16
+
+
8
+
+
4
+
+
2
+
+
1
+
+
+
+
Weights
+
+
(27)
+
+
(26)
+
+
(25)
+
+
(24)
+
+
(23)
+
+
(22)
+
+
(21)
+
+
(20)
+
+
+
+
+
+
+
+
Bit
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
32,768
+
+
16,384
+
+
8,192
+
+
4,096
+
+
2,048
+
+
1024
+
+
512
+
+
256
+
+
+
+
Weights
+
+
(215)
+
+
(214)
+
+
(213)
+
+
(212)
+
+
(211)
+
+
(210)
+
+
(29)
+
+
(28)
+
+
+
+
+
+
Example 1
+
+
+
+
operationRegister = status.operation.USER +
+
status.operation.PROG
+
status.operation.enable = operationRegister
+
+
Sets the USER and PROG bits of the operation status enable register using constants.
+
+
+
+
+
Example 2
+
+
+
+
-- decimal 20480 = binary 0101 0000 0000 0000
+
operationRegister = 20480
+
status.operation.enable = operationRegister
+
+
Sets the USER and PROG bits of the operation status enable register using a decimal value.
The operation calibrating event register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 2
+
+
+
+
+
Details
+
These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
Not used
+
+
Not applicable.
+
+
+
+
B1
+
+
status.operation.calibrating.SMUA
+
+
Set bit indicates that SMU A is unlocked for calibration.
+
Bit B1 decimal value: 2
+
Binary value: 0000 0010
+
+
+
+
B2-B15
+
+
Not used
+
+
Not applicable.
+
+
+
+
+
As an example, to set bit B1 of the operation status calibration summary enable register, set status.operation.calibrating.enable = status.operation.calibrating.SMUA.
+
In addition to the above constant, operationRegister can be set to the decimal equivalent of the bit to set.
+
Example
+
+
+
+
status.operation.calibrating.enable =
+
status.operation.calibrating.SMUA
+
+
Sets the SMUA bit of the operation status calibration summary enable register using a constant.
The operation event register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
+
Details
+
These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000 0100 0000 0010. This value indicates that bit B1 and bit B10 are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
+
+
+
* Least significant bit ** Most significant bit
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
Not used
+
+
Not applicable.
+
+
+
+
B1
+
+
status.operation.instrument.SMUA
+
+
Set bit indicates one or more enabled bits for the operation status SMU A summary register is set.
+
Bit B1 decimal value: 2
+
+
+
+
B2-B9
+
+
Not used
+
+
Not applicable.
+
+
+
+
B10
+
+
status.operation.instrument.TRIGGER_BLENDER
+
status.operation.instrument.TRGBLND
+
+
Set bit indicates one or more enabled bits for the operation status trigger blender summary register is set.
+
Bit B10 decimal value: 1024.
+
+
+
+
B11
+
+
status.operation.instrument.TRIGGER_TIMER
+
status.operation.instrument.TRGTMR
+
+
Set bit indicates one or more enabled bits for the operation status trigger timer summary register is set.
+
Bit B11 decimal value: 2048
+
+
+
+
B12
+
+
status.operation.instrument.DIGITAL_IO
+
status.operation.instrument.DIGIO
+
+
Set bit indicates one or more enabled bits for the operation status digital I/O summary register is set.
+
Bit B12 decimal value: 4096
+
+
+
+
B13
+
+
status.operation.instrument.TSPLINK
+
+
Set bit indicates one or more enabled bits for the operation status TSP-Link summary register is set.
+
Bit B13 decimal value: 8192
+
+
+
+
B14
+
+
status.operation.instrument.LAN
+
+
Set bit indicates one or more enabled bits for the operation status LAN summary register is set.
+
Bit B14 decimal value: 16,384
+
+
+
+
B15
+
+
Not used
+
+
Not applicable.
+
+
+
+
+
As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable= status.operation.instrument.SMUA.
+
In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024).
The operation status digital I/O summary register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024
+
+
+
+
+
Details
+
These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0-B9
+
+
Not used
+
+
Not applicable
+
+
+
+
B10
+
+
status.operation.instrument.digio.TRIGGER_OVERRUN
+
status.operation.instrument.digio.TRGOVR
+
+
Set bit indicates an enabled bit in the Operation Status Digital I/O Overrun Register is set.
+
Bit B10 decimal value: 1024
+
Binary value: 0100 0000 0010
+
+
+
+
B11-B15
+
+
Not used
+
+
Not applicable
+
+
+
+
+
+
In addition to the above constant, operationRegister can be set to the decimal equivalent of the bit to set.
+
Example
+
+
+
+
status.operation.instrument.digio.enable =
+
status.operation.instrument.digio.TRGOVR
+
+
Sets the TRGOVR bit of the operation status digital I/O summary enable register using a constant.
The operation status digio I/O overrun register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
+
Details
+
These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000 0100 0000 0010. This value indicates that bit b1 and bit B10 are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
+
+
+
* Least significant bit ** Most significant bit
+
A set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.
+
In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024).
The operation status lan summary register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
+
Details
+
These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000 0100 0000 0010. This value indicates that bit B1 and bit B10 are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
+
+
+
* Least significant bit ** Most significant bit
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
status.operation.instrument.lan.CONNECTION
+
status.operation.instrument.lan.CON
+
+
Set bit indicates that the LAN cable is connected and a link has been detected.
+
Bit B0 decimal value: 1
+
+
+
+
B1
+
+
status.operation.instrument.lan.CONFIGURING
+
status.operation.instrument.lan.CONF
+
+
Set bit indicates the LAN is performing its configuration sequence.
+
Bit B1 decimal value: 2
+
+
+
+
B2-B9
+
+
Not used
+
+
Not available
+
+
+
+
B10
+
+
status.operation.instrument.lan.TRIGGER_OVERRUN
+
status.operation.instrument.lan.TRGOVR
+
+
Set bit indicates one or more enabled bits for the operation status LAN trigger overrun register is set.
+
Bit B10 decimal value: 1024
+
+
+
+
B11-B15
+
+
Not used
+
+
Not applicable
+
+
+
+
+
+
As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable= status.operation.instrument.lan.CON.
+
In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024).
The operation status lan trigger overrun register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
+
Details
+
These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000 0001 0000 0010. This value indicates that bit B1 and bit B8 are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
+
+
+
* Least significant bit ** Most significant bit
+
A set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.
+
In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).
The operation status SMU X summary register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
X
+
+
Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel A)
+
+
+
+
+
Details
+
These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1025) is read as the value of the condition register, the binary equivalent is 0000 0100 0000 0010. This value indicates that bit B0 and bit B10 are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
+
+
+
* Least significant bit ** Most significant bit
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
status.operation.instrument.smuX.CALIBRATING
+
status.operation.instrument.smuX.CAL
+
+
Set bit indicates thatsmuX is unlocked for calibration.
+
Bit B0 decimal value: 1
+
+
+
+
B1-B2
+
+
Not used
+
+
Not applicable.
+
+
+
+
B3
+
+
status.operation.instrument.smuX.SWEEPING
+
status.operation.instrument.smuX.SWE
+
+
Set bit indicates thatsmuX is sweeping.
+
Bit B3 decimal value: 8
+
+
+
+
B4
+
+
status.operation.instrument.smuX.MEASURING
+
status.operation.instrument.smuX.MEAS
+
+
Bit will be set when taking an overlapped measurement, but it will not set when taking a normal synchronous measurement.
+
Bit B4 decimal value: 16
+
+
+
+
B5-B9
+
+
Not used
+
+
Not applicable.
+
+
+
+
B10
+
+
status.operation.instrument.smuX.TRIGGER_OVERRUN
+
status.operation.instrument.smuX.TRGOVR
+
+
Set bit indicates an enabled bit has been set in the operation status smu X trigger overrun event register.
+
Bit B10 decimal value: 1024
+
+
+
+
B11-B15
+
+
Not used
+
+
Not applicable.
+
+
+
+
+
+
As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable=status.operation.instrument.smua.CAL.
+
In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1025 (which is the sum of 1 + 1024).
+
+
+
+
Bit
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
128
+
+
64
+
+
32
+
+
16
+
+
8
+
+
4
+
+
2
+
+
1
+
+
+
+
Weights
+
+
(27)
+
+
(26)
+
+
(25)
+
+
(24)
+
+
(23)
+
+
(22)
+
+
(21)
+
+
(20)
+
+
+
+
+
+
+
+
+
Bit
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
32,768
+
+
16,384
+
+
8,192
+
+
4,096
+
+
2,048
+
+
1024
+
+
512
+
+
256
+
+
+
+
Weights
+
+
(215)
+
+
(214)
+
+
(213)
+
+
(212)
+
+
(211)
+
+
(210)
+
+
(29)
+
+
(28)
+
+
+
+
+
Example
+
+
+
+
status.operation.instrument.smua.enable =
+
status.operation.instrument.smua.MEAS
+
+
Sets the MEAS bit of the operation status SMU A summary enable register using a constant.
The operation status SMU X trigger overrun register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
+
Details
+
These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000 0001 0010. This value indicates that bit B1 and bit B4 are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
0
+
+
1
+
+
0
+
+
+
+
+
* Least significant bit ** Most significant bit
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
Set bit indicates that the end pulse event detector of the SMU was already in the detected state when a trigger was received.
+
Bit B4 decimal value: 16
+
+
+
+
B5-B15
+
+
Not used
+
+
Not applicable.
+
+
+
+
+
+
As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable= status.operation.instrument.smua.trigger_overrun.ARM.
+
In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).
The operation status trigger blender summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024
+
+
+
+
+
Details
+
These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
Set bit indicates one or more enabled bits for operation status trigger blender overrun register is set.
+
Bit B10 decimal value: 1024
+
Binary value: 0100 0000 0000
+
+
+
+
B11-B15
+
+
Not used
+
+
Not applicable.
+
+
+
+
+
+
In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to 1024.
The operation status trigger blender overrun register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
+
Details
+
These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000 0001 0010. This value indicates that bit B1 and bit B4 are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
0
+
+
1
+
+
0
+
+
+
+
+
* Least significant bit ** Most significant bit
+
A set bit value indicates that the specified trigger blender generated an action overrun.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.
+
In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).
The operation status trigger timer summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024
+
+
+
+
+
Details
+
These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
Set bit indicates one or more enabled bits for the operation status trigger timer overrun register is set.
+
Bit B10 decimal value: 1024
+
Binary value: 0100 0000 0000
+
+
+
+
B11-B15
+
+
Not used
+
+
Not applicable
+
+
+
+
+
+
In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to 1024.
The operation status trigger timer trigger overrun register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
+
Details
+
These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000 0001 0010. This value indicates that bit B1 and bit B4 are set.
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
0
+
+
1
+
+
0
+
+
+
+
+
* Least significant bit ** Most significant bit
+
A set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.
+
In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).
The operation status TSP-Link summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024
+
+
+
+
+
Details
+
These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
Set bit indicates one or more enabled bits for the operation status TSP-Link overrun register is set.
+
Bit B10 decimal value: 1024
+
Binary value: 0100 0000 0000
+
+
+
+
B11-B15
+
+
Not used
+
+
Not applicable
+
+
+
+
+
+
In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to 1024.
+
Example
+
+
+
+
status.operation.instrument.tsplink.enable = 1024
+
+
+
Sets the trigger overrun bit of the operation status TSP-Link summary enable register using a decimal value.
The operation status TSP-link overrun register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
+
Details
+
These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000 0000 0000 1010. This value indicates that bit B1 and bit B3 are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
1
+
+
0
+
+
+
+
+
* Least significant bit ** Most significant bit
+
A set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.
+
In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8).
The operation status measuring summary register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than zero (0) is 2
+
+
+
+
+
Details
+
These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
Not used
+
+
Not applicable.
+
+
+
+
B1
+
+
status.operation.measuring.SMUA
+
+
Bit will be set when taking an overlapped measurement, but it will not set when taking a normal synchronous measurement.
+
Bit B1 decimal value: 2
+
Binary value: 0000 0010
+
+
+
+
B2-B15
+
+
Not used
+
+
Not applicable.
+
+
+
+
+
+
In addition to the above constant, operationRegister can be set to the decimal equivalent of the bit to set.
+
Example
+
+
+
+
status.operation.measuring.enable =
+
status.operation.measuring.SMUA
+
+
Sets the SMUA bit of the operation status measuring summary enable register using a constant.
The operation status remote summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
+
Details
+
These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
Not used
+
+
Not applicable.
+
+
+
+
B1
+
+
status.operation.remote.COMMAND_AVAILABLE
+
status.operation.remote.CAV
+
+
Set bit indicates there is a command available in the execution queue.
+
Bit B1 decimal value: 2
+
Binary value: 0000 0000 0000 0010
+
+
+
+
B2-B10
+
+
Not used
+
+
Not applicable.
+
+
+
+
B11
+
+
status.operation.remote.PROMPTS_ENABLED
+
status.operation.remote.PRMPT
+
+
Set bit indicates command prompts are enabled.
+
Bit B11 decimal value: 2048
+
Binary value: 0000 0100 0000 0000
+
+
+
+
B12-B15
+
+
Not used
+
+
Not applicable.
+
+
+
+
+
+
As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.
+
In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B11, set operationRegister to 2050 (which is the sum of 2 + 2048).
+
Example
+
+
+
+
status.operation.remote.enable =
+
status.operation.remote.CAV
+
+
Sets the CAV bit of the operation status remote summary enable register using a constant.
The operation status sweeping summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than zero (0) is 2
+
+
+
+
+
Details
+
These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
Not used
+
+
Not applicable.
+
+
+
+
B1
+
+
status.operation.sweeping.SMUA
+
+
Set bit indicates that SMU A is sweeping.
+
Bit B1 decimal value: 2
+
Binary value: 0000 0010
+
+
+
+
B2-B5
+
+
Not used
+
+
Not applicable.
+
+
+
+
+
+
In addition to the above constant, operationRegister can be set to the decimal equivalent of the bit to set.
+
Example
+
+
+
+
status.operation.sweeping.enable =
+
status.operation.sweeping.SMUA
+
+
Sets the SMUA bit of the operation status sweeping summary enable register using a constant.
The operation status trigger overrun summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
+
Details
+
These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000 0100 0000 0010. This value indicates that bit B1 and bit B10 are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
+
+
+
* Least significant bit ** Most significant bit
+
+
The bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
Not used
+
+
Not applicable.
+
+
+
+
B1
+
+
status.operation.trigger_overrun.SMUA
+
+
Set bit indicates one of the enabled bits in the operation status SMU A trigger overrun event register is set.
+
Bit B1 decimal value: 2
+
+
+
+
B2-B9
+
+
Not used
+
+
Not applicable.
+
+
+
+
B10
+
+
status.operation.trigger_overrun.TRIGGER_BLENDER
+
status.operation.trigger_overrun.TRGBLND
+
+
Set bit indicates one of the enabled bits in the operation status trigger blender overrun event register is set.
+
Bit B10 decimal value: 1024
+
+
+
+
B11
+
+
status.operation.trigger_overrun.TRIGGER_TIMER
+
status.operation.trigger_overrun.TRGTMR
+
+
Set bit indicates one of the enabled bits in the operation status trigger timer overrun event register is set.
+
Bit B11 decimal value: 2048
+
+
+
+
B12
+
+
status.operation.trigger_overrun.DIGITAL_IO
+
status.operation.trigger_overrun.DIGIO
+
+
Set bit indicates one of the enabled bits in the operation status digital I/O overrun event register is set.
+
Bit B12 decimal value: 4096
+
+
+
+
B13
+
+
status.operation.trigger_overrun.TSPLINK
+
+
Set bit indicates one of the enabled bits in the operation status TSP-Link overrun event register is set.
+
Bit B13 decimal value: 8192
+
+
+
+
B14
+
+
status.operation.trigger_overrun.LAN
+
+
Set bit indicates one of the enabled bits in the operation status LAN trigger overrun event register is set.
+
Bit B14 decimal value: 16,384
+
+
+
+
B15
+
+
Not used
+
+
Not applicable.
+
+
+
+
+
+
As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.
+
In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1026 (which is the sum of 2 + 1024).
The operation status user register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
+
Details
+
These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000 0000 1000 0001. This value indicates that bits B0 and B7 are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
+
+
+
* Least significant bit ** Most significant bit
+
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
status.operation.user.BIT0
+
+
Bit B0 decimal value: 1
+
+
+
+
B1
+
+
status.operation.user.BIT1
+
+
Bit B1 decimal value: 2
+
+
+
+
B2
+
+
status.operation.user.BIT2
+
+
Bit B2 decimal value: 4
+
+
+
+
B3
+
+
status.operation.user.BIT3
+
+
Bit B3 decimal value: 8
+
+
+
+
B4
+
+
status.operation.user.BIT4
+
+
Bit B4 decimal value: 16
+
+
+
+
B5
+
+
status.operation.user.BIT5
+
+
Bit B5 decimal value: 32
+
+
+
+
B6
+
+
status.operation.user.BIT6
+
+
Bit B6 decimal value: 64
+
+
+
+
B7
+
+
status.operation.user.BIT7
+
+
Bit B7 decimal value: 128
+
+
+
+
B8
+
+
status.operation.user.BIT8
+
+
Bit B8 decimal value: 256
+
+
+
+
B9
+
+
status.operation.user.BIT9
+
+
Bit B9 decimal value: 512
+
+
+
+
B10
+
+
status.operation.user.BIT10
+
+
Bit B10 decimal value: 1024
+
+
+
+
B11
+
+
status.operation.user.BIT11
+
+
Bit B11 decimal value: 2048
+
+
+
+
B12
+
+
status.operation.user.BIT12
+
+
Bit B12 decimal value: 4096
+
+
+
+
B13
+
+
status.operation.user.BIT13
+
+
Bit B13 decimal value: 8192
+
+
+
+
B14
+
+
status.operation.user.BIT14
+
+
Bit B14 decimal value: 16,384
+
+
+
+
B15
+
+
Not used
+
+
Not applicable
+
+
+
+
+
As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable= status.operation.user.BIT0.
+
In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2048 + 16,384).
+
+
+
+
Bit
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
128
+
+
64
+
+
32
+
+
16
+
+
8
+
+
4
+
+
2
+
+
1
+
+
+
+
Weights
+
+
(27)
+
+
(26)
+
+
(25)
+
+
(24)
+
+
(23)
+
+
(22)
+
+
(21)
+
+
(20)
+
+
+
+
+
+
+
+
+
Bit
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
32,768
+
+
16,384
+
+
8,192
+
+
4,096
+
+
2,048
+
+
1024
+
+
512
+
+
256
+
+
+
+
Weights
+
+
(215)
+
+
(214)
+
+
(213)
+
+
(212)
+
+
(211)
+
+
(210)
+
+
(29)
+
+
(28)
+
+
+
+
+
Example 1
+
+
+
+
operationRegister = status.operation.user.BIT11 +
+
status.operation.user.BIT14
+
status.operation.user.enable = operationRegister
+
+
Sets bits B11 and B14 of the operation status user enable register using constants.
+
+
+
+
+
Example 2
+
+
+
+
-- 18432 = binary 0100 1000 0000 0000
+
operationRegister = 18432
+
status.operation.enable = operationRegister
+
+
Sets bits B11 and B14 of the operation status user enable register using a decimal value.
These attributes manage the status model's questionable status register set.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute
+
+
- -
+
+
- -
+
+
- -
+
+
- -
+
+
+
+
.condition (R)
+
+
Yes
+
+
Not applicable
+
+
Not saved
+
+
Not applicable
+
+
+
+
.enable (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.event (R)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.ntr (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.ptr (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
13,056 (All bits set)
+
+
+
+
+
Usage
+
quesRegister = status.questionable.condition
+
quesRegister = status.questionable.enable
+
quesRegister = status.questionable.event
+
quesRegister = status.questionable.ntr
+
quesRegister = status.questionable.ptr
+
status.questionable.enable = quesRegister
+
status.questionable.ntr = quesRegister
+
status.questionable.ptr = quesRegister
+
+
+
+
quesRegister
+
+
The questionable status register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
+
Details
+
These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011 0000 0000 0000. This value indicates that bits B12 and B13 are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
1
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
+
+
+
* Least significant bit ** Most significant bit
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
An enabled bit in the questionable status instrument summary event register is set.
+
Bit B13 decimal value: 8,192
+
+
+
+
B14-B15
+
+
Not used
+
+
Not available
+
+
+
+
+
As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.
+
In addition to the above constants, quesRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set quesRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set quesRegister to 12,288 (which is the sum of 4096 + 8192).
The questionable status calibration summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than zero (0) is 2
+
+
+
+
+
Details
+
These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
Not used
+
+
Not applicable.
+
+
+
+
B1
+
+
status.questionable.calibration.SMUA
+
+
Set bit indicates that the calibration constants stored in nonvolatile memory were corrupted and could not be loaded when the instrument powered up.
+
Bit B1 decimal value: 2
+
Binary value: 0000 0010
+
+
+
+
B2 to B15
+
+
Not used
+
+
Not applicable.
+
+
+
+
+
+
In addition to the above constant, questionableRegister can be set to the decimal equivalent of the bit to set.
+
Example
+
+
+
+
status.questionable.calibration.enable =
+
status.questionable.calibration.SMUA
+
+
Sets the SMUA bit of the questionable status calibration summary enable register using a constant.
The questionable status instrument summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 2
+
+
+
+
+
Details
+
These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
Not used
+
+
Not applicable
+
+
+
+
B1
+
+
status.questionable.instrument.SMUA
+
+
Set bit indicates one or more enabled bits in the questionable status SMU A summary event register is set.
+
Bit B1 decimal value: 2
+
Binary value: 0000 0010
+
+
+
+
B2 to B15
+
+
Not used
+
+
Not applicable.
+
+
+
+
+
In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set.
+
Example
+
+
+
+
status.questionable.instrument.enable =
+
status.questionable.instrument.SMUA
+
+
Sets the SMUA bit of the questionable status instrument summary enable register using a constant.
The questionable status SMU X summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
X
+
+
Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)
+
+
+
+
+
Details
+
These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000 0011 0000 0000. This value indicates that bit B8 and bit B9 are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
+
+
+
* Least significant bit ** Most significant bit
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
Set bit indicates that an over temperature condition was detected.
+
Bit B12 decimal value: 4096
+
+
+
+
B13-B15
+
+
Not used
+
+
Not applicable.
+
+
+
+
+
+
As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.
+
In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).
+
+
+
+
Bit
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
128
+
+
64
+
+
32
+
+
16
+
+
8
+
+
4
+
+
2
+
+
1
+
+
+
+
Weights
+
+
(27)
+
+
(26)
+
+
(25)
+
+
(24)
+
+
(23)
+
+
(22)
+
+
(21)
+
+
(20)
+
+
+
+
+
+
+
+
+
Bit
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
32,768
+
+
16,384
+
+
8,192
+
+
4,096
+
+
2,048
+
+
1024
+
+
512
+
+
256
+
+
+
+
Weights
+
+
(215)
+
+
(214)
+
+
(213)
+
+
(212)
+
+
(211)
+
+
(210)
+
+
(29)
+
+
(28)
+
+
+
+
+
Example
+
+
+
+
questionableRegister =
+
status.questionable.instrument.smua.CAL +
+
status.questionable.instrument.smua.UO
+
status.questionable.instrument.smua.enable =
+
questionableRegister
+
+
Sets bit B8 and bit B9 of the questionable status SMU A summary enable register using constants.
The questionable status over temperature summary register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 2
+
+
+
+
+
Details
+
These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
Not used
+
+
Not applicable.
+
+
+
+
B1
+
+
status.questionable.over_temperature.SMUA
+
+
Set bit indicates that an over temperature indication was detected.
+
Bit B1 decimal value: 2
+
Binary value: 0000 0010
+
+
+
+
B2-B15
+
+
Not used
+
+
Not applicable.
+
+
+
+
+
In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set.
+
+
Example
+
+
+
+
status.questionable.over_temperature.enable =
+
status.questionable.over_temperature.SMUA
+
+
Sets the SMU A bit in the questionable status over temperature summary enable register using a constant.
The questionable status unstable output summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 2
+
+
+
+
+
Details
+
These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
Not used
+
+
Not applicable.
+
+
+
+
B1
+
+
status.questionable.unstable_output.SMUA
+
+
Set bit indicates that an unstable output condition was detected.
+
Bit B1 decimal value: 2
+
Binary value: 0000 0010
+
+
+
+
B2-B15
+
+
Not used
+
+
Not applicable.
+
+
+
+
+
In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set.
+
+
Example
+
+
+
+
status.questionable.unstable_output.enable =
+
status.questionable.unstable_output.SMUA
+
+
Sets the SMU A bit in the questionable status unstable output summary enable register bit using a constant.
This function resets all bits in the system status model.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
status.reset()
+
Details
+
This function clears all status data structure registers (enable, event, NTR, and PTR) to their default values. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers.
These attributes manage the status model's standard event status register set.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute
+
+
- -
+
+
- -
+
+
- -
+
+
- -
+
+
+
+
.condition (R)
+
+
Yes
+
+
Not applicable
+
+
Not saved
+
+
Not applicable
+
+
+
+
.enable (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.event (R)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.ntr (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.ptr (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
253 (All bits set)
+
+
+
+
+
Usage
+
standardRegister = status.standard.condition
+
standardRegister = status.standard.enable
+
standardRegister = status.standard.event
+
standardRegister = status.standard.ntr
+
standardRegister = status.standard.ptr
+
status.standard.enable = standardRegister
+
status.standard.ntr = standardRegister
+
status.standard.ptr = standardRegister
+
+
+
+
standardRegister
+
+
The standard event status register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
+
Details
+
These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000 0000 1000 0001. This value indicates that bit B0 and bit B7 are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
+
+
+
* Least significant bit ** Most significant bit
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
Set bit indicates that all pending selected instrument operations are completed and the instrument is ready to accept new commands. The bit is set in response to an *OPC command. The opc() function can be used in place of the *OPC command.
+
Bit B0 decimal value: 1
+
+
+
+
B1
+
+
Not used
+
+
Not applicable
+
+
+
+
B2
+
+
status.standard.QUERY_ERROR status.standard.QYE
+
+
Set bit indicates that you attempted to read data from an empty Output Queue.
Set bit indicates that the instrument detected an error while trying to execute a command.
+
Bit B4 decimal value: 16
+
+
+
+
B5
+
+
status.standard.COMMAND_ERROR status.standard.CME
+
+
Set bit indicates that a command error has occurred. Command errors include:
+
IEEE Std 488.2 syntax error: Instrument received a message that does not follow the defined syntax of the IEEE Std 488.2 standard.
+
Semantic error: Instrument received a command that was misspelled or received an optional IEEE Std 488.2 command that is not implemented.
+
GET error: The instrument received a Group Execute Trigger (GET) inside a program message.
+
Bit B5 decimal value: 32
+
+
+
+
B6
+
+
status.standard.USER_REQUEST status.standard.URQ
+
+
Set bit indicates that the LOCAL key on the instrument front panel was pressed.
+
Bit B6 decimal value: 64
+
+
+
+
B7
+
+
status.standard.POWER_ON status.standard.PON
+
+
Set bit indicates that the instrument has been turned off and turned back on since the last time this register has been read.
+
Bit B7 decimal value: 128
+
+
+
+
B8-B15
+
+
Not used
+
+
Not applicable
+
+
+
+
+
As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.
+
In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).
+
+
+
+
Bit
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
128
+
+
64
+
+
32
+
+
16
+
+
8
+
+
4
+
+
2
+
+
1
+
+
+
+
Weights
+
+
(27)
+
+
(26)
+
+
(25)
+
+
(24)
+
+
(23)
+
+
(22)
+
+
(21)
+
+
(20)
+
+
+
+
+
Example 1
+
+
+
+
standardRegister = status.standard.OPC
+
+ status.standard.EXE
+
status.standard.enable = standardRegister
+
+
Sets the OPC and EXE bits of the standard event status enable register using constants.
+
+
+
+
+
Example 2
+
+
+
+
-- decimal 17 = binary 0001 0001
+
standardRegister = 17
+
status.standard.enable = standardRegister
+
+
Sets the OPC and EXE bits of the standard event status enable register using a decimal value.
These attributes manage the status model's TSP-Link® system summary register for nodes 1 through 14.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute
+
+
- -
+
+
- -
+
+
- -
+
+
- -
+
+
+
+
.condition (R)
+
+
Yes
+
+
Not applicable
+
+
Not saved
+
+
Not applicable
+
+
+
+
.enable (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.event (R)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.ntr (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.ptr (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
32,767 (All bits set)
+
+
+
+
+
Usage
+
enableRegister = status.system.condition
+
enableRegister = status.system.enable
+
enableRegister = status.system.event
+
enableRegister = status.system.ntr
+
enableRegister = status.system.ptr
+
status.system.enable = enableRegister
+
status.system.ntr = enableRegister
+
status.system.ptr = enableRegister
+
+
+
+
enableRegister
+
+
The system summary register's status; a zero (0) indicates no bits set; other values indicate various bit settings
+
+
+
+
+
Details
+
In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000 0000 1000 0001. This value indicates that bit B0 and bit B7 are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
+
+
+
* Least significant bit ** Most significant bit
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
status.system.EXTENSION_BIT status.system.EXT
+
+
Bit B0 decimal value: 1
+
+
+
+
B1
+
+
status.system.NODE1
+
+
Bit B1 decimal value: 2
+
+
+
+
B2
+
+
status.system.NODE2
+
+
Bit B2 decimal value: 4
+
+
+
+
B3
+
+
status.system.NODE3
+
+
Bit B3 decimal value: 8
+
+
+
+
B4
+
+
status.system.NODE4
+
+
Bit B4 decimal value: 16
+
+
+
+
B5
+
+
status.system.NODE5
+
+
Bit B5 decimal value: 32
+
+
+
+
B6
+
+
status.system.NODE6
+
+
Bit B6 decimal value: 64
+
+
+
+
B7
+
+
status.system.NODE7
+
+
Bit B7 decimal value: 128
+
+
+
+
B8
+
+
status.system.NODE8
+
+
Bit B8 decimal value: 256
+
+
+
+
B9
+
+
status.system.NODE9
+
+
Bit B9 decimal value: 512
+
+
+
+
B10
+
+
status.system.NODE10
+
+
Bit B10 decimal value: 1024
+
+
+
+
B11
+
+
status.system.NODE11
+
+
Bit B11 decimal value: 2048
+
+
+
+
B12
+
+
status.system.NODE12
+
+
Bit B12 decimal value: 4096
+
+
+
+
B13
+
+
status.system.NODE13
+
+
Bit B13 decimal value: 8192
+
+
+
+
B14
+
+
status.system.NODE14
+
+
Bit B14 decimal value: 16384
+
+
+
+
B15
+
+
Not used
+
+
Not applicable
+
+
+
+
+
+
As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.
+
In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2048 + 16,384).
+
+
+
+
Bit
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
128
+
+
64
+
+
32
+
+
16
+
+
8
+
+
4
+
+
2
+
+
1
+
+
+
+
Weights
+
+
(27)
+
+
(26)
+
+
(25)
+
+
(24)
+
+
(23)
+
+
(22)
+
+
(21)
+
+
(20)
+
+
+
+
+
+
+
+
Bit
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
32,768
+
+
16,384
+
+
8,192
+
+
4,096
+
+
2,048
+
+
1024
+
+
512
+
+
256
+
+
+
+
Weights
+
+
(215)
+
+
(214)
+
+
(213)
+
+
(212)
+
+
(211)
+
+
(210)
+
+
(29)
+
+
(28)
+
+
+
+
+
+
Example 1
+
+
+
+
enableRegister = status.system.NODE11 +
+
status.system.NODE14
+
status.system.enable = enableRegister
+
+
Sets bits B11 and B14 of the system summary enable register using constants.
+
+
+
+
+
Example 2
+
+
+
+
-- decimal 18432 = binary 0100 1000 0000 0000
+
enableRegister = 18432
+
status.system.enable = enableRegister
+
+
Sets bits B11 and B14 of the system summary enable register using a decimal value.
These attributes manage the status model's TSP-Link® system summary register for nodes 15 through 28.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute
+
+
- -
+
+
- -
+
+
- -
+
+
- -
+
+
+
+
.condition (R)
+
+
Yes
+
+
Not applicable
+
+
Not saved
+
+
Not applicable
+
+
+
+
.enable (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.event (R)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.ntr (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.ptr (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
32,767 (All bits set)
+
+
+
+
+
Usage
+
enableRegister = status.system2.condition
+
enableRegister = status.system2.enable
+
enableRegister = status.system2.event
+
enableRegister = status.system2.ntr
+
enableRegister = status.system2.ptr
+
status.system2.enable = enableRegister
+
status.system2.ntr = enableRegister
+
status.system2.ptr = enableRegister
+
+
+
+
enableRegister
+
+
The system summary 2 register's status; a zero (0) indicates no bits set; other values indicate various bit settings
+
+
+
+
+
Details
+
In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000 0000 1000 0001. This value indicates that bit B0 and bit B7 are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
+
+
+
* Least significant bit ** Most significant bit
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
status.system2.EXTENSION_BIT status.system2.EXT
+
+
Bit B0 decimal value: 1
+
+
+
+
B1
+
+
status.system2.NODE15
+
+
Bit B1 decimal value: 2
+
+
+
+
B2
+
+
status.system2.NODE16
+
+
Bit B2 decimal value: 4
+
+
+
+
B3
+
+
status.system2.NODE17
+
+
Bit B3 decimal value: 8
+
+
+
+
B4
+
+
status.system2.NODE18
+
+
Bit B4 decimal value: 16
+
+
+
+
B5
+
+
status.system2.NODE19
+
+
Bit B5 decimal value: 32
+
+
+
+
B6
+
+
status.system2.NODE20
+
+
Bit B6 decimal value: 64
+
+
+
+
B7
+
+
status.system2.NODE21
+
+
Bit B7 decimal value: 128
+
+
+
+
B8
+
+
status.system2.NODE22
+
+
Bit B8 decimal value: 256
+
+
+
+
B9
+
+
status.system2.NODE23
+
+
Bit B9 decimal value: 512
+
+
+
+
B10
+
+
status.system2.NODE24
+
+
Bit B10 decimal value: 1024
+
+
+
+
B11
+
+
status.system2.NODE25
+
+
Bit B11 decimal value: 2048
+
+
+
+
B12
+
+
status.system2.NODE26
+
+
Bit B12 decimal value: 4096
+
+
+
+
B13
+
+
status.system2.NODE27
+
+
Bit B13 decimal value: 8192
+
+
+
+
B14
+
+
status.system2.NODE28
+
+
Bit B14 decimal value: 16,384
+
+
+
+
B15
+
+
Not used
+
+
Not applicable
+
+
+
+
+
+
As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.
+
In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2048 + 16,384).
+
+
+
+
Bit
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
128
+
+
64
+
+
32
+
+
16
+
+
8
+
+
4
+
+
2
+
+
1
+
+
+
+
Weights
+
+
(27)
+
+
(26)
+
+
(25)
+
+
(24)
+
+
(23)
+
+
(22)
+
+
(21)
+
+
(20)
+
+
+
+
+
+
+
+
Bit
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
32,768
+
+
16,384
+
+
8,192
+
+
4,096
+
+
2,048
+
+
1024
+
+
512
+
+
256
+
+
+
+
Weights
+
+
(215)
+
+
(214)
+
+
(213)
+
+
(212)
+
+
(211)
+
+
(210)
+
+
(29)
+
+
(28)
+
+
+
+
+
+
Example 1
+
+
+
+
enableRegister = status.system2.NODE25 +
+
status.system2.NODE28
+
status.system2.enable = enableRegister
+
+
Sets bits B11 and B14 of the system summary 2 enable register using constants.
+
+
+
+
+
Example 2
+
+
+
+
-- decimal 18432 = binary 0100 1000 0000 0000
+
enableRegister = 18432
+
status.system2.enable = enableRegister
+
+
Sets bits B11 and B14 of the system summary 2 enable register using a decimal value.
These attributes manage the status model's TSP-Link® system summary register for nodes 29 through 42.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute
+
+
- -
+
+
- -
+
+
- -
+
+
- -
+
+
+
+
.condition (R)
+
+
Yes
+
+
Not applicable
+
+
Not saved
+
+
Not applicable
+
+
+
+
.enable (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.event (R)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.ntr (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.ptr (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
32,767 (All bits set)
+
+
+
+
+
Usage
+
enableRegister = status.system3.condition
+
enableRegister = status.system3.enable
+
enableRegister = status.system3.event
+
enableRegister = status.system3.ntr
+
enableRegister = status.system3.ptr
+
status.system3.enable = enableRegister
+
status.system3.ntr = enableRegister
+
status.system3.ptr = enableRegister
+
+
+
+
enableRegister
+
+
The system summary 3 register's status; a zero (0) indicates no bits set; other values indicate various bit settings
+
+
+
+
+
Details
+
In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000 0000 1000 0001. This value indicates that bit B0 and bit B7 are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
+
+
+
* Least significant bit ** Most significant bit
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
status.system3.EXTENSION_BIT status.system3.EXT
+
+
Bit B0 decimal value: 1
+
+
+
+
B1
+
+
status.system3.NODE29
+
+
Bit B1 decimal value: 2
+
+
+
+
B2
+
+
status.system3.NODE30
+
+
Bit B2 decimal value: 4
+
+
+
+
B3
+
+
status.system3.NODE31
+
+
Bit B3 decimal value: 8
+
+
+
+
B4
+
+
status.system3.NODE32
+
+
Bit B4 decimal value: 16
+
+
+
+
B5
+
+
status.system3.NODE33
+
+
Bit B5 decimal value: 32
+
+
+
+
B6
+
+
status.system3.NODE34
+
+
Bit B6 decimal value: 64
+
+
+
+
B7
+
+
status.system3.NODE35
+
+
Bit B7 decimal value: 128
+
+
+
+
B8
+
+
status.system3.NODE36
+
+
Bit B8 decimal value: 256
+
+
+
+
B9
+
+
status.system3.NODE37
+
+
Bit B9 decimal value: 512
+
+
+
+
B10
+
+
status.system3.NODE38
+
+
Bit B10 decimal value: 1024
+
+
+
+
B11
+
+
status.system3.NODE39
+
+
Bit B11 decimal value: 2048
+
+
+
+
B12
+
+
status.system3.NODE40
+
+
Bit B12 decimal value: 4096
+
+
+
+
B13
+
+
status.system3.NODE41
+
+
Bit B13 decimal value: 8192
+
+
+
+
B14
+
+
status.system3.NODE42
+
+
Bit B14 decimal value: 16,384
+
+
+
+
B15
+
+
Not used
+
+
Not applicable
+
+
+
+
+
+
As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.
+
In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2048 + 16,384).
+
+
+
+
Bit
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
128
+
+
64
+
+
32
+
+
16
+
+
8
+
+
4
+
+
2
+
+
1
+
+
+
+
Weights
+
+
(27)
+
+
(26)
+
+
(25)
+
+
(24)
+
+
(23)
+
+
(22)
+
+
(21)
+
+
(20)
+
+
+
+
+
+
+
+
Bit
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
32,768
+
+
16,384
+
+
8,192
+
+
4,096
+
+
2,048
+
+
1024
+
+
512
+
+
256
+
+
+
+
Weights
+
+
(215)
+
+
(214)
+
+
(213)
+
+
(212)
+
+
(211)
+
+
(210)
+
+
(29)
+
+
(28)
+
+
+
+
+
+
Example 1
+
+
+
+
enableRegister = status.system3.NODE39 +
+
status.system3.NODE42
+
status.system3.enable = enableRegister
+
+
Sets bits B11 and B14 of the system summary 3 enable register using constants.
+
+
+
+
+
Example 2
+
+
+
+
-- decimal 18432 = binary 0100 1000 0000 0000
+
enableRegister = 18432
+
status.system3.enable = enableRegister
+
+
Sets bits B11 and B14 of the system summary 3 enable register using a decimal value.
These attributes manage the status model's TSP-Link® system summary register for nodes 43 through 56.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute
+
+
- -
+
+
- -
+
+
- -
+
+
- -
+
+
+
+
.condition (R)
+
+
Yes
+
+
Not applicable
+
+
Not saved
+
+
Not applicable
+
+
+
+
.enable (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.event (R)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.ntr (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.ptr (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
32,767 (All bits set)
+
+
+
+
+
Usage
+
enableRegister = status.system4.condition
+
enableRegister = status.system4.enable
+
enableRegister = status.system4.event
+
enableRegister = status.system4.ntr
+
enableRegister = status.system4.ptr
+
status.system4.enable = enableRegister
+
status.system4.ntr = enableRegister
+
status.system4.ptr = enableRegister
+
+
+
+
enableRegister
+
+
The system summary 4 register's status; a zero (0) indicates no bits set; other values indicate various bit settings
+
+
+
+
+
Details
+
In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000 0000 1000 0001. This value indicates that bit B0 and bit B7 are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
+
+
+
* Least significant bit ** Most significant bit
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
status.system4.EXTENSION_BIT status.system4.EXT
+
+
Bit B0 decimal value: 1
+
+
+
+
B1
+
+
status.system4.NODE43
+
+
Bit B1 decimal value: 2
+
+
+
+
B2
+
+
status.system4.NODE44
+
+
Bit B2 decimal value: 4
+
+
+
+
B3
+
+
status.system4.NODE45
+
+
Bit B3 decimal value: 8
+
+
+
+
B4
+
+
status.system4.NODE46
+
+
Bit B4 decimal value: 16
+
+
+
+
B5
+
+
status.system4.NODE47
+
+
Bit B5 decimal value: 32
+
+
+
+
B6
+
+
status.system4.NODE48
+
+
Bit B6 decimal value: 64
+
+
+
+
B7
+
+
status.system4.NODE49
+
+
Bit B7 decimal value: 128
+
+
+
+
B8
+
+
status.system4.NODE50
+
+
Bit B8 decimal value: 256
+
+
+
+
B9
+
+
status.system4.NODE51
+
+
Bit B9 decimal value: 512
+
+
+
+
B10
+
+
status.system4.NODE52
+
+
Bit B10 decimal value: 1024
+
+
+
+
B11
+
+
status.system4.NODE53
+
+
Bit B11 decimal value: 2048
+
+
+
+
B12
+
+
status.system4.NODE54
+
+
Bit B12 decimal value: 4096
+
+
+
+
B13
+
+
status.system4.NODE55
+
+
Bit B13 decimal value: 8192
+
+
+
+
B14
+
+
status.system4.NODE56
+
+
Bit B14 decimal value: 16,384
+
+
+
+
B15
+
+
Not used
+
+
Not applicable
+
+
+
+
+
+
As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.
+
In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2048 + 16,384).
+
+
+
+
Bit
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
128
+
+
64
+
+
32
+
+
16
+
+
8
+
+
4
+
+
2
+
+
1
+
+
+
+
Weights
+
+
(27)
+
+
(26)
+
+
(25)
+
+
(24)
+
+
(23)
+
+
(22)
+
+
(21)
+
+
(20)
+
+
+
+
+
+
+
+
Bit
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
32,768
+
+
16,384
+
+
8,192
+
+
4,096
+
+
2,048
+
+
1024
+
+
512
+
+
256
+
+
+
+
Weights
+
+
(215)
+
+
(214)
+
+
(213)
+
+
(212)
+
+
(211)
+
+
(210)
+
+
(29)
+
+
(28)
+
+
+
+
+
+
Example 1
+
+
+
+
enableRegister = status.system4.NODE53 +
+
status.system4.NODE56
+
status.system2.enable = enableRegister
+
+
Sets bit B11 and bit B14 of the system summary 4 enable register using constants.
+
+
+
+
+
Example 2
+
+
+
+
-- decimal 18432 = binary 0100 1000 0000 0000
+
enableRegister = 18432
+
status.system4.enable = enableRegister
+
+
Sets bit B11 and bit B14 of the system summary 4 enable register using a decimal value.
These attributes manage the status model's TSP-Link® system summary register for nodes 57 through 64.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute
+
+
- -
+
+
- -
+
+
- -
+
+
- -
+
+
+
+
.condition (R)
+
+
Yes
+
+
Not applicable
+
+
Not saved
+
+
Not applicable
+
+
+
+
.enable (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.event (R)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.ntr (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.ptr (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
510 (All bits set)
+
+
+
+
+
Usage
+
enableRegister = status.system5.condition
+
enableRegister = status.system5.enable
+
enableRegister = status.system5.event
+
enableRegister = status.system5.ntr
+
enableRegister = status.system5.ptr
+
status.system5.enable = enableRegister
+
status.system5.ntr = enableRegister
+
status.system5.ptr = enableRegister
+
+
+
+
enableRegister
+
+
The system summary 5 register's status; a zero (0) indicates no bits set; other values indicate various bit settings
+
+
+
+
+
Details
+
In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000 0000 1000 0010. This value indicates that bit B1 and bit B7 are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
+
+
+
* Least significant bit ** Most significant bit
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
Not used
+
+
Not applicable
+
+
+
+
B1
+
+
status.system5.NODE57
+
+
Bit B1 decimal value: 2
+
+
+
+
B2
+
+
status.system5.NODE58
+
+
Bit B2 decimal value: 4
+
+
+
+
B3
+
+
status.system5.NODE59
+
+
Bit B3 decimal value: 8
+
+
+
+
B4
+
+
status.system5.NODE60
+
+
Bit B4 decimal value: 16
+
+
+
+
B5
+
+
status.system5.NODE61
+
+
Bit B5 decimal value: 32
+
+
+
+
B6
+
+
status.system5.NODE62
+
+
Bit B6 decimal value: 64
+
+
+
+
B7
+
+
status.system5.NODE63
+
+
Bit B7 decimal value: 128
+
+
+
+
B8
+
+
status.system5.NODE64
+
+
Bit B8 decimal value: 256
+
+
+
+
B9-B15
+
+
Not used
+
+
Not applicable
+
+
+
+
+
+
As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.
+
In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).
+
+
+
+
Bit
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
128
+
+
64
+
+
32
+
+
16
+
+
8
+
+
4
+
+
2
+
+
1
+
+
+
+
Weights
+
+
(27)
+
+
(26)
+
+
(25)
+
+
(24)
+
+
(23)
+
+
(22)
+
+
(21)
+
+
(20)
+
+
+
+
+
+
+
+
Bit
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
32,768
+
+
16,384
+
+
8,192
+
+
4,096
+
+
2,048
+
+
1024
+
+
512
+
+
256
+
+
+
+
Weights
+
+
(215)
+
+
(214)
+
+
(213)
+
+
(212)
+
+
(211)
+
+
(210)
+
+
(29)
+
+
(28)
+
+
+
+
+
+
Example 1
+
+
+
+
enableRegister = status.system5.NODE57 +
+
status.system5.NODE60
+
status.system2.enable = enableRegister
+
+
Sets bits B1 and B4 of the system summary 5 enable register using constants.
+
+
+
+
+
Example 2
+
+
+
+
-- decimal 18 = binary 0000 0000 0001 0010
+
enableRegister = 18
+
status.system5.enable = enableRegister
+
+
Sets bits B1 and B4 of the system summary 5 enable register using a decimal value.
These steps remove a script from nonvolatile memory. To completely remove a script from the instrument, there are additional steps you must take. See Delete user scripts from the instrument.
+
You can delete the script from nonvolatile memory by sending either of the following commands:
+
script.delete("name")
script.user.delete("name")
Where: name is the user-defined name of the script.
+
To delete a script from nonvolatile memory using TSB Embedded:
+
In TSB Embedded, select the script from the User Scripts list.
Click Delete. There is no confirmation message.
Example: Delete a user script from nonvolatile memory
+
+
+
+
script.delete("test8")
+
+
Delete a user script named test8 from nonvolatile memory.
+
+
+
+
+
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This function restores a script that was removed from the run-time environment.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
script.restore(name)
+
+
+
+
name
+
+
The name of the script to be restored
+
+
+
+
+
Details
+
This command copies the script from nonvolatile memory back into the run-time environment, and it creates a global variable with the same name as the name of the script.
+
Example
+
+
+
+
script.restore("test9")
+
+
Restores a script named "test9" from nonvolatile memory.
This attribute controls the autorun state of a script.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
No
+
+
Not applicable
+
+
See Details
+
+
See Details
+
+
+
+
+
Usage
+
scriptVar.autorun = state
+
state = scriptVar.autorun
+
+
+
+
scriptVar
+
+
The name of the variable that references the script
+
+
+
+
state
+
+
Whether or not the script runs automatically when powered on:
+
"yes" (script runs automatically)
"no" (script does not run automatically)
+
+
+
+
Details
+
Autorun scripts run automatically when the instrument is turned on. You can set any number of scripts to autorun.
+
The run order for autorun scripts is arbitrary, so make sure the run order is not important.
+
The default value for scriptVar.autorun depends on how the script was loaded. The default is "no" if the script was loaded with loadscript or script.new(). It is "yes" for scripts loaded with loadandrunscript or script.newautorun().
+
Make sure to save the script in nonvolatile memory after setting the autorun attribute so that the instrument will retain the setting.
+
Example
+
+
+
+
test5.autorun = "yes"
+
test5.save()
+
+
Assume a script named "test5" is in the run-time environment.
+
The next time the instrument is turned on, "test5" script automatically loads and runs.
+
+
+
+
+
Also see
+
None
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This function returns an iterator that can be used in a for loop to iterate over all the scripts stored in nonvolatile memory.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
for name in script.user.catalog() do body end
+
+
+
+
name
+
+
String representing the name of the script
+
+
+
+
body
+
+
Code that implements the body of the for loop to process the names in the catalog
+
+
+
+
+
Details
+
Accessing the catalog of scripts stored in nonvolatile memory allows you to process all scripts in nonvolatile memory. The entries will be enumerated in no particular order.
+
Each time the body of the function executes, name takes on the name of one of the scripts stored in nonvolatile memory. The for loop repeats until all scripts have been iterated.
+
Example
+
+
+
+
for name in script.user.catalog() do
+
print(name)
+
end
+
+
Retrieve the catalog listing for user scripts.
+
+
+
+
+
Also see
+
None
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This function saves the script to nonvolatile memory or to a USB flash drive.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
scriptVar.save()
+
scriptVar.save(filename)
+
+
+
+
scriptVar
+
+
The name of variable that references the script
+
+
+
+
filename
+
+
The file name to use when saving the script to a USB flash drive
+
+
+
+
+
Details
+
The scriptVar.save() function only saves a script to nonvolatile memory or a USB flash drive.
+
If no filename is given, the script will be saved to internal nonvolatile memory. Only a named script (the script's name attribute is not an empty string) can be saved to internal nonvolatile memory. If a filename is given, the script will be saved to the USB flash drive.
+
You are not required to add the file extension, but if you would like to, the only allowed extension is .tsp (see Example 2).
+
Example 1
+
+
+
+
test8.save()
+
+
Saves the script referenced by the variable test8 to nonvolatile memory.
+
+
+
+
+
Example 2
+
+
+
+
test8.save("/usb1/myScript.tsp")
+
+
Saves the script referenced by the variable test8 to a file named myScript.tsp on your flash drive.
The name of the variable that references the script that contains the source code
+
+
+
+
code
+
+
The body of the script
+
+
+
+
+
Details
+
The loadscript or loadandrunscript and endscript keywords are not included in the source code.
+
The body of the script is a single string with lines separated by the new line character.
+
The instrument automatically keeps the source for all scripts loaded on the instrument. To free up memory or to obfuscate the code, assign nil to the source attribute of the script. Although this attribute is writable, it can only be set to the nil value.
+
Example
+
+
+
+
test7 = script.new("display.clear() display.settext('Hello from my test')", "")
+
print(test7.source)
+
+
+
+
+
The above example creates a script called "test7" that displays a message on the front panel.
+
Retrieve the source code.
+
Output:
+
display.clear() display.settext('Hello from my test')
Keithley Instruments Test Script Processor (TSP®) enabled instruments operate like conventional instruments by responding to a sequence of commands sent by the controller. You can send individual commands to the TSP-enabled instrument the same way you would using any other instrument.
+
Unlike conventional instruments, TSP-enabled instruments can execute automated test sequences independently, without a controller. You can load a series of remote commands into the instrument and store these commands as a script that can be run later by sending a single command message to the instrument. You do not have to choose between using “conventional” control or “script” control. You can combine these forms of instrument control in the way that works best for your particular test application.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2651A/17030.html b/WebHelpDocs/Commands_2651A/17030.html
new file mode 100644
index 0000000..9bdab3d
--- /dev/null
+++ b/WebHelpDocs/Commands_2651A/17030.html
@@ -0,0 +1,64 @@
+
+
+ Retrieve source code one line at a time
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Retrieve source code one line at a time
+
To retrieve the source code one line at a time, send the scriptVar.list() command. When this command is received, the instrument sends the entire script. Each line of the script is sent as a separate response message. The output includes the loadscript or loadandrunscript and endscript keywords.
+
After retrieving the source code, you can modify and save the command lines as a user script under the same name or a new name.
+
To retrieve the source code of a script one line at a time, send the command:
+
scriptVar.list()
+
Where scriptVar is the name of the script.
+
To retrieve the commands in the anonymous script, use script.anonymous.list().
+
Example: Retrieve source code one line at a time
+
+
+
+
test.list()
+
+
Retrieve the source of a script named "test".
+
The output will look similar to:
+
loadscript
+
display.clear()
+
display.settext(”This is a test”)
+
print(”This is a test”)
+
endscript
+
+
+
+
+
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This function retrieves the key code for the last pressed key.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
keyCode = display.getlastkey()
+
+
+
+
keyCode
+
+
A returned value that represents the last front-panel key pressed; see Details for more information
+
+
+
+
+
Details
+
A history of the key code for the last pressed front‑panel key is maintained by the instrument. When the instrument is turned on, or when it is transitioning from local to remote operation, the key code is set to 0 (display.KEY_NONE).
+
Pressing the EXIT (LOCAL) key normally aborts a script. To use this function with the EXIT (LOCAL) key, display.locallockout must be used.
+
The table below lists the keyCode value for each front‑panel action.
+
+
+
+
+
+
+
+
+
+
+
Key codes
+
+
+
+
Value
+
+
Key list
+
+
+
+
Value
+
+
Key list
+
+
+
+
0
+
+
display.KEY_NONE
+
+
+
+
82
+
+
display.KEY_ENTER
+
+
+
+
65
+
+
display.KEY_RANGEUP
+
+
+
+
85
+
+
display.KEY_RECALL
+
+
+
+
68
+
+
display.KEY_MENU
+
+
+
+
86
+
+
display.KEY_MEASA
+
+
+
+
69
+
+
display.KEY_MODEA
+
+
+
+
87
+
+
display.KEY_DIGITSA
+
+
+
+
70
+
+
display.KEY_RELA
+
+
+
+
92
+
+
display.KEY_TRIG
+
+
+
+
71
+
+
display.KEY_RUN
+
+
+
+
93
+
+
display.KEY_LIMITA
+
+
+
+
72
+
+
display.KEY_DISPLAY
+
+
+
+
94
+
+
display.KEY_SPEEDA
+
+
+
+
73
+
+
display.KEY_AUTO
+
+
+
+
95
+
+
display.KEY_LOAD
+
+
+
+
75
+
+
display.KEY_EXIT
+
+
+
+
97
+
+
display.WHEEL_ENTER
+
+
+
+
77
+
+
display.KEY_FILTERA
+
+
+
+
103
+
+
display.KEY_RIGHT
+
+
+
+
78
+
+
display.KEY_STORE
+
+
+
+
104
+
+
display.KEY_LEFT
+
+
+
+
79
+
+
display.KEY_SRCA
+
+
+
+
107
+
+
display.WHEEL_LEFT
+
+
+
+
80
+
+
display.KEY_CONFIG
+
+
+
+
114
+
+
display.WHEEL_RIGHT
+
+
+
+
81
+
+
display.KEY_RANGEDOWN
+
+
+
+
+
+
+
+
+
+
+
+
When using this function, use built-in constants such as display.KEY_RIGHT (rather than the numeric value of 103). This will allow for better forward compatibility with firmware revisions.
+
The OUTPUT ON/OFF control cannot be tracked by this function.
+
Example
+
+
+
+
key = display.getlastkey()
+
print(key)
+
+
On the front panel, press the MENU key and then send the code to the left. This retrieves the key code for the last pressed key.
This function sends a code that simulates the action of a front panel control.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
display.sendkey(keyCode)
+
+
+
+
keyCode
+
+
A parameter that specifies the key to virtually press; see Details for more information
+
+
+
+
+
Details
+
This command simulates the pressing of a front panel key or navigation wheel, or the turning the navigation wheel one click to the left or right.
+
+
+
+
+
+
+
+
+
+
Key codes
+
+
+
+
Value
+
+
Key list
+
+
+
+
Value
+
+
Key list
+
+
+
+
0
+
+
display.KEY_NONE
+
+
+
+
82
+
+
display.KEY_ENTER
+
+
+
+
65
+
+
display.KEY_RANGEUP
+
+
+
+
85
+
+
display.KEY_RECALL
+
+
+
+
68
+
+
display.KEY_MENU
+
+
+
+
86
+
+
display.KEY_MEASA
+
+
+
+
69
+
+
display.KEY_MODEA
+
+
+
+
87
+
+
display.KEY_DIGITSA
+
+
+
+
70
+
+
display.KEY_RELA
+
+
+
+
88
+
+
display.KEY_OUTPUTA
+
+
+
+
71
+
+
display.KEY_RUN
+
+
+
+
92
+
+
display.KEY_TRIG
+
+
+
+
72
+
+
display.KEY_DISPLAY
+
+
+
+
93
+
+
display.KEY_LIMITA
+
+
+
+
73
+
+
display.KEY_AUTO
+
+
+
+
94
+
+
display.KEY_SPEEDA
+
+
+
+
75
+
+
display.KEY_EXIT
+
+
+
+
95
+
+
display.KEY_LOAD
+
+
+
+
77
+
+
display.KEY_FILTERA
+
+
+
+
97
+
+
display.WHEEL_ENTER
+
+
+
+
78
+
+
display.KEY_STORE
+
+
+
+
103
+
+
display.KEY_RIGHT
+
+
+
+
79
+
+
display.KEY_SRCA
+
+
+
+
104
+
+
display.KEY_LEFT
+
+
+
+
80
+
+
display.KEY_CONFIG
+
+
+
+
107
+
+
display.WHEEL_LEFT
+
+
+
+
81
+
+
display.KEY_RANGEDOWN
+
+
+
+
114
+
+
display.WHEEL_RIGHT
+
+
+
+
+
+
When using this function, use built-in constants such as display.KEY_RIGHT (rather than the numeric value of 103). This will allow for better forward compatibility with firmware revisions.
+
Example
+
+
+
+
display.sendkey(display.KEY_RUN)
+
+
Simulates pressing the RUN key.
+
+
+
+
+
Also see
+
Front panel
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This attribute enables or disables the reading buffer cache (on or off).
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Not applicable
+
+
Not saved
+
+
1 (enabled)
+
+
+
+
+
Usage
+
cacheMode = bufferVar.cachemode
+
bufferVar.cachemode = cacheMode
+
+
+
+
cacheMode
+
+
The reading buffer cache mode; set to one of the following:
+
0: Cache mode disabled (off)
1: Cache mode enabled (on)
+
+
+
bufferVar
+
+
The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer
+
+
+
+
+
Details
+
Assigning a value to this attribute enables or disables the reading buffer cache. When enabled, the reading buffer cache improves access speed to reading buffer data.
+
If you run successive operations that overwrite reading buffer data, the reading buffer may return stale cache data. This can happen when initiating successive sweeps without reconfiguring the sweep measurements or when overwriting data in the reading buffer by setting the bufferVar.fillmode attribute to smuX.FILL_WINDOW. To avoid this, make sure that you include commands that automatically invalidate the cache as needed (for example, explicit calls to the bufferVar.clearcache() function) or disable the cache using this attribute (bufferVar.cachemode).
+
Example
+
+
+
+
smua.nvbuffer1.cachemode = 1
+
+
Enables reading buffer cache of dedicated reading buffer 1.
The compliance limit value; set to one of the following values:
+
Voltage compliance: 0 V to 40 V
+
Current compliance: 0 A to 20 A
+
Set power compliance in watts
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)
+
+
+
+
Y
+
+
SMU function (v = voltage, i = current, p = power)
+
+
+
+
+
Details
+
Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU will always choose (autorange) the source range for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.
+
This attribute should be set in the test sequence before the turning the source on.
+
Using a limit value of 0 will result in an error code 1102, "Parameter too small," for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU will adjust the source limit where appropriate to limit the output to the specified power. The SMU will use the lower of the programmed compliance value (the compliance level that would be used if power compliance were disabled) or the limit calculated from the power compliance setting.
+
Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.
+
Example
+
+
+
+
smua.source.limitv = 30
+
+
Sets voltage source compliance of SMU channel A to 30 V.
The severity level (0, 10, 20, 30, or 40); see Details for more information
+
+
+
+
errorNode
+
+
The node number where the error originated
+
+
+
+
+
Details
+
Entries are stored in a first-in, first-out (FIFO) queue. This functions reads the oldest entry and removes it from the queue.
+
Error codes and messages are listed in the Error and status messages topics.
+
If there are no entries in the queue, code 0, "Queue is Empty" is returned.
+
Returned severity levels are described in the following table.
+
+
+
+
+
+
+
+
+
Severity level descriptions
+
+
+
+
Number
+
+
Level
+
+
Description
+
+
+
+
0
+
+
Informational
+
+
Indicates that there are no entries in the queue.
+
+
+
+
10
+
+
Informational
+
+
Indicates a status message or minor error.
+
+
+
+
20
+
+
Recoverable
+
+
Indicates possible invalid user input; operation continues but action should be taken to correct the error.
+
+
+
+
30
+
+
Serious
+
+
Indicates a serious error that may require technical assistance, such as corrupted data.
+
+
+
+
40
+
+
Fatal
+
+
Indicates that the Model 2651A is nonoperational and requires service. Contact information for service is provided at the front of this manual. Examples: “Bad SMU AFPGA image size,” “SMU is unresponsive,” and “Communication Timeout with DFPGA.”
+
+
+
+
+
In an expanded system, each TSP‑Link enabled instrument is assigned a node number.The variable errorNode stores the node number where the error originated.
+
Example
+
+
+
+
errorcode, message = errorqueue.next()
+
print(errorcode, message)
+
+
Reads the oldest entry in the error queue. The output below indicates that the queue is empty.
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2651A/17268.html b/WebHelpDocs/Commands_2651A/17268.html
new file mode 100644
index 0000000..80c8ee8
--- /dev/null
+++ b/WebHelpDocs/Commands_2651A/17268.html
@@ -0,0 +1,42 @@
+
+
+ Controlling the instrument by sending individual command messages
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Controlling the instrument by sending individual command messages
+
The simplest method of controlling an instrument through the communication interface is to send it a message that contains remote commands. You can use a test program that resides on a computer (the controller) to sequence the actions of the instrument.
+
Remote commands can be function-based or attribute-based. Function-based commands are commands that control actions or activities. Attribute-based commands define characteristics of an instrument feature or operation.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This attribute stores the service request (SRQ) enable register.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
+
Usage
+
requestSRQEnableRegister = status.request_enable
+
status.request_enable = requestSRQEnableRegister
+
+
+
+
requestSRQEnableRegister
+
+
The service request (SRQ) enable register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
+
Details
+
This attribute is used to read or write to the service request enable register. Reading the service request enable register returns a value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000 0001. This value indicates that bit B0 and bit B7 are set.
+
+
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
+
+
+
* Least significant bit ** Most significant bit
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
status.MEASUREMENT_SUMMARY_BIT
+
status.MSB
+
+
Set summary bit indicates that an enabled event in the Measurement Event Register has occurred.
+
Bit B0 decimal value: 1
+
+
+
+
B1
+
+
status.SYSTEM_SUMMARY_BIT
+
status.SSB
+
+
Set summary bit indicates that an enabled event in the System Summary Register has occurred.
+
Bit B1 decimal value: 2
+
+
+
+
B2
+
+
status.ERROR_AVAILABLE
+
status.EAV
+
+
Set summary bit indicates that an error or status message is present in the Error Queue.
+
Bit B2 decimal value: 4
+
+
+
+
B3
+
+
status.QUESTIONABLE_SUMMARY_BIT
+
status.QSB
+
+
Set summary bit indicates that an enabled event in the Questionable Status Register has occurred.
+
Bit B3 decimal value: 8
+
+
+
+
B4
+
+
status.MESSAGE_AVAILABLE
+
status.MAV
+
+
Set summary bit indicates that a response message is present in the Output Queue.
+
Bit B4 decimal value: 16
+
+
+
+
B5
+
+
status.EVENT_SUMMARY_BIT
+
status.ESB
+
+
Set summary bit indicates that an enabled event in the Standard Event Status Register has occurred.
+
Bit B5 decimal value: 32
+
+
+
+
B6
+
+
Not used
+
+
Not applicable
+
+
+
+
B7
+
+
status.OPERATION_SUMMARY_BIT
+
status.OSB
+
+
Set summary bit indicates that an enabled event in the Operation Status Register has occurred.
+
Bit B7 decimal value: 128
+
+
+
+
+
+
As an example, to set bit B0 of the service request enable register, set status.request_enable = status.MSB.
+
In addition to the above values, requestSRQEnableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set requestSRQEnableRegister to the sum of their decimal weights. For example, to set bits B0 and B7, set requestSRQEnableRegister to 129 (1 + 128).
This attribute stores the service request (SRQ) event register.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Not applicable
+
+
Not saved
+
+
0
+
+
+
+
+
Usage
+
requestSRQEventRegister = status.request_event
+
+
+
+
requestSRQEventRegister
+
+
The request event register's status; a zero (0) indicates no bits set; other values indicate various bit settings
+
+
+
+
+
Details
+
This attribute is used to read the service request event register, which is returned as a numeric value. Reading this register returns a value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000 0001. This value indicates that bit B0 and bit B7 are set.
+
+
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
+
+
+
* Least significant bit ** Most significant bit
+
The returned value can indicate one or more status events occurred.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
status.MEASUREMENT_SUMMARY_BIT
+
status.MSB
+
+
Set summary bit indicates that an enabled event in the Measurement Event Register has occurred.
+
Bit B0 decimal value: 1
+
+
+
+
B1
+
+
status.SYSTEM_SUMMARY_BIT
+
status.SSB
+
+
Set summary bit indicates that an enabled event in the System Summary Register has occurred.
+
Bit B1 decimal value: 2
+
+
+
+
B2
+
+
status.ERROR_AVAILABLE
+
status.EAV
+
+
Set summary bit indicates that an error or status message is present in the Error Queue.
+
Bit B2 decimal value: 4
+
+
+
+
B3
+
+
status.QUESTIONABLE_SUMMARY_BIT
+
status.QSB
+
+
Set summary bit indicates that an enabled event in the Questionable Status Register has occurred.
+
Bit B3 decimal value: 8
+
+
+
+
B4
+
+
status.MESSAGE_AVAILABLE
+
status.MAV
+
+
Set summary bit indicates that a response message is present in the Output Queue.
+
Bit B4 decimal value: 16
+
+
+
+
B5
+
+
status.EVENT_SUMMARY_BIT
+
status.ESB
+
+
Set summary bit indicates that an enabled event in the Standard Event Status Register has occurred.
+
Bit B5 decimal value: 32
+
+
+
+
B6
+
+
Not used
+
+
Not applicable
+
+
+
+
B7
+
+
status.OPERATION_SUMMARY_BIT
+
status.OSB
+
+
Set summary bit indicates that an enabled event in the Operation Status Register has occurred.
+
Bit B7 decimal value: 128
+
+
+
+
+
+
In addition to the above constants, requestEventRegister can be set to the decimal equivalent of the bit(s) set. When more than one bit of the register is set, requestEventRegister contains the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).
+
+
+
+
Bit
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
128
+
+
64
+
+
32
+
+
16
+
+
8
+
+
4
+
+
2
+
+
1
+
+
+
+
Weights
+
+
(27)
+
+
(26)
+
+
(25)
+
+
(24)
+
+
(23)
+
+
(22)
+
+
(21)
+
+
(20)
+
+
+
+
+
Example
+
+
+
+
requestEventRegister = status.request_event
+
print(requestEventRegister)
+
+
Reads the status request event register.
+
Sample output: 1.29000e+02
+
Converting this output (129) to its binary equivalent yields: 1000 0001
+
Therefore, this output indicates that the set bits of the status request event register are presently B0 (MSB) and B7 (OSB).
This attribute contains the write‑protect mask that protects bits from changes by the tsplink.writebit() and tsplink.writeport() functions.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset Recall setup
+
+
Saved setup
+
+
0
+
+
+
+
+
Usage
+
mask = tsplink.writeprotect
+
tsplink.writeprotect = mask
+
+
+
+
mask
+
+
An integer that specifies the value of the bit pattern for write‑protect; set bits to 1 to write‑protect the corresponding TSP-Link trigger line
+
+
+
+
+
Details
+
The binary equivalent of mask indicates the mask to be set for the TSP-Link trigger line. For example, a mask value of 5 has a binary equivalent 101. This mask write‑protects TSP-Link trigger lines 1 and 3.
TSP-enabled instruments do not have inherent query commands. Like any other scripting environment, the print() command and other related print() commands generate output. The print() command creates one response message.
+
The output from multiple arguments are separated with a tab character.
+
Numbers are printed using the format.asciiprecision attribute. If you want use Lua formatting, print the return value from the tostring() function.
+
Example 1
+
+
+
+
x = 10
+
print(x)
+
+
Example of an output response message:
+
1.00000e+01
+
Note that your output might be different if you set your ASCII precision setting to a different value.
This attribute specifies events that cause this trigger to assert.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset LAN trigger N reset Recall setup
+
+
Not saved
+
+
0
+
+
+
+
+
Usage
+
triggerStimulus = lan.trigger[N].stimulus
+
lan.trigger[N].stimulus = triggerStimulus
+
+
+
+
triggerStimulus
+
+
The LAN event identifier used to trigger the event.
+
+
+
+
N
+
+
A number specifying the trigger packet over the LAN for which to set or query the trigger source (1 to 8).
+
+
+
+
+
Details
+
This attribute specifies which event causes a LAN trigger packet to be sent for this trigger. Set triggerStimulus to one of the existing trigger event IDs shown in the following table.
+
+
+
+
+
+
+
Trigger event IDs*
+
+
+
+
Event ID
+
+
Event description
+
+
+
+
smua.trigger.SWEEPING_EVENT_ID
+
+
Occurs when the source‑measure unit (SMU) transitions from the idle state to the arm layer of the trigger model
+
+
+
+
smua.trigger.ARMED_EVENT_ID
+
+
Occurs when the SMU moves from the arm layer to the trigger layer of the trigger model
+
+
+
+
smua.trigger.SOURCE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a source action
+
+
+
+
smua.trigger.MEASURE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a measure action
+
+
+
+
smua.trigger.PULSE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a pulse
+
+
+
+
smua.trigger.SWEEP_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a sweep
+
+
+
+
smua.trigger.IDLE_EVENT_ID
+
+
Occurs when the SMU returns to the idle state
+
+
+
+
digio.trigger[N].EVENT_ID
+
+
Occurs when an edge is detected on a digital I/O line
+
+
+
+
tsplink.trigger[N].EVENT_ID
+
+
Occurs when an edge is detected on a TSP‑Link line
+
+
+
+
lan.trigger[N].EVENT_ID
+
+
Occurs when the appropriate LXI trigger packet is received on LAN trigger object N
+
+
+
+
display.trigger.EVENT_ID
+
+
Occurs when the TRIG key on the front panel is pressed
+
+
+
+
trigger.EVENT_ID
+
+
Occurs when a *TRG command is received on the remote interface
+
(GPIB only) Occurs when a GET bus command is received
+
(VXI-11 only) Occurs with the VXI-11 command device_trigger; reference the VXI-11 standard for additional details on the device trigger operation
+
+
+
+
trigger.blender[N].EVENT_ID
+
+
Occurs after a collection of events is detected
+
+
+
+
trigger.timer[N].EVENT_ID
+
+
Occurs when a delay expires
+
+
+
+
+
+
+
+
* Use the name of the trigger event ID to set the stimulus value rather than the numeric value. Using the name makes the code compatible for future upgrades (for example, if the numeric values must change when enhancements are added to the instrument).
+
+
+
+
+
+
Setting this attribute to zero disables automatic trigger generation.
+
If any events are detected prior to calling lan.trigger[N].connect(), the event is ignored and the action overrun is set.
This attribute specifies the event that causes the synchronization line to assert a trigger.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset Recall setup TSP-Link trigger N reset
+
+
Not saved
+
+
0
+
+
+
+
+
Usage
+
eventID = tsplink.trigger[N].stimulus
+
tsplink.trigger[N].stimulus = eventID
+
+
+
+
eventID
+
+
The event identifier for the triggering event
+
+
+
+
N
+
+
The trigger line (1 to 3)
+
+
+
+
+
Details
+
To disable automatic trigger assertion on the synchronization line, set this attribute to zero (0).
+
Do not use this attribute when triggering under script control. Use tsplink.trigger[N].assert() instead.
+
The eventIDparameter may be one of the existing trigger event IDs shown in the following table.
+
+
+
+
+
+
+
Trigger event IDs*
+
+
+
+
Event ID
+
+
Event description
+
+
+
+
smua.trigger.SWEEPING_EVENT_ID
+
+
Occurs when the source‑measure unit (SMU) transitions from the idle state to the arm layer of the trigger model
+
+
+
+
smua.trigger.ARMED_EVENT_ID
+
+
Occurs when the SMU moves from the arm layer to the trigger layer of the trigger model
+
+
+
+
smua.trigger.SOURCE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a source action
+
+
+
+
smua.trigger.MEASURE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a measure action
+
+
+
+
smua.trigger.PULSE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a pulse
+
+
+
+
smua.trigger.SWEEP_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a sweep
+
+
+
+
smua.trigger.IDLE_EVENT_ID
+
+
Occurs when the SMU returns to the idle state
+
+
+
+
digio.trigger[N].EVENT_ID
+
+
Occurs when an edge is detected on a digital I/O line
+
+
+
+
tsplink.trigger[N].EVENT_ID
+
+
Occurs when an edge is detected on a TSP‑Link line
+
+
+
+
lan.trigger[N].EVENT_ID
+
+
Occurs when the appropriate LXI trigger packet is received on LAN trigger object N
+
+
+
+
display.trigger.EVENT_ID
+
+
Occurs when the TRIG key on the front panel is pressed
+
+
+
+
trigger.EVENT_ID
+
+
Occurs when a *TRG command is received on the remote interface
+
(GPIB only) Occurs when a GET bus command is received
+
(VXI-11 only) Occurs with the VXI-11 command device_trigger; reference the VXI-11 standard for additional details on the device trigger operation
+
+
+
+
trigger.blender[N].EVENT_ID
+
+
Occurs after a collection of events is detected
+
+
+
+
trigger.timer[N].EVENT_ID
+
+
Occurs when a delay expires
+
+
+
+
+
+
+
+
* Use the name of the trigger event ID to set the stimulus value rather than the numeric value. Using the name makes the code compatible for future upgrades (for example, if the numeric values must change when enhancements are added to the instrument).
+
+
+
+
+
+
Example
+
+
+
+
print(tsplink.trigger[3].stimulus)
+
+
Prints the event that will start TSP-Link trigger line 3 action.
This attribute specifies which events trigger the blender.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset Recall setup Trigger blender N reset
+
+
Not saved
+
+
0
+
+
+
+
+
Usage
+
eventID = trigger.blender[N].stimulus[M]
+
trigger.blender[N].stimulus[M] = eventID
+
+
+
+
eventID
+
+
The event that triggers the blender action; see Details
+
+
+
+
N
+
+
An integer representing the trigger event blender (1 to 4)
+
+
+
+
M
+
+
An integer representing the stimulus index (1 to 4)
+
+
+
+
+
Details
+
There are four acceptors that can each select a different event. The eventID parameter can be the event ID of any trigger event.
+
Use zero to disable the blender input.
+
The eventID parameter may be one of the existing trigger event IDs shown in the following table.
+
+
+
+
+
+
+
Trigger event IDs*
+
+
+
+
Event ID
+
+
Event description
+
+
+
+
smua.trigger.SWEEPING_EVENT_ID
+
+
Occurs when the source‑measure unit (SMU) transitions from the idle state to the arm layer of the trigger model
+
+
+
+
smua.trigger.ARMED_EVENT_ID
+
+
Occurs when the SMU moves from the arm layer to the trigger layer of the trigger model
+
+
+
+
smua.trigger.SOURCE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a source action
+
+
+
+
smua.trigger.MEASURE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a measure action
+
+
+
+
smua.trigger.PULSE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a pulse
+
+
+
+
smua.trigger.SWEEP_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a sweep
+
+
+
+
smua.trigger.IDLE_EVENT_ID
+
+
Occurs when the SMU returns to the idle state
+
+
+
+
digio.trigger[N].EVENT_ID
+
+
Occurs when an edge is detected on a digital I/O line
+
+
+
+
tsplink.trigger[N].EVENT_ID
+
+
Occurs when an edge is detected on a TSP‑Link line
+
+
+
+
lan.trigger[N].EVENT_ID
+
+
Occurs when the appropriate LXI trigger packet is received on LAN trigger object N
+
+
+
+
display.trigger.EVENT_ID
+
+
Occurs when the TRIG key on the front panel is pressed
+
+
+
+
trigger.EVENT_ID
+
+
Occurs when a *TRG command is received on the remote interface
+
(GPIB only) Occurs when a GET bus command is received
+
(VXI-11 only) Occurs with the VXI-11 command device_trigger; reference the VXI-11 standard for additional details on the device trigger operation
+
+
+
+
trigger.blender[N].EVENT_ID
+
+
Occurs after a collection of events is detected
+
+
+
+
trigger.timer[N].EVENT_ID
+
+
Occurs when a delay expires
+
+
+
+
+
+
+
+
* Use the name of the trigger event ID to set the stimulus value rather than the numeric value. Using the name makes the code compatible for future upgrades (for example, if the numeric values must change when enhancements are added to the instrument).
This attribute specifies which event starts the timer.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset Recall setup Trigger timer N reset
+
+
Not saved
+
+
0
+
+
+
+
+
Usage
+
eventID = trigger.timer[N].stimulus
+
trigger.timer[N].stimulus = eventID
+
+
+
+
eventID
+
+
The event that triggers the timer delay
+
+
+
+
N
+
+
Trigger timer number (1 to 4)
+
+
+
+
+
Details
+
The eventIDparameter may be one of the trigger event IDs shown in the following table.
+
+
+
+
+
+
+
Trigger event IDs*
+
+
+
+
Event ID
+
+
Event description
+
+
+
+
smua.trigger.SWEEPING_EVENT_ID
+
+
Occurs when the source‑measure unit (SMU) transitions from the idle state to the arm layer of the trigger model
+
+
+
+
smua.trigger.ARMED_EVENT_ID
+
+
Occurs when the SMU moves from the arm layer to the trigger layer of the trigger model
+
+
+
+
smua.trigger.SOURCE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a source action
+
+
+
+
smua.trigger.MEASURE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a measure action
+
+
+
+
smua.trigger.PULSE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a pulse
+
+
+
+
smua.trigger.SWEEP_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a sweep
+
+
+
+
smua.trigger.IDLE_EVENT_ID
+
+
Occurs when the SMU returns to the idle state
+
+
+
+
digio.trigger[N].EVENT_ID
+
+
Occurs when an edge is detected on a digital I/O line
+
+
+
+
tsplink.trigger[N].EVENT_ID
+
+
Occurs when an edge is detected on a TSP‑Link line
+
+
+
+
lan.trigger[N].EVENT_ID
+
+
Occurs when the appropriate LXI trigger packet is received on LAN trigger object N
+
+
+
+
display.trigger.EVENT_ID
+
+
Occurs when the TRIG key on the front panel is pressed
+
+
+
+
trigger.EVENT_ID
+
+
Occurs when a *TRG command is received on the remote interface
+
(GPIB only) Occurs when a GET bus command is received
+
(VXI-11 only) Occurs with the VXI-11 command device_trigger; reference the VXI-11 standard for additional details on the device trigger operation
+
+
+
+
trigger.blender[N].EVENT_ID
+
+
Occurs after a collection of events is detected
+
+
+
+
trigger.timer[N].EVENT_ID
+
+
Occurs when a delay expires
+
+
+
+
+
+
+
+
* Use the name of the trigger event ID to set the stimulus value rather than the numeric value. Using the name makes the code compatible for future upgrades (for example, if the numeric values must change when enhancements are added to the instrument).
+
+
+
+
+
+
Set this attribute to the eventID of any trigger event to cause the timer to start when that event occurs.
+
Use zero (0) to disable event processing.
+
Example
+
+
+
+
print(trigger.timer[1].stimulus)
+
+
Prints the event that will start a trigger 1 timer action.
This function generates output in the form of a sequence of response messages (one message for each line of the script). It also generates output of the script control messages (loadscript or loadandrunscript, and endscript).
+
Example
+
+
+
+
test7 = script.new("display.clear() display.settext('Hello from my test')", "test7")
+
test7()
+
test7.save()
+
test7.list()
+
+
+
+
+
The above example code creates a script named "test7" that displays text on the front panel, lists the script with the following output:
+
loadscript test7
+
display.clear() display.settext("Hello from my test")
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2651A/17789.html b/WebHelpDocs/Commands_2651A/17789.html
new file mode 100644
index 0000000..9ba1103
--- /dev/null
+++ b/WebHelpDocs/Commands_2651A/17789.html
@@ -0,0 +1,42 @@
+
+
+ Information on scripting and programming
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Information on scripting and programming
+
If you need information about using scripts with Model 2651A, see Fundamentals of scripting for TSP.
+
If you need information about using the Lua programming language with Model 2651A, see Fundamentals of programming for TSP.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2651A/17852.html b/WebHelpDocs/Commands_2651A/17852.html
new file mode 100644
index 0000000..7755cdf
--- /dev/null
+++ b/WebHelpDocs/Commands_2651A/17852.html
@@ -0,0 +1,44 @@
+
+
+ Using the command reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Using the command reference
+
The command reference contains detailed descriptions of each of the commands you can use to control your Model 2651A. Each command description is broken into several standardized subsections. The figure below shows an example of a command description.
+
+
Each command listing is divided into five major categories of information about the command:
+
Command name and summary table
Usage
Details
Example
Also see
The content of each of these categories is described in the following topics.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2651A/17853.html b/WebHelpDocs/Commands_2651A/17853.html
new file mode 100644
index 0000000..a0ef0d6
--- /dev/null
+++ b/WebHelpDocs/Commands_2651A/17853.html
@@ -0,0 +1,43 @@
+
+
+ Command name and summary table
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Command name and summary table
+
Each instrument command description starts with the command name, followed by a table with relevant information for each command. Definitions for the numbered items in the figure below are listed following the figure.
+
+
Instrument command name. Signals the beginning of the command description and is followed by a brief description of what the command does.
Type of command. Options are:
Function. Function-based commands control actions or activities, but are not always directly related to instrument operation. Function names are always followed by a set of parentheses, for example, digio.writeport(15). If the function does not need a parameter, the parentheses set remains empty, for example, exit().
Attribute (R),(RW), or (W). Attribute-based commands set or read the characteristics of an instrument feature or operation by defining a value. For example, a characteristic of a TSP‑enabled instrument is the model number (localnode.model); another characteristic is the number of errors in the error queue (errorqueue.count). For many attributes, the defined value is a number or predefined constant. Attributes can be read-only (R), read-write (RW), or write-only (W), and can be used as a parameter of a function or assigned to another variable.
Constant. A constant command represents a fixed value when used in a script.
TSP-Link accessible. Yes or No; indicates whether or not the command can accessed through a TSP-Link network.
Affected by. Commands or actions that have a direct effect on the instrument command.
LAN restore defaults
Recall setup
Instrument reset: An instrument reset can be invoked by reset(), localnode.reset(), or *RST.
Where saved. Indicates where the command settings reside once they are used on an instrument. Options include:
Not saved: Command is not saved anywhere and must be typed each time you use it.
Nonvolatile memory: Storage area in the instrument where information is saved when the instrument is turned off.
Saved setup
Default value: Lists the default value or constant for the command. The parameter values are defined in the Usage or Details sections of the command description.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
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: 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.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This manual uses italicized text to represent the parts of remote commands that must be replaced by user specified values. The following examples show typical uses of italicized text:
+
Example 1:
+
gpib.address = address
+
Where:
+
address is an integer (0 to 30) that you specify. For example, to set this attribute to 15 you would send:
+
gpib.address = 15
+
Example 2:
+
digio.trigger[N].assert()
+
Where:
+
N is an integer (1 to 14) that you specify. For example, to assert trigger line 7 you would send:
+
digio.trigger[7].assert()
+
To assert a trigger line with a variable as the integer, you would send:
+
triggerline = 7
+
digio.trigger[triggerline].assert()
+
Example 3:
+
smuX.trigger.measure.Y(rbuffer)
+
Where:
+
X is refers to the source‑measure unit (SMU) channel (use a for SMU A).
+
Y is the measurement type that you specify (v, i, r, or p).
+
rbuffer is the reading buffer object where the readings will be stored.
+
For example, to use SMU A to take voltage measurements and store them in buffer vbuffername, you would send:
+
smua.trigger.measure.v(vbuffername)
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
The following table lists syntax requirements to build well-formed instrument control commands.
+
+
+
+
+
+
+
+
Syntax rules for instrument commands
+
+
+
+
Syntax rule
+
+
Details
+
+
Examples
+
+
+
+
Case sensitivity: Instrument commands are case sensitive.
+
+
For best results, simply match the case shown in the command reference descriptions.
+
+
+
Function and attribute names should be in lowercase characters.
+
+
An example of the scriptVar.save() function (where test8 is the name of the script):
+
test8.save()
+
+
+
+
Parameters can use a combination of lowercase and uppercase characters.
+
+
Attribute constants use uppercase characters
+
+
+
In the command below, which sets the format of data transmitted from the instrument to double‑precision floating point, format.REAL64 is the attribute constant and format.data is the attribute command:
+
format.data = format.REAL64
+
+
+
+
White space: Not required in a function.
+
+
Functions can be sent with or without white spaces.
+
+
The following functions, which set digital I/O line 3 low, are equivalent:
+
digio.writebit(3,0)
+
digio.writebit (3, 0)
+
+
+
+
Function parameters: All functions are required to have a set of parentheses () immediately following the function.
+
+
You can specify the function parameters by placing them between the parentheses. Note that the parentheses are required even when there are no parameters specified.
+
+
The following function specifies all overlapped commands in the nodes in group G must complete before commands from other groups can execute:
+
waitcomplete(G)
+
+
The command below reads the value of the local time zone (no parameters are needed):
+
timezone = localnode.gettimezone()
+
+
+
+
Multiple parameters: Must be separated by commas (,).
+
+
Some commands require multiple parameters, which must be separated by commas (,).
+
+
This command sets the beeper to emit a double‑beep at 2400 Hz, with a beep sequence of 0.5 seconds on, 0.25 seconds off, and then 0.5 seconds on:
+
beeper.beep(0.5, 2400)
+
delay(0.250)
+
beeper.beep(0.5, 2400)
+
+
+
+
+
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This attribute sets the reading buffer fill count.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Not applicable
+
+
See Details
+
+
0
+
+
+
+
+
Usage
+
fillCount = bufferVar.fillcount
+
bufferVar.fillcount = fillCount
+
+
+
+
fillCount
+
+
The reading buffer fill count
+
+
+
+
bufferVar
+
+
The reading buffer; can be a dynamically allocated buffer (user‑defined), or a dedicated reading buffer (such as smua.nvbuffer1)
+
+
+
+
+
Details
+
The reading buffer fill count sets the number of readings to store before restarting at index 1. If the value is zero (0), then the capacity of the buffer is used. Use this attribute to control when the SMU restarts filling the buffer at index 1, rather than having it restart when the buffer is full.
+
If the bufferVar.fillcount attribute is set to a value higher than the capacity of the buffer, after storing the element at the end of the buffer, the SMU will overwrite the reading at index 1, the reading after that will overwrite the reading at index 2, and so on.
+
This attribute is only used when the bufferVar.fillmode attribute is set to smuX.FILL_WINDOW.
+
For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.
+
Example
+
+
+
+
smua.nvbuffer1.fillcount = 50
+
+
Sets fill count of dedicated reading buffer 1 to 50.
The reading buffer fill mode; set to one of the following:
+
0 or smuX.FILL_ONCE: Do not overwrite old data
1 or smuX.FILL_WINDOW: New readings restart at index 1 after acquiring reading at index bufferVar.fillcount
+
+
+
bufferVar
+
+
The reading buffer; can be a dynamically allocated buffer (user‑defined), or a dedicated reading buffer (such as smua.nvbuffer1)
+
+
+
+
+
Details
+
When this attribute is set to smuX.FILL_ONCE, the reading buffer will not overwrite readings. If the buffer fills up, new readings will be discarded.
+
When this attribute is set to smuX.FILL_WINDOW, new readings will be added after existing data until the buffer holds bufferVar.fillcount elements. Continuing the sequence, the next reading will overwrite the reading at index 1, the reading after that will overwrite the reading at index 2, and so on.
+
For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.
+
Example
+
+
+
+
smua.nvbuffer1.fillmode = smua.FILL_ONCE
+
+
Sets fill mode of dedicated reading buffer 1 to fill once (do not overwrite old data).
This function returns a specified reading buffer's statistics.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
statistics = smuX.buffer.getstats(bufferVar)
+
+
+
+
statistics
+
+
The reading buffer's statistics
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.buffer.getstats() specifies SMU channel A)
+
+
+
+
bufferVar
+
+
The reading buffer to process
+
+
+
+
+
Details
+
This function returns a table with statistical data about the data placed in the buffer.
+
The SMU will automatically update reading buffer statistics as data is added to the reading buffer. When the reading buffer is configured to wrap around and overwrite older data with new data, the buffer statistics will include the data that was overwritten.
+
The table returned from this function is a snapshot. Although the SMU continues to update the statistics, the table returned will not be updated. To get fresh statistics, call this function again.
+
The statistics parameter has the following attributes:
+
+
+
+
Attribute
+
+
When returned
+
+
Description
+
+
+
+
n
+
+
Always
+
+
The number of data points on which the statistics are based
+
+
+
+
mean
+
+
When n > 0
+
+
The average of all readings added to the buffer
+
+
+
+
stddev
+
+
When n > 1
+
+
The standard deviation of all readings (samples) added to the buffer
+
+
+
+
min
+
+
When n > 0
+
+
A table containing data about the minimum reading value added to the buffer
+
+
+
+
max
+
+
When n > 0
+
+
A table containing data about the maximum reading value added to the buffer
+
+
+
+
+
If n equals zero (0), all other attributes will be nil because there is no data to base any statistics on. If n equals 1, the stddev attribute will be nil because the standard deviation of a sample size of 1 is undefined.
+
The min and max entries each have the following attributes:
+
+
+
+
Attribute
+
+
Description
+
+
+
+
measurefunction
+
+
String indicating the function measured for the reading (current, voltage, ohms or watts)
+
+
+
+
measurerange
+
+
The full-scale range value for the measure range used when the measurement was made
+
+
+
+
reading
+
+
The reading value
+
+
+
+
sourcefunction
+
+
String indicating the source function at the time of the measurement (current or voltage)
+
+
+
+
sourceoutputstate
+
+
String indicating the state of the source (off or on)
+
+
+
+
sourcerange
+
+
Full-scale range value for the source range used when the measurement was made
+
+
+
+
sourcevalue
+
+
If bufferVar.collectsourcevalues is enabled, the sourced value in effect at the time of the reading
+
+
+
+
status
+
+
Status value for the reading; the status value is a floating-point number that encodes the status value into a floating-point value
+
+
+
+
timestamp
+
+
If bufferVar.collecttimestamps is enabled, the timestamp, in seconds, between when the reading was acquired and when the first reading in the buffer was acquired; adding this value to the base timestamp will give the actual time the measurement was acquired
This function recalculates the specified reading buffer's statistics.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
smuX.buffer.recalculatestats(bufferVar)
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.buffer.recalculatestats() specifies SMU channel A)
+
+
+
+
bufferVar
+
+
The reading buffer to process
+
+
+
+
+
Details
+
This function will cause the SMU to regenerate the reading buffer statistics on the specified reading buffer. As the SMU automatically updates reading buffer statistics as data is added to the reading buffer, this function is generally not needed. When the reading buffer is configured to wrap around and overwrite older data with new data, the buffer statistics will include the data that was overwritten. Use this function to recalculate the statistics including only the data that is currently stored in the buffer.
The Model 2651A has two analog-to-digital converters (ADC): An integrating ADC and a fast ADC.
+
The integrating ADC uses a ratiometric analog-to-digital conversion technique. Depending on the configuration of the integrating ADC, periodic fresh reference measurements are required to minimize drift. The measurement aperture is used to determine the time interval between these measurement updates. For additional information, see Autozero. To help optimize operation of this ADC, the instrument caches the reference and zero values for up to ten of the most recent number of power line cycles. For additional information, see NPLC caching.
+
The fast ADC can acquire measurements at speeds up to 1 million samples per second. The fast ADC does not take reference measurements. A reading measurement acquisition buffer allows up to 5,000 readings to be made at the maximum acquisition rate of the fast ADCs. If this buffer is filled, the instrument slows its acquisition rate to the rate at which the instrument can process the data.
+
Data acquisition takes priority over both source operation and display operation. Sustained high data acquisition rates will cause the display to stop updating. A sustained high data acquisition rate during a sweep or pulse train may slow source operations. This can cause erratic sweep or pulse timing and may lead to triggers being missed (trigger overruns). Use the status model to monitor for trigger overruns. If a high sustained data acquisition rate causes undesirable sweep or pulse timing, reduce the data acquisition rate or reduce the total number of measurements until the desired sweep or pulse timing is achieved.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This function is identical to the script.new() function, but it creates a script with the autorun attribute set to "yes".
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
scriptVar = script.newautorun(code)
+
scriptVar = script.newautorun(code, name)
+
+
+
+
scriptVar
+
+
The name of the variable that will reference the script
+
+
+
+
code
+
+
A string containing the body of the script
+
+
+
+
name
+
+
The name of the script
+
+
+
+
+
Details
+
The script.newautorun() function is identical to the script.new()function, except that the autorun attribute of the script is set to yes. The script is also automatically run immediately after it is created.
+
Example
+
+
+
+
NewAuto = script.newautorun("print('Hello from new auto run command')", 'NewAuto')
+
print(NewAuto.autorun)
+
print(NewAuto.name)
+
+
+
+
Creates a new script called NewAuto that automatically has the autorun attribute set to yes after it is created. The name attribute's value is set to "NewAuto".
Each time the script.run() command is given, the anonymous script is executed. This script can be run using this command many times without having to re-send it.
This KISweep factory script function performs a voltage list sweep with current measured at every step (point).
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
SweepVListMeasureI(smu, vlist, stime, points)
+
+
+
+
smu
+
+
System SourceMeter® instrument channel (set to smua)
+
+
+
+
vlist
+
+
Arbitrary list of voltage source values; vlist = {value1, value2, ... valueN}
+
+
+
+
stime
+
+
Settling time in seconds; occurs after stepping the source and before performing a measurement
+
+
+
+
points
+
+
Number of sweep points (must be =2)
+
+
+
+
+
Details
+
Data for current measurements, voltage source values, and timestamps are stored in smuX.nvbuffer1.
+
If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.
+
Performs a voltage list sweep with current measured at every step (point):
+
1. Sets the smu to output vlist volts value, allows the source to settle for stime seconds, and then performs a current measurement.
+
2. Sets the smu to output the next vlist volts value, allows the source to settle for stime seconds, and then performs a current measurement.
+
3. Repeats the above sequence until the current is measured for the last volts value. The last point in the list to be measured is points.
+
Example
+
+
+
+
myvlist = {-0.1, 0.1, -1, 1, -6, 6, -40,
+
40, 0, 0}
+
+
SweepVListMeasureI(smua, myvlist,
+
500E-3, 10)
+
+
This function performs a 10‑point voltage list sweep starting at the first point in myvlist. Current is measured at every step (point) in the sweep. The source will be allowed to settle on each step for 500 ms before a measurement is performed.
+
+
+
+
+
Also see
+
None
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This function adds an entry to the User menu, which can be accessed by pressing the LOAD key on the instrument front panel.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
display.loadmenu.add(displayName, code)
+
display.loadmenu.add(displayName, code, memory)
+
+
+
+
displayName
+
+
The name that is added to the User menu
+
+
+
+
code
+
+
The code that is run from the User menu
+
+
+
+
memory
+
+
Determines if code is saved to nonvolatile memory:
+
0 or display.DONT_SAVE: Does not save the code to nonvolatile memory
+
1 or display.SAVE: Saves the code to nonvolatile memory (default)
+
+
+
+
+
Details
+
After adding code to the load menu, you can run it from the front panel by pressing the LOAD key, then selecting USER to select from the available code to load. Pressing the RUN key will then run the script.
+
You can add items in any order. They are always displayed in alphabetical order when the menu is selected.
+
Any Lua code can be can be included in the code parameter. If memory is set to display.SAVE, the entry (name and code) is saved in nonvolatile memory. Scripts, functions, and variables used in the code are not saved by display.SAVE. Functions and variables need to be saved with the code. If the code is not saved in nonvolatile memory, it will be lost when the Model 2651A is turned off. See Example 2 below.
+
If you do not make a selection for memory, the code is automatically saved to nonvolatile memory.
+
You can create a script that defines several functions, and then use the display.loadmenu.add() command to add items that call those individual functions. This allows the operator to run tests from the front panel.
+
Example 1
+
+
+
+
display.loadmenu.add("Test9", "Test9()")
+
+
Assume a user script named "Test9" has been loaded into the run-time environment. Adds the menu entry to the User menu to run the script after loading.
Assume a script with a function named “DUT1” has already been loaded into the instrument, and the script has NOT been saved in nonvolatile memory.
+
Now assume you want to add a test named “Test” to the USER TESTS menu. You want the test to run the function named “DUT1” and sound the beeper. This example adds “Test” to the menu, defines the code, and then saves the displayName and code in nonvolatile memory.
+
When “Test” is run from the front panel USER TESTS menu, the function named “DUT1” executes and the beeper beeps for two seconds.
+
Now assume you turn off instrument power. Because the script was not saved in nonvolatile memory, the function named “DUT1” is lost when you turn the instrument on. When “Test” is again run from the front panel, an error is generated because DUT1 no longer exists in the instrument as a function.
This function performs calibration of the fast analog-to-digital converter (fast ADC).
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
smuX.cal.fastadc()
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.cal.fastadc() specifies SMU channel A).
+
+
+
+
+
Details
+
This function automatically performs all the steps required to calibrate the fast ADC. This function uses the readings obtained when calibrating the measure ranges (make sure both voltage and current calibration has been completed before calling this function).
This attribute sets the source function used (source 0 A or 0 V) when the output is turned off and the source‑measure unit (SMU) is in normal output-off mode.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU reset Instrument reset Recall setup
+
+
Saved setup
+
+
1 (smuX.OUTPUT_DCVOLTS)
+
+
+
+
+
Usage
+
offfunc = smuX.source.offfunc
+
smuX.source.offfunc = offfunc
+
+
+
+
offfunc
+
+
Set to the source function to be used when the output is off and the SMU is in normal output-off mode. Set to one of the following values:
+
0 or smuX.OUTPUT_DCAMPS: Source 0 A
+
1 or smuX.OUTPUT_DCVOLTS: Source 0 V
+
+
+
+
X
+
+
SMU channel (for example, smua.source.offfunc applies to SMU channel A)
+
+
+
+
+
Details
+
This attribute controls the source function used when the output is turned off and the smuX.source.offmode is set to smuX.OUTPUT_NORMAL. Set this attribute to smuX.OUTPUT_DCVOLTS for the source to be a 0 V source when the output is off (smuX.source.offlimiti is used). Set it to smuX.OUTPUT_DCAMPS for the source to be a 0 A source when the output is off (smuX.source.offlimitv is used).
+
This attribute is only used when the smuX.source.offmode attribute is set to smuX.OUTPUT_NORMAL.
+
Example
+
+
+
+
smua.source.offfunc = smua.OUTPUT_DCVOLTS
+
+
Sets the normal output-off mode to source 0 V when the output is turned off for SMU channel A.
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2651A/19514.html b/WebHelpDocs/Commands_2651A/19514.html
new file mode 100644
index 0000000..27fff19
--- /dev/null
+++ b/WebHelpDocs/Commands_2651A/19514.html
@@ -0,0 +1,44 @@
+
+
+ Advanced features for KIPulse tag parameter pulse functions
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Advanced features for KIPulse tag parameter pulse functions
+
Variable off time between pulses in a pulse train
+
The KIPulse “Configure” functions will accept the toff parameter as a table, or as a number. The table allows you to define different off times to be used after each pulse. The following should be noted:
+
If toff is passed as a number or only a single value is used in the table, it will be used for all points in a multiple point pulse.
The number of times specified in the table must match the number of points called for in the sweep.
The times used in tables must match for dual channel pulsing.
Each specified off time must adhere to the duty cycle limits for the specified pulsing region.
Simultaneous IV measurement during pulse
+
The KIPulse “Configure” functions will optionally accept an extra reading buffer to activate simultaneous IV measurements during pulsing. Previous usage of passing in a reading buffer or a nil (for no measurement) is still supported.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
Use the saved setups commands to save and restore the configuration of the instrument. You can restore (or save) configurations from the instrument's nonvolatile memory or an installed USB flash drive. You can use the setup.poweron attribute to specify which setup is recalled when the instrument is turned on.
This attribute selects the event that causes a trigger to be asserted on the digital output line.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset Digital I/O trigger N reset Recall setup
+
+
Not saved
+
+
0
+
+
+
+
+
Usage
+
triggerStimulus = digio.trigger[N].stimulus
+
digio.trigger[N].stimulus = triggerStimulus
+
+
+
+
triggerStimulus
+
+
The event identifier for the triggering event
+
+
+
+
N
+
+
Digital I/O trigger line (1 to 14)
+
+
+
+
+
Details
+
Set this attribute to zero (0) to disable the automatic trigger output.
+
Do not use the stimulus attribute for generating output triggers under script control. Use digio.trigger[N].assert() instead.
+
The trigger stimulus for a digital I/O linemay be set to one of the existing trigger event IDs, described in the following table.
+
+
+
+
+
+
+
Trigger event IDs*
+
+
+
+
Event ID
+
+
Event description
+
+
+
+
smua.trigger.SWEEPING_EVENT_ID
+
+
Occurs when the source‑measure unit (SMU) transitions from the idle state to the arm layer of the trigger model
+
+
+
+
smua.trigger.ARMED_EVENT_ID
+
+
Occurs when the SMU moves from the arm layer to the trigger layer of the trigger model
+
+
+
+
smua.trigger.SOURCE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a source action
+
+
+
+
smua.trigger.MEASURE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a measure action
+
+
+
+
smua.trigger.PULSE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a pulse
+
+
+
+
smua.trigger.SWEEP_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a sweep
+
+
+
+
smua.trigger.IDLE_EVENT_ID
+
+
Occurs when the SMU returns to the idle state
+
+
+
+
digio.trigger[N].EVENT_ID
+
+
Occurs when an edge is detected on a digital I/O line
+
+
+
+
tsplink.trigger[N].EVENT_ID
+
+
Occurs when an edge is detected on a TSP‑Link line
+
+
+
+
lan.trigger[N].EVENT_ID
+
+
Occurs when the appropriate LXI trigger packet is received on LAN trigger object N
+
+
+
+
display.trigger.EVENT_ID
+
+
Occurs when the TRIG key on the front panel is pressed
+
+
+
+
trigger.EVENT_ID
+
+
Occurs when a *TRG command is received on the remote interface
+
(GPIB only) Occurs when a GET bus command is received
+
(VXI-11 only) Occurs with the VXI-11 command device_trigger; reference the VXI-11 standard for additional details on the device trigger operation
+
+
+
+
trigger.blender[N].EVENT_ID
+
+
Occurs after a collection of events is detected
+
+
+
+
trigger.timer[N].EVENT_ID
+
+
Occurs when a delay expires
+
+
+
+
+
+
+
+
* Use the name of the trigger event ID to set the stimulus value rather than the numeric value. Using the name makes the code compatible for future upgrades (for example, if the numeric values must change when enhancements are added to the instrument).
+
+
+
+
+
+
Example 1
+
+
+
+
digio.trigger[3].stimulus = 0
+
+
Clear the trigger stimulus of digital I/O line 3.
+
+
+
+
+
Example 2
+
+
+
+
digio.trigger[3].stimulus =
+
smua.trigger.SOURCE_COMPLETE_EVENT_ID
+
+
Set the trigger stimulus of digital I/O line 3 to be the source complete event.
The measure delay is a specific delay applied before each measurement is taken. This delay is disabled by default (measurements are taken immediately). You can change the default delay by setting the smuX.measure.delay attribute either to a specific value or to an auto delay setting (set smuX.measure.delay = smuX.DELAY_AUTO). If the measure delay is set to the auto delay setting, a range-dependent delay is applied each time the instrument performs a current measurement, or after changing current ranges during an autoranged measurement. The following table contains the measure auto delays associated with each current range.
+
+
+
Range
+
+
Measure auto delay
+
+
+
+
10 mA (and above)
+
+
0 ms (no delay)
+
+
+
+
1 mA
+
+
100 ms
+
+
+
+
100 mA
+
+
150 ms
+
+
+
+
10 mA
+
+
500 ms
+
+
+
+
1 mA
+
+
2.5 ms
+
+
+
+
100 nA
+
+
15 ms
+
+
+
+
+
You can increase or decrease the auto delay by changing the delay factor (for example, to reduce the delay across all ranges by half, set smuX.measure.delayfactor = 0.5). For additional information, refer to smuX.measure.delayfactor.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This attribute contains the measurement range values that were used for readings stored in a specified buffer.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Clearing the buffer
+
+
See Details
+
+
Not applicable
+
+
+
+
+
Usage
+
measurerange = bufferVar.measureanges[N]
+
+
+
+
measurerange
+
+
The measurement range used to acquire reading number N in the specified buffer
+
+
+
+
bufferVar
+
+
The reading buffer; can be a dynamically allocated buffer (user‑defined), or a dedicated reading buffer (such as smua.nvbuffer1)
+
+
+
+
N
+
+
The reading number (1 to bufferVar.n)
+
+
+
+
+
+
Details
+
The measureranges buffer recall attribute is like an array (a Lua table) of full-scale range values for the measure range used when the measurement was made.
+
For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.
+
+
Example
+
+
+
+
measurerange = smua.nvbuffer1.measureranges[1]
+
+
+
Store the measure range that was used to make reading number 1.
+
+
+
+
printbuffer(1, 10, smua.nvbuffer1.measureranges)
+
+
Print the range values that were used for the first 10 readings saved in dedicated reading buffer 1.
This attribute indicates the state of the source output for readings stored in a specified buffer.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Clearing the buffer
+
+
See Details
+
+
Not applicable
+
+
+
+
+
Usage
+
state = bufferVar.sourceoutputstates[N]
+
+
+
+
state
+
+
The output state ("Off" or "On") when reading N of the specified buffer was acquired
+
+
+
+
bufferVar
+
+
The reading buffer; can be a dynamically allocated buffer (user‑defined), or a dedicated reading buffer (such as smua.nvbuffer1)
+
+
+
+
N
+
+
The reading number (1 to bufferVar.n)
+
+
+
+
+
Details
+
The sourceoutputstates buffer recall attribute is like an array (a Lua table) of strings indicating the state of the source output ("Off" or "On") at the time of the measurement.
+
For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.
This attribute contains the source range that was used for readings stored in a specified reading buffer.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Clearing the buffer
+
+
See Details
+
+
Not applicable
+
+
+
+
+
Usage
+
sourcerange = bufferVar.sourceranges[N]
+
+
+
+
sourcerange
+
+
The source range used to acquire reading number N in the specified buffer
+
+
+
+
bufferVar
+
+
The reading buffer; can be a dynamically allocated buffer (user‑defined), or a dedicated reading buffer (such as smua.nvbuffer1)
+
+
+
+
N
+
+
The reading number (1 to bufferVar.n)
+
+
+
+
+
Details
+
The sourceranges buffer recall attribute is like an array (a Lua table) of full-scale range values for the source range used when the measurement was made.
+
For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.
+
+
Example 1
+
+
+
+
sourcerange = smua.nvbuffer1.sourceranges[1]
+
+
+
Store the source range that was used for the first reading stored in dedicated reading buffer 1.
+
+
+
+
+
Example 2
+
+
+
+
printbuffer(1, 6, smua.nvbuffer1.sourceranges)
+
+
Print the source ranges that were used for the first 6 readings stored in source‑measure unit (SMU) A, buffer 1.
When enabled by the bufferVar.collectsourcevalues attribute, this attribute contains the source levels being output when readings in the reading buffer were acquired.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Clearing the buffer
+
+
See Details
+
+
Not applicable
+
+
+
+
+
Usage
+
sourcevalue = bufferVar.sourcevalues[N]
+
+
+
+
sourcevalue
+
+
The source's output value when reading N of the specified buffer was acquired
+
+
+
+
bufferVar
+
+
The reading buffer; can be a dynamically allocated buffer (user‑defined), or a dedicated reading buffer (such as smua.nvbuffer1)
+
+
+
+
N
+
+
The reading number (1 to bufferVar.n)
+
+
+
+
+
Details
+
If the bufferVar.collectsourcevalues attribute is enabled before readings are taken, the bufferVar.sourcevalues buffer recall attribute is like an array (a Lua table) of the sourced value in effect at the time of the reading. Note that you can set the bufferVar.collectsourcevalues attribute only if the affected reading buffer is empty. See bufferVar.collectsourcevalues for more detailed information.
+
For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.
+
Example 1
+
+
+
+
sourcevalue = smua.nvbuffer1.sourcevalues[1]
+
+
+
Get the sourced value of the first reading stored in dedicated reading buffer 1.
+
+
+
+
+
Example 2
+
+
+
+
printbuffer(1, 6, smua.nvbuffer1.sourcevalues)
+
+
Print the sourced value of the first 6 readings stored in source‑measure unit (SMU) A, buffer 1.
This attribute contains the readings stored in a specified reading buffer.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Clearing the buffer
+
+
See Details
+
+
Not applicable
+
+
+
+
+
Usage
+
reading = bufferVar.readings[N]
+
+
+
+
reading
+
+
The value of the reading in the specified reading buffer
+
+
+
+
bufferVar
+
+
The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer
+
+
+
+
N
+
+
The reading number (1 to bufferVar.n)
+
+
+
+
+
Details
+
The readings buffer recall attribute is like an array (a Lua table) of the readings stored in the reading buffer. This array holds the same data that is returned when the reading buffer is accessed directly; that is, rb[2] and rb.readings[2] access the same value.
+
For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.
+
Example
+
+
+
+
print(smua.nvbuffer1.readings[1])
+
+
Output the first reading saved in dedicated reading buffer 1.
This attribute contains the status values of readings in the reading buffer.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Clearing the buffer
+
+
See Details
+
+
Not applicable
+
+
+
+
+
Usage
+
statusInformation = bufferVar.statuses[N]
+
+
+
+
statusInformation
+
+
The status value when reading N of the specified buffer was acquired
+
+
+
+
bufferVar
+
+
The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer
+
+
+
+
N
+
+
The reading number (1 to bufferVar.n)
+
+
+
+
+
Details
+
This read‑only buffer recall attribute is like an array (a Lua table) of the status values for all of the readings in the buffer. The status values are floating-point numbers that encode the status value; see the following table for values.
+
For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.
When enabled by the bufferVar.collecttimestamps attribute, this attribute contains the timestamp (in seconds) of when each reading saved in the specified reading buffer occurred.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Clearing the buffer
+
+
See Details
+
+
Not applicable
+
+
+
+
+
Usage
+
timestamp = bufferVar.timestamps[N]
+
+
+
+
timestamp
+
+
The timestamp of reading number N in the specified buffer when the reading was acquired
+
+
+
+
bufferVar
+
+
The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer
+
+
+
+
N
+
+
The reading number (1 to bufferVar.n)
+
+
+
+
+
Details
+
The bufferVar.timestamps information from a reading buffer is only available if the bufferVar.collecttimestamps attribute is set to 1 (default setting). If it is set to 0, you will not be able to access any time information from a reading buffer.
+
If enabled, this buffer recall attribute is like an array (a Lua table) containing timestamps, in seconds, of when each reading occurred. These are relative to the bufferVar.basetimestamp for the buffer. See Reading buffer commands for more information.
+
For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.
+
Example
+
+
+
+
timestamp = smua.nvbuffer1.timestamps[1]
+
+
+
Get the timestamp of the first reading stored in dedicated reading buffer 1.
This function returns an iterator that can be used in a for loop to iterate over all the factory scripts.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
for name in script.factory.catalog() do body end
+
+
+
+
name
+
+
String representing the name of the script
+
+
+
+
body
+
+
Code that implements the body of the for loop to process the names in the catalog
+
+
+
+
+
Details
+
Accessing this catalog of scripts allows you to process the factory scripts. The entries will be enumerated in no particular order.
+
Each time the body of the function executes, name takes on the name of one of the factory scripts. The for loop repeats until all scripts have been iterated.
+
Example
+
+
+
+
for name in script.factory.catalog() do
+
print(name)
+
end
+
+
Retrieve the catalog listing for factory scripts.
+
+
+
+
+
Also see
+
None
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This function captures the key code value for the next front‑panel action.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
keyCode = display.waitkey()
+
+
+
+
keyCode
+
+
See Details for more information
+
+
+
+
+
Details
+
After you send this function, script execution pauses until a front‑panel action (for example, pressing a key or the navigation wheel , or turning the navigation wheel ). After the action, the value of the key (or action) is returned.
+
If the EXIT (LOCAL) key is pressed while this function is waiting for a front‑panel action, the script is not aborted.
+
The table below lists the keyCode value for each front panel action.
+
+
+
+
+
+
+
+
+
+
+
Key codes
+
+
+
+
Value
+
+
Key (or action)
+
+
+
+
Value
+
+
Key (or action)
+
+
+
+
0
+
+
display.KEY_NONE
+
+
+
+
82
+
+
display.KEY_ENTER
+
+
+
+
65
+
+
display.KEY_RANGEUP
+
+
+
+
85
+
+
display.KEY_RECALL
+
+
+
+
68
+
+
display.KEY_MENU
+
+
+
+
86
+
+
display.KEY_MEASA
+
+
+
+
69
+
+
display.KEY_MODEA
+
+
+
+
86
+
+
display.KEY_DIGITSA
+
+
+
+
70
+
+
display.KEY_RELA
+
+
+
+
88
+
+
display.KEY_OUTPUTA
+
+
+
+
71
+
+
display.KEY_RUN
+
+
+
+
92
+
+
display.KEY_TRIG
+
+
+
+
72
+
+
display.KEY_DISPLAY
+
+
+
+
93
+
+
display.KEY_LIMITA
+
+
+
+
73
+
+
display.KEY_AUTO
+
+
+
+
94
+
+
display.KEY_SPEEDA
+
+
+
+
75
+
+
display.KEY_EXIT
+
+
+
+
95
+
+
display.KEY_LOAD
+
+
+
+
77
+
+
display.KEY_FILTERA
+
+
+
+
97
+
+
display.WHEEL_ENTER
+
+
+
+
78
+
+
display.KEY_STORE
+
+
+
+
103
+
+
display.KEY_RIGHT
+
+
+
+
79
+
+
display.KEY_SRCA
+
+
+
+
104
+
+
display.KEY_LEFT
+
+
+
+
80
+
+
display.KEY_CONFIG
+
+
+
+
107
+
+
display.WHEEL_LEFT
+
+
+
+
81
+
+
display.KEY_RANGEDOWN
+
+
+
+
114
+
+
display.WHEEL_RIGHT
+
+
+
+
+
When using this function, use built-in constants such as display.KEY_RIGHT (rather than the numeric value of 103). This will allow for better forward compatibility with firmware revisions.
+
Example
+
+
+
+
key = display.waitkey()
+
print(key)
+
+
Pause script execution until the operator presses a key or the navigation wheel, or rotates the navigation wheel.
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2651A/2408.html b/WebHelpDocs/Commands_2651A/2408.html
new file mode 100644
index 0000000..ab1efe5
--- /dev/null
+++ b/WebHelpDocs/Commands_2651A/2408.html
@@ -0,0 +1,44 @@
+
+
+ Delete user scripts from the instrument
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Delete user scripts from the instrument
+
In most circumstances, you can delete a script using script.delete() (as described in Delete user scripts), and then turn the instrument off and back on again. However, if you cannot turn the instrument off, you can use the following steps to completely remove a script from the instrument.
+
When you completely remove a script, you delete all references to the script from the run-time environment, the script.user.scripts table, and nonvolatile memory.
+
To completely remove a script:
+
Remove the script from the run-time environment. Set any variables that refer to the script to nil or assign the variables a different value. For example, to remove the script "beepTwoSec" from the run-time environment, send the following code: beepTwoSec = nil
Remove the script from the script.user.scripts table. Set the name attribute to an empty string (""). This makes the script nameless, but does not make the script become the anonymous script. For example, to remove the script named "beepTwoSec", send the following code: script.user.scripts.beepTwoSec.name = ""
Remove the script from nonvolatile memory. To delete the script from nonvolatile memory, send the command: script.delete("name")
Where name is the name that the script was saved as. For example, to delete beepTwoSec, you would send: script.delete("beepTwoSec")
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This library provides generic functions for string manipulation.
+
+
+
+
+
+
+
+
Base library functions
+
+
+
+
Function
+
+
Description
+
+
+
+
collectgarbage()
+
collectgarbage(limit)
+
+
Sets the garbage-collection threshold to the given limit (in kilobytes) and checks it against the byte counter. If the new threshold is smaller than the byte counter, Lua immediately runs the garbage collector. If there is no limit parameter, it defaults to zero (0), which forces a garbage‑collection cycle. See Lua memory management for more information.
+
+
+
+
gcinfo()
+
+
Returns the number of kilobytes of dynamic memory that the Test Script Processor (TSP®) scripting engine is using, and returns the current garbage collector threshold (also in kilobytes). See Lua memory management for more information.
+
+
+
+
tonumber(x)
+
tonumber(x, base)
+
+
Returns x converted to a number. If x is already a number, or a convertible string, the number is returned; otherwise, it returns nil.
+
An optional argument specifies the base to interpret the numeral. The base may be any integer between 2 and 36, inclusive. In bases above 10, the letter A (in either upper or lower case) represents 10, B represents 11, and so forth, with Z representing 35. In base 10, the default, the number may have a decimal part, as well as an optional exponent. In other bases, only unsigned integers are accepted.
+
+
+
+
tostring(x)
+
+
Receives an argument of any type and converts it to a string in a reasonable format.
+
+
+
+
type(v)
+
+
Returns the type of its only argument, coded as a string. The possible results of this function are "nil" (a string, not the value nil), "number", "string", "boolean", "table", "function", "thread", and "userdata".
+
+
+
+
+
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This attribute contains the name of a script in the run-time environment.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
No
+
+
Not applicable
+
+
Not applicable
+
+
Not applicable
+
+
+
+
+
Usage
+
scriptVar.name = scriptName
+
scriptName= scriptVar.name
+
+
+
+
scriptVar
+
+
Name of the variable that references the script
+
+
+
+
scriptName
+
+
A string that represents the name of the script
+
+
+
+
+
Details
+
When setting the script name, this attribute renames the script that the variable scriptVar references.
+
This attribute must be either a valid Lua identifier or the empty string. Changing the name of a script changes the index used to access the script in the script.user.scripts table. Setting the attribute to an empty string removes the script from the table completely, and the script becomes an unnamed script.
+
As long as there are variables referencing an unnamed script, the script can be accessed through those variables. When all variables that reference an unnamed script are removed, the script will be removed from the run‑time environment.
+
If the new name is the same as a name that is already used for another script, the name of the other script is set to an empty string, and that script becomes unnamed.
+
Changing the name of a script does not change the name of any variables that reference that script. The variables will still reference the script, but the names of the script and variables may not match.
+
Example
+
+
+
+
test7 = script.new("display.clear() display.settext('Hello from my test')", "")
+
test7()
+
print(test7.name)
+
+
test7.name = "test7"
+
print(test7.name)
+
test7.save()
+
+
+
+
The above example calls the script.new() function to create a script with no name, runs the script, names the script "test7", and then saves the script in nonvolatile memory.
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2651A/2600s-901-01b_kipulsetsptestscript_configpulseimeasurev.png b/WebHelpDocs/Commands_2651A/2600s-901-01b_kipulsetsptestscript_configpulseimeasurev.png
new file mode 100644
index 0000000..2739799
Binary files /dev/null and b/WebHelpDocs/Commands_2651A/2600s-901-01b_kipulsetsptestscript_configpulseimeasurev.png differ
diff --git a/WebHelpDocs/Commands_2651A/2600s-901-01b_kipulsetsptestscript_configpulseimeasurevsweeplin.png b/WebHelpDocs/Commands_2651A/2600s-901-01b_kipulsetsptestscript_configpulseimeasurevsweeplin.png
new file mode 100644
index 0000000..f268ce5
Binary files /dev/null and b/WebHelpDocs/Commands_2651A/2600s-901-01b_kipulsetsptestscript_configpulseimeasurevsweeplin.png differ
diff --git a/WebHelpDocs/Commands_2651A/2600s-901-01b_kipulsetsptestscript_configpulseimeasurevsweeplog.png b/WebHelpDocs/Commands_2651A/2600s-901-01b_kipulsetsptestscript_configpulseimeasurevsweeplog.png
new file mode 100644
index 0000000..930ebad
Binary files /dev/null and b/WebHelpDocs/Commands_2651A/2600s-901-01b_kipulsetsptestscript_configpulseimeasurevsweeplog.png differ
diff --git a/WebHelpDocs/Commands_2651A/2600s-901-01b_kipulsetsptestscript_configpulsevmeasurei.png b/WebHelpDocs/Commands_2651A/2600s-901-01b_kipulsetsptestscript_configpulsevmeasurei.png
new file mode 100644
index 0000000..708807d
Binary files /dev/null and b/WebHelpDocs/Commands_2651A/2600s-901-01b_kipulsetsptestscript_configpulsevmeasurei.png differ
diff --git a/WebHelpDocs/Commands_2651A/2600s-901-01b_kipulsetsptestscript_configpulsevmeasureisweeplin.png b/WebHelpDocs/Commands_2651A/2600s-901-01b_kipulsetsptestscript_configpulsevmeasureisweeplin.png
new file mode 100644
index 0000000..51868e5
Binary files /dev/null and b/WebHelpDocs/Commands_2651A/2600s-901-01b_kipulsetsptestscript_configpulsevmeasureisweeplin.png differ
diff --git a/WebHelpDocs/Commands_2651A/2600s-901-01b_kipulsetsptestscript_configpulsevmeasureisweeplog.png b/WebHelpDocs/Commands_2651A/2600s-901-01b_kipulsetsptestscript_configpulsevmeasureisweeplog.png
new file mode 100644
index 0000000..55ede99
Binary files /dev/null and b/WebHelpDocs/Commands_2651A/2600s-901-01b_kipulsetsptestscript_configpulsevmeasureisweeplog.png differ
diff --git a/WebHelpDocs/Commands_2651A/2600s-901-01b_kisweeptsptestscript_pulseimeasurev.png b/WebHelpDocs/Commands_2651A/2600s-901-01b_kisweeptsptestscript_pulseimeasurev.png
new file mode 100644
index 0000000..c0eaeed
Binary files /dev/null and b/WebHelpDocs/Commands_2651A/2600s-901-01b_kisweeptsptestscript_pulseimeasurev.png differ
diff --git a/WebHelpDocs/Commands_2651A/2600s-901-01b_kisweeptsptestscript_pulsevmeasurei.png b/WebHelpDocs/Commands_2651A/2600s-901-01b_kisweeptsptestscript_pulsevmeasurei.png
new file mode 100644
index 0000000..df85cbe
Binary files /dev/null and b/WebHelpDocs/Commands_2651A/2600s-901-01b_kisweeptsptestscript_pulsevmeasurei.png differ
diff --git a/WebHelpDocs/Commands_2651A/2600s-901-01b_kisweeptsptestscript_sweepilinmeasurev.png b/WebHelpDocs/Commands_2651A/2600s-901-01b_kisweeptsptestscript_sweepilinmeasurev.png
new file mode 100644
index 0000000..2d0d7ac
Binary files /dev/null and b/WebHelpDocs/Commands_2651A/2600s-901-01b_kisweeptsptestscript_sweepilinmeasurev.png differ
diff --git a/WebHelpDocs/Commands_2651A/2600s-901-01b_kisweeptsptestscript_sweepilogmeasurev.png b/WebHelpDocs/Commands_2651A/2600s-901-01b_kisweeptsptestscript_sweepilogmeasurev.png
new file mode 100644
index 0000000..cb12355
Binary files /dev/null and b/WebHelpDocs/Commands_2651A/2600s-901-01b_kisweeptsptestscript_sweepilogmeasurev.png differ
diff --git a/WebHelpDocs/Commands_2651A/2600s-901-01b_kisweeptsptestscript_sweepvlinmeasurei.png b/WebHelpDocs/Commands_2651A/2600s-901-01b_kisweeptsptestscript_sweepvlinmeasurei.png
new file mode 100644
index 0000000..ad242bf
Binary files /dev/null and b/WebHelpDocs/Commands_2651A/2600s-901-01b_kisweeptsptestscript_sweepvlinmeasurei.png differ
diff --git a/WebHelpDocs/Commands_2651A/2600s-901-01b_kisweeptsptestscript_sweepvlogmeasurei.png b/WebHelpDocs/Commands_2651A/2600s-901-01b_kisweeptsptestscript_sweepvlogmeasurei.png
new file mode 100644
index 0000000..5e1e3c5
Binary files /dev/null and b/WebHelpDocs/Commands_2651A/2600s-901-01b_kisweeptsptestscript_sweepvlogmeasurei.png differ
diff --git a/WebHelpDocs/Commands_2651A/26xxas-901-01e_fourquadrantsofoperation.png b/WebHelpDocs/Commands_2651A/26xxas-901-01e_fourquadrantsofoperation.png
new file mode 100644
index 0000000..f5b0415
Binary files /dev/null and b/WebHelpDocs/Commands_2651A/26xxas-901-01e_fourquadrantsofoperation.png differ
diff --git a/WebHelpDocs/Commands_2651A/26xxicldescription-table.png b/WebHelpDocs/Commands_2651A/26xxicldescription-table.png
new file mode 100644
index 0000000..a01ef6b
Binary files /dev/null and b/WebHelpDocs/Commands_2651A/26xxicldescription-table.png differ
diff --git a/WebHelpDocs/Commands_2651A/3249.html b/WebHelpDocs/Commands_2651A/3249.html
new file mode 100644
index 0000000..6704587
--- /dev/null
+++ b/WebHelpDocs/Commands_2651A/3249.html
@@ -0,0 +1,62 @@
+
+
+ Removing stale values from the reading buffer cache
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Removing stale values from the reading buffer cache
+
The node that acquires the data stores the data for the reading buffer. To optimize data access, all nodes can cache data from the node that stores the reading buffer data.
+
Running Lua code remotely can cause reading buffer data that is held in the cache to become stale. If the values in the reading buffer change while the Lua code runs remotely, another node can hold stale values. Use the clearcache() command to clear the cache. In addition, if the cachemode of a reading buffer is enabled, you might need to use the clearcache() command to avoid getting stale data. For additional detail on the reading buffer cache commands, see bufferVar.cachemode and bufferVar.clearcache().
+
The following example code demonstrates how stale values occur and how to use the clearcache() command to clear the cache on node 2, which is part of group 7.
+
-- Create a reading buffer on a node in a remote group.
Test Script Processor (TSP®) enabled instruments do not have inherent query commands. Like any other scripting environment, the print() command and other related commands generate output in the form of response messages. Each print() command creates one response message.
+
Example
+
+
+
+
x = 10
+
print(x)
+
+
Example of an output response message:
+
1.00000e+01
+
Note that your output might be different if you set your ASCII precision setting to a different value.
+
+
+
+
+
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2651A/3700S_toc.xml b/WebHelpDocs/Commands_2651A/3700S_toc.xml
new file mode 100644
index 0000000..e69de29
diff --git a/WebHelpDocs/Commands_2651A/492.html b/WebHelpDocs/Commands_2651A/492.html
new file mode 100644
index 0000000..e3360d8
--- /dev/null
+++ b/WebHelpDocs/Commands_2651A/492.html
@@ -0,0 +1,94 @@
+
+
+ Attributes
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Attributes
+
Attribute-based commands are commands that set the characteristics of an instrument feature or operation. For example, some characteristics of TSP‑enabled instruments are the model number (localnode.model) and the number of errors in the error queue (errorqueue.count).
+
+
To set the characteristics, attribute-based commands define a value. For many attributes, the value is in the form of a number or a predefined constant.
+
Example 1: Set an attribute using a number
+
+
+
+
format.data = 3
+
+
This attribute sets the format of data printed by other commands. Setting this attribute to 3 sets the print format to double precision floating point format.
+
+
+
+
+
+
Example 2: Set an attribute using a constant
+
+
+
+
format.data = format.REAL64
+
+
Using the constant REAL64 instead of 3 also sets the print format to double precision floating point format.
+
+
+
+
+
+
+
To read an attribute, you can use the attribute as the parameter of a function, or assign it to another variable.
+
Example 3: Read an attribute using a function
+
+
+
+
print(format.data)
+
+
Reads the data format by passing the attribute to the print function. If the data format is set to 3, the output is:
+
3.00000e+00
+
This shows that the data format is set to double precision floating point.
+
+
+
+
+
Example 4: Read an attribute using a variable
+
+
+
+
fd = format.data
+
+
This reads the data format by assigning the attribute to a variable named fd.
+
+
+
+
+
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2651A/70xbicldescription-alsosee.png b/WebHelpDocs/Commands_2651A/70xbicldescription-alsosee.png
new file mode 100644
index 0000000..1397cad
Binary files /dev/null and b/WebHelpDocs/Commands_2651A/70xbicldescription-alsosee.png differ
diff --git a/WebHelpDocs/Commands_2651A/70xbicldescription-details.png b/WebHelpDocs/Commands_2651A/70xbicldescription-details.png
new file mode 100644
index 0000000..bd2d2ec
Binary files /dev/null and b/WebHelpDocs/Commands_2651A/70xbicldescription-details.png differ
diff --git a/WebHelpDocs/Commands_2651A/70xbicldescription-example.png b/WebHelpDocs/Commands_2651A/70xbicldescription-example.png
new file mode 100644
index 0000000..637d749
Binary files /dev/null and b/WebHelpDocs/Commands_2651A/70xbicldescription-example.png differ
diff --git a/WebHelpDocs/Commands_2651A/70xbicldescription-usage.png b/WebHelpDocs/Commands_2651A/70xbicldescription-usage.png
new file mode 100644
index 0000000..1f043c7
Binary files /dev/null and b/WebHelpDocs/Commands_2651A/70xbicldescription-usage.png differ
diff --git a/WebHelpDocs/Commands_2651A/AfterPublish.bat b/WebHelpDocs/Commands_2651A/AfterPublish.bat
new file mode 100644
index 0000000..7558f57
--- /dev/null
+++ b/WebHelpDocs/Commands_2651A/AfterPublish.bat
@@ -0,0 +1,19 @@
+::--------------------------------------------------
+:: AfterPublishing.bat - Runs OracleToEclipse
+::--------------------------------------------------
+
+@echo off
+
+::Get the current batch file's short path
+for %%x in (%0) do set BatchPath=%%~dpsx
+for %%x in (%BatchPath%) do set BatchPath=%%~dpsx
+echo BatchPath = %BatchPath%
+
+echo "Enter ShortName (2600A, 3700, 707B, 2651A, 2657A):"
+set /p ShortName=
+
+echo "ShortName is " %ShortName%
+
+cd %BatchPath%
+OracleToEclipse toc.xml %ShortName%
+
diff --git a/WebHelpDocs/Commands_2651A/Model 2651A help files.hs b/WebHelpDocs/Commands_2651A/Model 2651A help files.hs
new file mode 100644
index 0000000..3c625b0
--- /dev/null
+++ b/WebHelpDocs/Commands_2651A/Model 2651A help files.hs
@@ -0,0 +1,25 @@
+
+
+
+
+Model 2651A help files
+
+
+
+ O19545
+
+
+
+
+
+
+ oracle.help.navigator.tocNavigator.TOCNavigator
+ toc.xml
+
+
+
+ oracle.help.navigator.searchNavigator.SearchNavigator
+ search.idx
+
+
+
diff --git a/WebHelpDocs/Commands_2651A/OracleToEclipse.exe b/WebHelpDocs/Commands_2651A/OracleToEclipse.exe
new file mode 100644
index 0000000..696ed36
Binary files /dev/null and b/WebHelpDocs/Commands_2651A/OracleToEclipse.exe differ
diff --git a/WebHelpDocs/Commands_2651A/OracleToEclipse.xslt b/WebHelpDocs/Commands_2651A/OracleToEclipse.xslt
new file mode 100644
index 0000000..9c676b8
--- /dev/null
+++ b/WebHelpDocs/Commands_2651A/OracleToEclipse.xslt
@@ -0,0 +1,28 @@
+
+
+
+
+
+
+
+
+ /.html
+
+
+
+
+
+
+
+
+ _toc.xml
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/WebHelpDocs/Commands_2651A/cautionhelp.png b/WebHelpDocs/Commands_2651A/cautionhelp.png
new file mode 100644
index 0000000..6856d76
Binary files /dev/null and b/WebHelpDocs/Commands_2651A/cautionhelp.png differ
diff --git a/WebHelpDocs/Commands_2651A/contents1.gif b/WebHelpDocs/Commands_2651A/contents1.gif
new file mode 100644
index 0000000..18ec664
Binary files /dev/null and b/WebHelpDocs/Commands_2651A/contents1.gif differ
diff --git a/WebHelpDocs/Commands_2651A/contents2.gif b/WebHelpDocs/Commands_2651A/contents2.gif
new file mode 100644
index 0000000..aac2736
Binary files /dev/null and b/WebHelpDocs/Commands_2651A/contents2.gif differ
diff --git a/WebHelpDocs/Commands_2651A/contents3.gif b/WebHelpDocs/Commands_2651A/contents3.gif
new file mode 100644
index 0000000..9fef3ca
Binary files /dev/null and b/WebHelpDocs/Commands_2651A/contents3.gif differ
diff --git a/WebHelpDocs/Commands_2651A/dhtml_search.htm b/WebHelpDocs/Commands_2651A/dhtml_search.htm
new file mode 100644
index 0000000..b0845da
--- /dev/null
+++ b/WebHelpDocs/Commands_2651A/dhtml_search.htm
@@ -0,0 +1,12 @@
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/WebHelpDocs/Commands_2651A/dhtml_search.js b/WebHelpDocs/Commands_2651A/dhtml_search.js
new file mode 100644
index 0000000..f7f61b7
--- /dev/null
+++ b/WebHelpDocs/Commands_2651A/dhtml_search.js
@@ -0,0 +1,609 @@
+/* Generated with Author-it 5.4.131.8883 2/10/2012 4:49:36 PM */
+Page=new Array();Page[0]=new Array("Keithley Instruments Test Script Processor (TSP®) enabled instruments operate like conventional instruments by responding to a sequence of commands sent by the controller. You can send individual commands to the TSP-enabled instrument the same way you would using any other instrument. ","Unlike conventional instruments, TSP-enabled instruments can execute automated test sequences independently, without a controller. You can load a series of remote commands into the instrument and store these commands as a script that can be run later by sending a single command message to the instrument. You do not have to choose between using “conventional” control or “script” control. You can combine these forms of instrument control in the way that works best for your particular test application.","Introduction to remote operation","17029.html");
+Page[1]=new Array("The simplest method of controlling an instrument through the communication interface is to send it a message that contains remote commands. You can use a test program that resides on a computer (the controller) to sequence the actions of the instrument.","Remote commands can be function-based or attribute-based. Function-based commands are commands that control actions or activities. Attribute-based commands define characteristics of an instrument feature or operation.","Controlling the instrument by sending individual command messages","17268.html");
+Page[2]=new Array("Function-based commands control actions or activities. A function-based command is not always directly related to instrument operation. For example, the bit.bitand() function will perform a logical AND operation on two numbers. Each function consists of a function name followed by a set of parentheses ( ). If the function does not have a parameter, the parentheses are left empty. If the function takes one or more parameters, they are placed between the parentheses and separated by commas.","Example 1","digio.writeport(15)","digio.writebit(3, 0)","reset()","digio.readport()","Sets digital I/O lines 1, 2, 3, and 4 high.","Sets line 3 to low (0).","Returns the instrument to its default settings.","Reads the digital I/O port.","Example 2","You can use the results of a function-based command directly or assign variables to the results for later access. The following code saves the value you enter from the front panel and prints it.","value = display.inputvalue("+0.00")","print(value)","If the operator enters 2.36 from the front panel, the resulting output is: ","2.36000e+00","Functions","13811.html");
+Page[3]=new Array("Attribute-based commands are commands that set the characteristics of an instrument feature or operation. For example, some characteristics of TSP‑enabled instruments are the model number (localnode.model) and the number of errors in the error queue (errorqueue.count).","Attributes","492.html");
+Page[4]=new Array("To set the characteristics, attribute-based commands define a value. For many attributes, the value is in the form of a number or a predefined constant.","Example 1: Set an attribute using a number","format.data = 3","This attribute sets the format of data printed by other commands. Setting this attribute to 3 sets the print format to double precision floating point format.","Example 2: Set an attribute using a constant","format.data = format.REAL64","Using the constant REAL64 instead of 3 also sets the print format to double precision floating point format.","","492.html#o493");
+Page[5]=new Array("To read an attribute, you can use the attribute as the parameter of a function, or assign it to another variable.","Example 3: Read an attribute using a function","print(format.data)","Reads the data format by passing the attribute to the print function. If the data format is set to 3, the output is:","3.00000e+00","This shows that the data format is set to double precision floating point.","Example 4: Read an attribute using a variable","fd = format.data","This reads the data format by assigning the attribute to a variable named fd.","","492.html#o494");
+Page[6]=new Array("Test Script Processor (TSP®) enabled instruments do not have inherent query commands. Like any other scripting environment, the print() command and other related commands generate output in the form of response messages. Each print() command creates one response message.","Example","x = 10","print(x)","Example of an output response message:","1.00000e+01","Note that your output might be different if you set your ASCII precision setting to a different value.","Queries","368.html");
+Page[7]=new Array("If you need information about using scripts with Model 2651A, see Fundamentals of scripting for TSP.","If you need information about using the Lua programming language with Model 2651A, see Fundamentals of programming for TSP.","Information on scripting and programming","17789.html");
+Page[8]=new Array("This section contains an overview of the instrument commands organized into groups, with a brief description of each group. Each section contains links to the detailed command descriptions for each command in the Command reference section of this documentation.","About remote commands","13401.html");
+Page[9]=new Array("The beeper commands allow you to enable or disable and sound the instrument beeper.","beeper.beep()","beeper.enable","Beeper control","14127.html");
+Page[10]=new Array("The bit functions perform bitwise logic operations on two given numbers, and bit operations on one given number. Logic and bit operations truncate the fractional part of given numbers to make them integers.","Logic operations","The bit.bitand(), bit.bitor(), and bit.bitxor() functions in this group perform bitwise logic operations on two numbers. The Test Script Processor (TSP®) scripting engine performs the indicated logic operation on the binary equivalents of the two integers. This bitwise logic operation is performed on all corresponding bits of the two numbers. The result of a logic operation is returned as an integer.","Bit operations","The rest of the functions in this group are used for operations on the bits of a given number. These functions can be used to:","Clear a bit","Toggle a bit","Test a bit","Set a bit or bit field","Retrieve the weighted value of a bit or field value","All these functions use an index parameter to specify the bit position of the given number. The least significant bit of a given number has an index of 1, and the most significant bit has an index of 32.","@ The Test Script Processor (TSP) scripting engine stores all numbers internally as IEEE Std 754 double-precision floating point values. The logical operations work on 32‑bit integers. Any fractional bits are truncated. For numbers larger than 4294967295, only the lower 32 bits are used.","bit.bitand()","bit.bitor()","bit.bitxor()","bit.clear()","bit.get()","bit.getfield()","bit.set()","bit.setfield()","bit.test()","bit.toggle()","Bit manipulation and logic operations","11382.html");
+Page[11]=new Array("Use the data queue commands to:","Share data between test scripts running in parallel","Access data from a remote group or a local node on a TSP‑Link® network at any time","The data queue in the Test Script Processor (TSP®) scripting engine is first-in, first-out (FIFO).","You can access data from the data queue even if a remote group or a node has overlapped operations in process.","dataqueue.add()","dataqueue.CAPACITY","dataqueue.clear()","dataqueue.count","dataqueue.next()","Data queue","14653.html");
+Page[12]=new Array("The digital I/O port of the Model 2651A can control external circuitry (such as a component handler for binning operations).","The I/O port has 14 lines. Each line can be at TTL logic state 1 (high) or 0 (low). See the pinout diagram in Digital I/O port for additional information.","There are commands to read and write to each individual bit, and commands to read and write to the entire port.","digio.readbit()","digio.readport()","digio.trigger[N].assert()","digio.trigger[N].clear()","digio.trigger[N].EVENT_ID","digio.trigger[N].mode","digio.trigger[N].overrun","digio.trigger[N].pulsewidth","digio.trigger[N].release()","digio.trigger[N].reset()","digio.trigger[N].stimulus","digio.trigger[N].wait()","digio.writebit()","digio.writeport()","digio.writeprotect","Digital I/O","14667.html");
+Page[13]=new Array("display.clear()","display.getannunciators()","display.getcursor()","display.getlastkey()","display.gettext()","display.inputvalue()","display.loadmenu.add()","display.loadmenu.catalog()","display.loadmenu.delete()","display.locallockout","display.menu()","display.numpad","display.prompt()","display.screen","display.sendkey()","display.setcursor()","display.settext()","display.smuX.digits","display.smuX.measure.func","display.trigger.EVENT_ID","display.trigger.overrun","display.trigger.wait()","display.waitkey()","Display","15965.html");
+Page[14]=new Array("When errors occur, the error messages are placed in the error queue. Use the error queue commands to request error message information.","errorqueue.clear()","errorqueue.count","errorqueue.next()","Error queue","14748.html");
+Page[15]=new Array("You can use the event log to view specific details about LAN triggering events.","eventlog.all()","eventlog.clear()","eventlog.count","eventlog.enable","eventlog.next()","eventlog.overwritemethod","Event log","10905.html");
+Page[16]=new Array("You can use the file I/O commands to open and close directories and files, write data, or to read a file on an installed USB flash drive. File I/O commands are organized into two groups:","Commands that reside in the fs and io table, for example: io.open(), io.close(), io.input(), and io.output(). Use these commands to manage file system directories; open and close file descriptors; and perform basic I/O operations on a pair of default files (one input and one output).","Commands that reside in the file descriptors (for example: fileVar:seek(), fileVar:write(), and fileVar:read()) operate exclusively on the file with which they are associated.","The root folder of the USB flash drive has the absolute path:",""/usb1/"","@ Both slash (/) and backslash (\\) are supported as directory separators.","For basic information about navigation and directory listing of files on a flash drive, see File system navigation.","@ File descriptor commands for file I/O use a colon (:) to separate the command parts rather than a period (.), like the io commands.","File descriptors cannot be passed between nodes in a TSP-Link® system, so the io.open(), fileVar::read(), and fileVar::write commands are not accessible to the TSP-Link system. However, the default input and output files mentioned above allow for the execution of many file I/O operations without any reference to a file descriptor.","fileVar:close()","fileVar:flush()","fileVar:read()","fileVar:seek()","fileVar:write()","fs.chdir()","fs.cwd()","fs.is_dir()","fs.is_file()","fs.mkdir()","fs.readdir()","fs.rmdir()","io.close()","io.flush()","io.input()","io.open()","io.output()","io.read()","io.type()","io.write()","The following standard I/O commands are not supported at this time:","File","I/O","fileVar:lines()","fileVar:setvbuf()","io.lines()","io.popen()","File I/O","14771.html");
+Page[17]=new Array("This attribute stores the GPIB address.","gpib.address","GPIB","14859.html");
+Page[18]=new Array("These commands store strings that describe the instrument.","localnode.description","localnode.model","localnode.revision","localnode.serialno","Instrument identification","19423.html");
+Page[19]=new Array("The LAN commands have options that allow you to review and configure network settings.","The lan.config.* commands allow you to configure LAN settings over the remote interface. Note that you must send lan.applysettings() for the configuration settings to take effect.","The lan.status.* commands help you determine the status of the LAN.","The lan.trigger[N].* commands allow you to set up and assert trigger events that are sent over the LAN.","Other LAN commands allow you to reset the LAN, restore defaults, check LXI domain information, and enable or disable the Nagle algorithm.","lan.applysettings()","lan.autoconnect","lan.config.dns.address[N]","lan.config.dns.domain","lan.config.dns.dynamic","lan.config.dns.hostname","lan.config.dns.verify","lan.config.duplex","lan.config.gateway","lan.config.ipaddress","lan.config.method","lan.config.speed","lan.config.subnetmask","lan.linktimeout","lan.lxidomain","lan.nagle","lan.reset()","lan.restoredefaults()","lan.status.dns.address[N]","lan.status.dns.name","lan.status.duplex","lan.status.gateway","lan.status.ipaddress","lan.status.macaddress","lan.status.port.dst","lan.status.port.rawsocket","lan.status.port.telnet","lan.status.port.vxi11","lan.status.speed","lan.status.subnetmask","lan.timedwait","lan.trigger[N].assert()","lan.trigger[N].clear()","lan.trigger[N].connect()","lan.trigger[N].connected","lan.trigger[N].disconnect()","lan.trigger[N].EVENT_ID","lan.trigger[N].ipaddress","lan.trigger[N].mode","lan.trigger[N].overrun","lan.trigger[N].protocol","lan.trigger[N].pseudostate","lan.trigger[N].stimulus","lan.trigger[N].wait()","localnode.description","localnode.password","localnode.passwordmode","LAN and LXI","14129.html");
+Page[20]=new Array("delay()","exit()","localnode.autolinefreq","localnode.linefreq","localnode.password","localnode.passwordmode","makegetter()","makesetter()","meminfo()","opc()","waitcomplete()","Miscellaneous","19424.html");
+Page[21]=new Array("dataqueue.add()","dataqueue.CAPACITY","dataqueue.clear()","dataqueue.count","dataqueue.next()","node[N].execute()","node[N].getglobal()","node[N].setglobal()","tsplink.group","tsplink.master","tsplink.node","Parallel script execution","19425.html");
+Page[22]=new Array("You can use the print(), printbuffer(), and printnumber() functions to query the instrument and generate response messages. The format attributes control how the data is formatted for the print functions used.","The localnode commands determine if generated errors are automatically sent and if prompts are generated.","format.asciiprecision","format.byteorder","format.data","localnode.prompts","localnode.prompts4882","localnode.showerrors","print()","printbuffer()","printnumber()","Queries and response messages","14795.html");
+Page[23]=new Array("Reading buffers capture measurements, ranges, instrument status, and output states of the Keithley Instruments Model 2651A.","bufferVar.appendmode","bufferVar.basetimestamp","bufferVar.cachemode","bufferVar.capacity","bufferVar.clear()","bufferVar.clearcache()","bufferVar.collectsourcevalues","bufferVar.collecttimestamps","bufferVar.fillcount","bufferVar.fillmode","bufferVar.measurefunctions","bufferVar.measureranges","bufferVar.n","bufferVar.readings","bufferVar.sourcefunctions","bufferVar.sourceoutputstates","bufferVar.sourceranges","bufferVar.sourcevalues","bufferVar.statuses","bufferVar.timestampresolution","bufferVar.timestamps","savebuffer()","smuX.buffer.getstats()","smuX.buffer.recalculatestats()","smuX.makebuffer()","smuX.nvbufferY","smuX.savebuffer()","Reading buffer","17112.html");
+Page[24]=new Array("Resets settings to their default settings.","digio.trigger[N].reset()","lan.reset()","localnode.reset()","reset()","smuX.reset()","timer.reset()","trigger.blender[N].reset()","trigger.timer[N].reset()","tsplink.trigger[N].reset()","Reset","15061.html");
+Page[25]=new Array("serial.baud","serial.databits","serial.flowcontrol","serial.parity","serial.read()","serial.write()","RS-232","15067.html");
+Page[26]=new Array("Use the saved setups commands to save and restore the configuration of the instrument. You can restore (or save) configurations from the instrument's nonvolatile memory or an installed USB flash drive. You can use the setup.poweron attribute to specify which setup is recalled when the instrument is turned on.","setup.poweron","setup.recall()","setup.save()","Saved setups","19516.html");
+Page[27]=new Array("Scripting helps you combine commands into a block of code that the instrument can run. Scripts help you communicate with the instrument efficiently. These commands describe how to create, load, modify, run, and exit scripts.","exit()","script.anonymous","script.delete()","script.factory.catalog()","script.load()","script.new()","script.newautorun()","script.restore()","script.run()","script.user.catalog()","scriptVar.autorun","scriptVar.list()","scriptVar.name","scriptVar.run()","scriptVar.save()","scriptVar.source","Scripting","15062.html");
+Page[28]=new Array("localnode.linefreq","localnode.autolinefreq","smuX.abort()","smuX.buffer.getstats()","smuX.buffer.recalculatestats()","smuX.contact.check()","smuX.contact.r()","smuX.contact.speed","smuX.contact.threshold","smuX.makebuffer()","smuX.measure.adc","smuX.measure.autorangeY","smuX.measure.autozero","smuX.measure.count","smuX.measure.delay","smuX.measure.delayfactor","smuX.measure.filter.count","smuX.measure.filter.enable","smuX.measure.filter.type","smuX.measure.highcrangedelayfactor","smuX.measure.interval","smuX.measure.lowrangeY","smuX.measure.nplc","smuX.measure.overlappedY()","smuX.measure.rangeY","smuX.measure.rel.enableY","smuX.measure.rel.levelY","smuX.measure.Y()","smuX.measureYandstep()","smuX.nvbufferY","smuX.reset()","smuX.savebuffer()","smuX.sense","smuX.source.autorangeY","smuX.source.compliance","smuX.source.delay","smuX.source.func","smuX.source.highc","smuX.source.levelY","smuX.source.limitY","smuX.source.lowrangeY","smuX.source.offlimitY","smuX.source.offmode","smuX.source.output","smuX.source.outputenableaction","smuX.source.rangeY","smuX.source.settling","smuX.source.sink","smuX.trigger.arm.count","smuX.trigger.arm.set()","smuX.trigger.arm.stimulus","smuX.trigger.ARMED_EVENT_ID","smuX.trigger.autoclear","smuX.trigger.count","smuX.trigger.endpulse.action","smuX.trigger.endpulse.set()","smuX.trigger.endpulse.stimulus","smuX.trigger.endsweep.action","smuX.trigger.IDLE_EVENT_ID","smuX.trigger.initiate()","smuX.trigger.measure.action","smuX.trigger.measure.set()","smuX.trigger.measure.stimulus","smuX.trigger.measure.Y()","smuX.trigger.MEASURE_COMPLETE_EVENT_ID","smuX.trigger.PULSE_COMPLETE_EVENT_ID","smuX.trigger.source.action","smuX.trigger.source.limitY","smuX.trigger.source.linearY()","smuX.trigger.source.listY()","smuX.trigger.source.logY()","smuX.trigger.source.set()","smuX.trigger.source.stimulus","smuX.trigger.SOURCE_COMPLETE_EVENT_ID","smuX.trigger.SWEEP_COMPLETE_EVENT_ID","smuX.trigger.SWEEPING_EVENT_ID","SMU","15087.html");
+Page[29]=new Array("smuX.cal.adjustdate","smuX.cal.date","smuX.cal.due","smuX.cal.fastadc()","smuX.cal.lock()","smuX.cal.password","smuX.cal.polarity","smuX.cal.restore()","smuX.cal.save()","smuX.cal.state","smuX.cal.unlock()","smuX.contact.calibratehi()","smuX.contact.calibratelo()","smuX.measure.calibrateY()","smuX.source.calibrateY()","SMU calibration","19430.html");
+Page[30]=new Array("The status model is a set of status registers and queues. You can use the following commands to manipulate and monitor these registers and queues to view and control various instrument events.","status.condition","status.measurement.*","status.measurement.buffer_available.*","status.measurement.current_limit.*","status.measurement.instrument.*","status.measurement.instrument.smuX.*","status.measurement.reading_overflow.*","status.measurement.voltage_limit.*","status.node_enable","status.node_event","status.operation.*","status.operation.calibrating.*","status.operation.instrument.*","status.operation.instrument.digio.*","status.operation.instrument.digio.trigger_overrun.*","status.operation.instrument.lan.*","status.operation.instrument.lan.trigger_overrun.*","status.operation.instrument.smuX.*","status.operation.instrument.smuX.trigger_overrrun.*","status.operation.instrument.trigger_blender.*","status.operation.instrument.trigger_blender.trigger_overrun.*","status.operation.instrument.trigger_timer.*","status.operation.instrument.trigger_timer.trigger_overrun.*","status.operation.instrument.tsplink.*","status.operation.instrument.tsplink.trigger_overrun.*","status.operation.measuring.*","status.operation.remote.*","status.operation.sweeping.*","status.operation.trigger_overrun.*","status.operation.user.*","status.questionable.*","status.questionable.calibration.*","status.questionable.instrument.*","status.questionable.instrument.smuX.*","status.questionable.over_temperature.*","status.questionable.unstable_output.*","status.request_enable","status.request_event","status.reset()","status.standard.*","status.system.*","status.system2.*","status.system3.*","status.system4.*","status.system5.*","Status model","14126.html");
+Page[31]=new Array("bufferVar.basetimestamp","bufferVar.collecttimestamps","bufferVar.timestampresolution","delay()","gettimezone()","settime()","settimezone()","timer.measure.t()","timer.reset()","Time","19432.html");
+Page[32]=new Array("digio.trigger[N].assert()","digio.trigger[N].clear()","digio.trigger[N].EVENT_ID","digio.trigger[N].mode","digio.trigger[N].overrun","digio.trigger[N].pulsewidth","digio.trigger[N].release()","digio.trigger[N].reset()","digio.trigger[N].stimulus","digio.trigger[N].wait()","display.trigger.clear()","display.trigger.EVENT_ID","display.trigger.overrun","display.trigger.wait()","lan.trigger[N].assert()","lan.trigger[N].clear()","lan.trigger[N].connect()","lan.trigger[N].connected","lan.trigger[N].disconnect()","lan.trigger[N].EVENT_ID","lan.trigger[N].ipaddress","lan.trigger[N].mode","lan.trigger[N].overrun","lan.trigger[N].protocol","lan.trigger[N].pseudostate","lan.trigger[N].stimulus","lan.trigger[N].wait()","smuX.trigger.arm.count","smuX.trigger.arm.set()","smuX.trigger.arm.stimulus","smuX.trigger.ARMED_EVENT_ID","smuX.trigger.autoclear","smuX.trigger.count","smuX.trigger.endpulse.action","smuX.trigger.endpulse.set()","smuX.trigger.endpulse.stimulus","smuX.trigger.endsweep.action","smuX.trigger.IDLE_EVENT_ID","smuX.trigger.initiate()","smuX.trigger.measure.action","smuX.trigger.measure.set()","smuX.trigger.measure.stimulus","smuX.trigger.measure.Y()","smuX.trigger.MEASURE_COMPLETE_EVENT_ID","smuX.trigger.PULSE_COMPLETE_EVENT_ID","smuX.trigger.source.action","smuX.trigger.source.limitY","smuX.trigger.source.linearY()","smuX.trigger.source.listY()","smuX.trigger.source.logY()","smuX.trigger.source.set()","smuX.trigger.source.stimulus","smuX.trigger.SOURCE_COMPLETE_EVENT_ID","smuX.trigger.SWEEP_COMPLETE_EVENT_ID","smuX.trigger.SWEEPING_EVENT_ID","trigger.blender[N].clear()","trigger.blender[N].EVENT_ID","trigger.blender[N].orenable","trigger.blender[N].overrun","trigger.blender[N].reset()","trigger.blender[N].stimulus[M]","trigger.blender[N].wait()","trigger.clear()","trigger.EVENT_ID","trigger.timer[N].clear()","trigger.timer[N].count","trigger.timer[N].delay","trigger.timer[N].delaylist","trigger.timer[N].EVENT_ID","trigger.timer[N].overrun","trigger.timer[N].passthrough","trigger.timer[N].reset()","trigger.timer[N].stimulus","trigger.timer[N].wait()","trigger.wait()","tsplink.trigger[N].assert()","tsplink.trigger[N].clear()","tsplink.trigger[N].EVENT_ID","tsplink.trigger[N].mode","tsplink.trigger[N].overrun","tsplink.trigger[N].pulsewidth","tsplink.trigger[N].release()","tsplink.trigger[N].reset()","tsplink.trigger[N].stimulus","tsplink.trigger[N].wait()","Triggering","19433.html");
+Page[33]=new Array("These functions and attributes allow you to set up and work with a system that is connected by a TSP‑Link® network.","tsplink.group","tsplink.master","tsplink.node","tsplink.readbit()","tsplink.readport()","tsplink.reset()","tsplink.state","tsplink.trigger[N].assert()","tsplink.trigger[N].clear()","tsplink.trigger[N].EVENT_ID","tsplink.trigger[N].mode","tsplink.trigger[N].overrun","tsplink.trigger[N].pulsewidth","tsplink.trigger[N].release()","tsplink.trigger[N].reset()","tsplink.trigger[N].stimulus","tsplink.trigger[N].wait()","tsplink.writebit()","tsplink.writeport()","tsplink.writeprotect","TSP-Link","14123.html");
+Page[34]=new Array("The TSP-Net module provides a simple socket-like programming interface to Test Script Processor (TSP®) enabled instruments.","tspnet.clear()","tspnet.connect()","tspnet.disconnect()","tspnet.execute()","tspnet.idn()","tspnet.read()","tspnet.readavailable()","tspnet.reset()","tspnet.termination()","tspnet.timeout","tspnet.tsp.abort()","tspnet.tsp.abortonconnect","tspnet.tsp.rbtablecopy()","tspnet.tsp.runscript()","tspnet.write()","TSP-Net","14072.html");
+Page[35]=new Array("Use the functions in this group to store and retrieve user-defined strings in nonvolatile memory. These strings are stored as key‑value pairs. You can use the userstring functions to store custom, instrument-specific information in the instrument, such as department number, asset number, or manufacturing plant location.","userstring.add()","userstring.catalog()","userstring.delete()","userstring.get()","Userstrings","14033.html");
+Page[36]=new Array("The Keithley Instruments Model 2651A High Power System SourceMeter® Instrument is shipped with one or more factory scripts saved in its flash firmware memory. A factory script is made up of a number of functions. Some of them can be called from the front‑panel LOAD TEST menu. All of them can be called using remote programming.","As Keithley Instruments develops additional factory scripts, they will be made available on the Keithley Instruments website as a flash firmware upgrade for the Model 2651A. See Upgrading the firmware for instructions on upgrading the flash firmware of your Model 2651A instrument.","A factory script is similar to a user script, except a factory script is created by Keithley Instruments at the factory and is permanently stored in nonvolatile memory. The differences between a user script and a factory script include the following:","A factory script cannot be deleted from nonvolatile memory.","The script listing for a factory script can be retrieved and modified, but it will then be treated as a user script. A user script cannot be saved as a factory script.","Factory scripts are not stored in global variables. The only references to factory scripts are in the script.factory.scripts attribute.","The script.factory.catalog() function returns an iterator that can be used in a for loop to iterate over all the factory scripts.","Example","To retrieve the catalog listing for factory scripts, send:","for name in script.factory.catalog() do print(name) end","Introduction","12912.html");
+Page[37]=new Array("Use either of the following commands to run a factory script:","script.factory.scripts.name() script.factory.scripts.name.run()","Where: name is the name of the factory script.","Example:","Run the factory script named “KIPulse”","script.factory.scripts.KIPulse()","Running a factory script","12913.html");
+Page[38]=new Array("Press the LOAD key.","Select FACTORY.","Select the function to run and press RUN key.","Running a factory script function from the Model 2651A front panel controls","12914.html");
+Page[39]=new Array("The script listing for a factory script can be retrieved and modified. However, it cannot be saved as a factory script. The modified script can be saved as a user script using the same name or a new name.","An imported factory script can only be loaded back into the Model 2651A as a user script.","The following function retrieves a script listing. The script code is output with the shell keywords (loadscript or loadandrunscript, and endscript):","script.factory.scripts.name.list()","Where: name is the name of the factory script.","Example:","Retrieve the script listing for a factory script named “KIPulse”:","script.factory.scripts.KIPulse.list()","Retrieving and modifying a factory script listing","12194.html");
+Page[40]=new Array("The KISweep factory script provides simple sweep test programming and shows how to use the sweeping function.","This script is made up of the following functions. Access these functions from the front panel or the remote interfaces. Details on these functions are provided in the tables that follow. The following functions make up the KISweep factory script:","SweepILinMeasureV()","SweepVLinMeasureI()","SweepILogMeasureV()","SweepVLogMeasureI()","SweepIListMeasureV()","SweepVListMeasureI()","KISweep factory script","12175.html");
+Page[41]=new Array("The KIPulse factory script provides examples of how to generate pulses and to provide a simple pulsing interface. Pulses can be generated using the functions listed below.","@ Please note the following information about the KIPulse factory script:
Ÿ This factory script only operates on the channels present in the instrument executing the pulse functions. These functions will not operate correctly if you attempt to access instrument channels over the TSP‑Link® interface.
Ÿ The KIPulse factory scripts are general purpose examples that may not be suitable for all use cases. Very short pulses (less than 1ms pulse width) may require optimization of the examples provided by the factory script in order to achieve settled measurements.
Ÿ The PulseIMeasureV() and PulseVMeasureI() functions may be accessed from the front panel. The remaining functions may only be accessed remotely.","Use the configuration KIPulse tag parameter pulse functions to configure a pulse train and assign the configuration to the tag parameter (use QueryPulseConfig() to inspect configured pulse trains). Use the initiation InitiatePulseTest() function to execute the pulse trains assigned to its tag arguments. The conditions listed in the table below must be true for these functions to execute successfully.","Conditions that must be true for successful function execution:","Config functions:","InitiatePulseTest functions:","Source autorange (I and V) off","Output on","Measure autorange (I and V) off","There is enough free space in the buffer","Measure NPLC < ton","Buffer append mode is on when pulse train is >1 point","Measure autozero OFF or ONCE","Use the KIPulse simple pulse functions to specify and perform a specified number of pulse-measure cycles.","The following functions make up the KIPulse factory script:","KIPulse factory script","12916.html");
+Page[42]=new Array("ConfigPulseIMeasureV()","ConfigPulseVMeasureI()","ConfigPulseIMeasureVSweepLin()","ConfigPulseVMeasureISweepLin()","ConfigPulseIMeasureVSweepLog()","ConfigPulseVMeasureISweepLog()","QueryPulseConfig()","InitiatePulseTest()","KIPulse tag parameter pulse functions","19518.html");
+Page[43]=new Array("PulseIMeasureV()","PulseVMeasureI()","KIPulse simple pulse functions","19519.html");
+Page[44]=new Array("Variable off time between pulses in a pulse train","The KIPulse “Configure” functions will accept the toff parameter as a table, or as a number. The table allows you to define different off times to be used after each pulse. The following should be noted:","If toff is passed as a number or only a single value is used in the table, it will be used for all points in a multiple point pulse.","The number of times specified in the table must match the number of points called for in the sweep.","The times used in tables must match for dual channel pulsing.","Each specified off time must adhere to the duty cycle limits for the specified pulsing region.","Simultaneous IV measurement during pulse","The KIPulse “Configure” functions will optionally accept an extra reading buffer to activate simultaneous IV measurements during pulsing. Previous usage of passing in a reading buffer or a nil (for no measurement) is still supported.","Advanced features for KIPulse tag parameter pulse functions","19514.html");
+Page[45]=new Array("The KIHighC factory script is made up of two functions: i_leakage_measure() and i_leakage_threshold(). These functions are intended to be used when HighC mode is active. Output is generally at a non-zero voltage prior to calling these functions. These functions can also be used to step the voltage to zero volts in order to measure the leakage current.","i_leakage_measure()","i_leakage_threshold()","KIHighC factory script","12950.html");
+Page[46]=new Array("The KIParlib factory script is made up of two functions: gm_vsweep() and gm_isweep().","gm_vsweep()","gm_isweep()","KIParlib factory script","12954.html");
+Page[47]=new Array("The KISavebuffer script has one function: savebuffer().","savebuffer()","KISavebuffer factory script","12958.html");
+Page[48]=new Array("This manual uses italicized text to represent the parts of remote commands that must be replaced by user specified values. The following examples show typical uses of italicized text: ","Example 1:","gpib.address = address","Where:","address is an integer (0 to 30) that you specify. For example, to set this attribute to 15 you would send:","gpib.address = 15","Example 2:","digio.trigger[N].assert()","Where:","N is an integer (1 to 14) that you specify. For example, to assert trigger line 7 you would send:","digio.trigger[7].assert()","To assert a trigger line with a variable as the integer, you would send:","triggerline = 7","digio.trigger[triggerline].assert()","Example 3:","smuX.trigger.measure.Y(rbuffer)","Where: ","X is refers to the source‑measure unit (SMU) channel (use a for SMU A).","Y is the measurement type that you specify (v, i, r, or p). ","rbuffer is the reading buffer object where the readings will be stored. ","For example, to use SMU A to take voltage measurements and store them in buffer vbuffername, you would send:","smua.trigger.measure.v(vbuffername)","Placeholder text","17859.html");
+Page[49]=new Array("The following table lists syntax requirements to build well-formed instrument control commands.","Syntax rules for instrument commands","Syntax rule","Details","Examples","Case sensitivity: Instrument commands are case sensitive. ","For best results, simply match the case shown in the command reference descriptions.","Function and attribute names should be in lowercase characters.","An example of the scriptVar.save() function (where test8 is the name of the script):","test8.save()","Parameters can use a combination of lowercase and uppercase characters.","Attribute constants use uppercase characters","In the command below, which sets the format of data transmitted from the instrument to double‑precision floating point, format.REAL64 is the attribute constant and format.data is the attribute command:","format.data = format.REAL64","White space: Not required in a function.","Functions can be sent with or without white spaces.","The following functions, which set digital I/O line 3 low, are equivalent:","digio.writebit(3,0)","digio.writebit (3, 0)","Function parameters: All functions are required to have a set of parentheses () immediately following the function.","You can specify the function parameters by placing them between the parentheses. Note that the parentheses are required even when there are no parameters specified.","The following function specifies all overlapped commands in the nodes in group G must complete before commands from other groups can execute:","waitcomplete(G)","The command below reads the value of the local time zone (no parameters are needed):","timezone = localnode.gettimezone()","Multiple parameters: Must be separated by commas (,).","Some commands require multiple parameters, which must be separated by commas (,).","This command sets the beeper to emit a double‑beep at 2400 Hz, with a beep sequence of 0.5 seconds on, 0.25 seconds off, and then 0.5 seconds on:","beeper.beep(0.5, 2400)","delay(0.250)","beeper.beep(0.5, 2400)","Syntax rules","17860.html");
+Page[50]=new Array("You would normally refer to all instrumentation in one enclosure or node as a single instrument. In the context of Test Script Processor (TSP®) scripting engine and instrument commands, it is useful to think of each individual subdivision in an enclosure, such as a card slot or the channels, as a stand‑alone instrument. To avoid confusion, all subdivisions of the instrumentation in an enclosure are referred to as "logical instruments."","Each logical instrument is given a unique identifier in a system. These identifiers are used as part of all commands that control a given logical instrument.","The logical instruments are:","beeper","gpib","bit","lan","digio","status","display","timer","eventlog","trigger","errorqueue","tsplink","format","smua","@ Do not create variable names that are the same as names of logical instruments. Doing so will result in the loss of use of the logical instrument and its associated commands. For example, if you send the command digio = 5, you cannot access the digio.* commands until you turn off the power to the instrument, and then turn it on again.","Logical instruments","13810.html");
+Page[51]=new Array("Time and date values are represented as the number of seconds since some base. Representing time as a number of seconds is referred to as “standard time format.” There are three time bases:","UTC 12:00 am Jan 1, 1970. Some examples of UTC time are reading buffer base timestamps, adjustment dates, and the value returned by os.time().","Instrument on. References time to when the instrument was turned on. The value returned by os.clock() is referenced to the turn-on time.","Event. Time referenced to an event, such as the first reading stored in a reading buffer.","Time and date values","12044.html");
+Page[52]=new Array("The command reference contains detailed descriptions of each of the commands you can use to control your Model 2651A. Each command description is broken into several standardized subsections. The figure below shows an example of a command description.","Each command listing is divided into five major categories of information about the command:","Command name and summary table","Usage","Details","Example","Also see","The content of each of these categories is described in the following topics.","Using the command reference","17852.html");
+Page[53]=new Array("Each instrument command description starts with the command name, followed by a table with relevant information for each command. Definitions for the numbered items in the figure below are listed following the figure.","Instrument command name. Signals the beginning of the command description and is followed by a brief description of what the command does.","Type of command. Options are:","Function. Function-based commands control actions or activities, but are not always directly related to instrument operation. Function names are always followed by a set of parentheses, for example, digio.writeport(15). If the function does not need a parameter, the parentheses set remains empty, for example, exit().","Attribute (R), (RW), or (W). Attribute-based commands set or read the characteristics of an instrument feature or operation by defining a value. For example, a characteristic of a TSP‑enabled instrument is the model number (localnode.model); another characteristic is the number of errors in the error queue (errorqueue.count). For many attributes, the defined value is a number or predefined constant. Attributes can be read-only (R), read-write (RW), or write-only (W), and can be used as a parameter of a function or assigned to another variable.","Constant. A constant command represents a fixed value when used in a script.","TSP-Link accessible. Yes or No; indicates whether or not the command can accessed through a TSP-Link network.","Affected by. Commands or actions that have a direct effect on the instrument command.","LAN restore defaults","Recall setup","Instrument reset: An instrument reset can be invoked by reset(), localnode.reset(), or *RST.","Where saved. Indicates where the command settings reside once they are used on an instrument. Options include:","Not saved: Command is not saved anywhere and must be typed each time you use it.","Nonvolatile memory: Storage area in the instrument where information is saved when the instrument is turned off. ","Saved setup","Default value: Lists the default value or constant for the command. The parameter values are defined in the Usage or Details sections of the command description.","Command name and summary table","17853.html");
+Page[54]=new Array("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: 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 usage","17854.html");
+Page[55]=new Array("This section lists additional information you need to know to successfully use the remote commands.","Command details","17855.html");
+Page[56]=new Array("The Example section of the remote command description shows some simple examples of how the command can be used.","Actual example code that you can copy from this table and paste into your own programming application.","Description of the code and what it does. This may also contain the output of the code.","Example section","17856.html");
+Page[57]=new Array("The Also see section of the remote command description lists commands that are related to the command being described.","Related commands and information","17857.html");
+Page[58]=new Array("This function generates an audible tone.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","beeper.beep(duration, frequency)","duration","The amount of time to play the tone in seconds; the allowable range is 0.1 s to 100 s","frequency","The frequency of the tone in Hertz (Hz)","Details","The beeper will not sound if it is disabled. It can be disabled or enabled with the beeper.enable attribute, or through the front‑panel Main Menu.","Example","beeper.enable = beeper.ON","beeper.beep(2, 2400)","Enables the beeper and generates a two‑second, 2400 Hz tone.","Also see","beeper.enable","beeper.beep()","18841.html");
+Page[59]=new Array("This attribute allows you to turn the beeper on or off.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Recall setup Instrument reset","Saved setup","1 (beeper.ON)","Usage","state = beeper.enable","beeper.enable = state","state","Disable the beeper (beeper.OFF or 0)","Enable the beeper (beeper.ON or 1)","Details","Disabling the beeper also disables front‑panel key clicks.","Example","beeper.enable = beeper.ON","beeper.beep(2, 2400)","Enables the beeper and generates a two‑second, 2400 Hz tone.","Also see","beeper.beep()","beeper.enable","14435.html");
+Page[60]=new Array("This function performs a bitwise logical AND operation on two numbers.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","result = bit.bitand(value1, value2)","result","Result of the logical AND operation","value1","Operand for the logical AND operation","value2","Operand for the logical AND operation","Details","Any fractional parts of value1 and value2 are truncated to form integers. The returned result is also an integer.","Example","testResult = bit.bitand(10, 9)","print(testResult)","Performs a logical AND operation on decimal 10 (binary 1010) with decimal 9 (binary 1001), which returns a value of decimal 8 (binary 1000).","Output:","8.00000e+00","Also see","bit.bitor()","bit.bitxor()","Logical operators","bit.bitand()","14632.html");
+Page[61]=new Array("This function performs a bitwise logical OR operation on two numbers.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","result = bit.bitor(value1, value2)","result","Result of the logical OR operation","value1","Operand for the logical OR operation","value2","Operand for the logical OR operation","Details","Any fractional parts of value1 and value2 are truncated to make them integers. The returned result is also an integer.","Example","testResult = bit.bitor(10, 9)","print(testResult)","Performs a bitwise logical OR operation on decimal 10 (binary 1010) with decimal 9 (binary 1001), which returns a value of decimal 11 (binary 1011).","Output: 1.10000e+01","Also see","bit.bitand()","bit.bitxor()","Logical operators","bit.bitor()","14634.html");
+Page[62]=new Array("This function performs a bitwise logical XOR (exclusive OR) operation on two numbers.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","result = bit.bitxor(value1, value2)","result","Result of the logical XOR operation","value1","Operand for the logical XOR operation","value2","Operand for the logical XOR operation","Details","Any fractional parts of value1 and value2 are truncated to make them integers. The returned result is also an integer.","Example","testResult = bit.bitxor(10, 9)","print(testResult)","Performs a logical XOR operation on decimal 10 (binary 1010) with decimal 9 (binary 1001), which returns a value of decimal 3 (binary 0011).","Output:","3.00000e+00","Also see","bit.bitand()","bit.bitor()","Logical operators","bit.bitxor()","14635.html");
+Page[63]=new Array("This function clears a bit at a specified index position.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","result = bit.clear(value, index)","result","Result of the bit manipulation","value","Specified number","index","One‑based bit position within value to clear (1 to 32)","Details","Any fractional part of value is truncated to make it an integer. The returned result is also an integer.","The least significant bit of value is at index position 1; the most significant bit is at index position 32.","Example","testResult = bit.clear(15, 2)","print(testResult)","The binary equivalent of decimal 15 is 1111. If you clear the bit at index position 2, the returned decimal value is 13 (binary 1101).","Output:","1.30000e+01","Also see","bit.get()","bit.set()","bit.test()","bit.toggle()","Logical operators","bit.clear()","14636.html");
+Page[64]=new Array("This function retrieves the weighted value of a bit at a specified index position.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","result = bit.get(value, index)","result","Result of the bit manipulation","value","Specified number","index","One‑based bit position within value to get (1 to 32)","Details","This function returns the value of the bit in value at index. This is the same as returning value with all other bits set to zero (0).","The least significant bit of value is at index position 1; the most significant bit is at index position 32.","If the indexed bit for the number is set to zero (0), the result will be zero (0).","Example","testResult = bit.get(10, 4)","print(testResult)","The binary equivalent of decimal 10 is 1010. If you get the bit at index position 4, the returned decimal value is 8.","Output:","8.00000e+00","Also see","bit.clear()","bit.set()","bit.test()","bit.toggle()","Logical operators","bit.get()","14637.html");
+Page[65]=new Array("This function returns a field of bits from the value starting at the specified index position.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","result = bit.getfield(value, index, width)","result","Result of the bit manipulation","value","Specified number","index","One‑based bit position within value to get (1 to 32)","width","The number of bits to include in the field (1 to 32)","Details","A field of bits is a contiguous group of bits. This function retrieves a field of bits from value starting at index.","The index position is the least significant bit of the retrieved field. The number of bits to return is specified by width.","The least significant bit of value is at index position 1; the most significant bit is at index position 32.","Example","myResult = bit.getfield(13, 2, 3)","print(myResult)","The binary equivalent of decimal 13 is 1101. ","The field at index position 2 and width 3 consists of the binary bits 110. The returned value is decimal 6 (binary 110).","Output:","6.00000e+00","Also see","bit.get()","bit.set()","bit.setfield()","Logical operators","bit.getfield()","14638.html");
+Page[66]=new Array("This function sets a bit at the specified index position.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","result = bit.set(value, index)","result","Result of the bit manipulation","value","Specified number","index","One‑based bit position within value to set (1 to 32)","Details","This function returns result, which is value with the indexed bit set. The index must be between 1 and 32.","The least significant bit of value is at index position 1; the most significant bit is at index position 32.","Any fractional part of value is truncated to make it an integer.","Example","testResult = bit.set(8, 3)","print(testResult)","The binary equivalent of decimal 8 is 1000. If the bit at index position 3 is set to 1, the returned value is decimal 12 (binary 1100).","Output:","1.20000e+01","Also see","bit.clear()","bit.get()","bit.getfield()","bit.setfield()","bit.test()","bit.toggle()","Logical operators","bit.set()","14639.html");
+Page[67]=new Array("This function overwrites a bit field at a specified index position.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","result = bit.setfield(value, index, width, fieldValue)","result","Result of the bit manipulation","value","Specified number","index","One‑based bit position in value to set (1 to 32)","width","The number of bits to include in the field (1 to 32)","fieldValue","Value to write to the field","Details","This function returns result, which is value with a field of bits overwritten, starting at index. The index specifies the position of the least significant bit of value. The width bits starting at index are set to fieldValue.","The least significant bit of value is at index position 1; the most significant bit is at index position 32.","Before setting the field of bits, any fractional parts of value and fieldValue are truncated to form integers.","If fieldValue is wider than width, the most significant bits of the fieldValue that exceed the width are truncated. For example, if width is 4 bits and the binary value for fieldValue is 11110 (5 bits), the most significant bit of fieldValue is truncated and a binary value of 1110 is used.","Example","testResult = bit.setfield(15, 2, 3, 5)","print(testResult)","The binary equivalent of decimal 15 is 1111. After overwriting it with a decimal 5 (binary 101) at index position 2, the returned value is decimal 11 (binary 1011).","Output:","1.10000e+01","Also see","bit.get()","bit.set()","bit.getfield()","Logical operators","bit.setfield()","14640.html");
+Page[68]=new Array("This function returns the Boolean value (true or false) of a bit at the specified index position.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","result = bit.test(value, index)","result","Result of the bit manipulation","value","Specified number","index","One‑based bit position within value to test (1 to 32)","Details","This function returns result, which is the result of the tested bit. ","The least significant bit of value is at index position 1; the most significant bit is at index position 32.","If the indexed bit for value is 0, result is false. If the bit of value at index is 1, the returned value is true.","If index is bigger than the number of bits in value, the result is false.","Example","testResult = bit.test(10, 4)","print(testResult)","The binary equivalent of decimal 10 is 1010. Testing the bit at index position 4 returns a Boolean value of true.","Output:","true","Also see","bit.clear()","bit.get()","bit.set()","bit.toggle()","Logical operators","bit.test()","14641.html");
+Page[69]=new Array("This function toggles the value of a bit at a specified index position.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","result = bit.toggle(value, index)","result","Result of the bit manipulation","value","Specified number","index","One‑based bit position within value to toggle (1 to 32)","Details","This function returns result, which is the result of toggling the bit index in value.","Any fractional part of value is truncated to make it an integer. The returned value is also an integer.","The least significant bit of value is at index position 1; the most significant bit is at index position 32.","The indexed bit for value is toggled from 0 to 1, or 1 to 0.","Example","testResult = bit.toggle(10, 3)","print(testResult)","The binary equivalent of decimal 10 is 1010. Toggling the bit at index position 3 returns a decimal value of 14 (binary 1110).","Output:","1.40000e+01","Also see","bit.clear()","bit.get()","bit.set()","bit.test()","Logical operators","bit.toggle()","14642.html");
+Page[70]=new Array("This attribute sets the state of the reading buffer's append mode.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Not applicable","See Details","0 (disabled)","Usage","state = bufferVar.appendmode","bufferVar.appendmode = state","state","The reading buffer append mode; set to one of the following:","0: Append mode off; new measure data overwrites the previous buffer content","1: Append mode on; appends new measure data to the present buffer content","bufferVar","The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer","Details","Assigning a value to this attribute enables or disables the buffer append mode. This value can only be changed with an empty buffer. Use bufferVar.clear() to empty the buffer.","For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.","If the append mode is set to 0, any stored readings in the buffer are cleared before new ones are stored. If append mode is set to 1, any stored readings remain in the buffer and new readings are added to the buffer after the stored readings.","With append mode on, the first new measurement is stored at rb[n+1], where n is the number of readings stored in buffer rb.","Example","buffer1.appendmode = 1","Append new readings to contents of the reading buffer named buffer1.","Also see","bufferVar.clear()","Reading buffers","bufferVar.appendmode","15127.html");
+Page[71]=new Array("This attribute contains the timestamp of when the first reading was stored in the buffer.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","See Details","0","Usage","basetime = bufferVar.basetimestamp","basetime","The timestamp of the first stored reading","bufferVar","The reading buffer; can be a dynamically allocated buffer (user‑defined), or a dedicated reading buffer (such as smua.nvbuffer1)","Details","This read-only attribute contains the timestamp (in seconds) of the first reading stored in a buffer (rb[1] stored in reading buffer rb). The timestamp is the number of seconds since 12:00 AM January 1, 1970 (UTC) that the measurement was performed and stored.","For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.","See the smuX.nvbufferY attribute for details on accessing dedicated reading buffers.","Example","basetime = smua.nvbuffer1.basetimestamp","print(basetime)","Read the timestamp for the first reading","stored in dedicated reading buffer 1.","Output: 1.2830e+09","The above output indicates that the timestamp is 1,283,000,000 seconds (which is Saturday, August 28, 2010 at 12:53:20 PM).","Also see","smuX.measure.overlappedY()","smuX.measure.Y()","smuX.nvbufferY","smuX.trigger.measure.Y()","Reading buffers","bufferVar.basetimestamp","15128.html");
+Page[72]=new Array("This attribute enables or disables the reading buffer cache (on or off).","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Not applicable","Not saved","1 (enabled)","Usage","cacheMode = bufferVar.cachemode","bufferVar.cachemode = cacheMode","cacheMode","The reading buffer cache mode; set to one of the following:","0: Cache mode disabled (off)","1: Cache mode enabled (on)","bufferVar","The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer","Details","Assigning a value to this attribute enables or disables the reading buffer cache. When enabled, the reading buffer cache improves access speed to reading buffer data. ","If you run successive operations that overwrite reading buffer data, the reading buffer may return stale cache data. This can happen when initiating successive sweeps without reconfiguring the sweep measurements or when overwriting data in the reading buffer by setting the bufferVar.fillmode attribute to smuX.FILL_WINDOW. To avoid this, make sure that you include commands that automatically invalidate the cache as needed (for example, explicit calls to the bufferVar.clearcache() function) or disable the cache using this attribute (bufferVar.cachemode).","Example","smua.nvbuffer1.cachemode = 1","Enables reading buffer cache of dedicated reading buffer 1.","Also see","bufferVar.clearcache()","bufferVar.fillmode","bufferVar.cachemode","17109.html");
+Page[73]=new Array("This attribute contains the capacity of the buffer.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","See Details","Not applicable","Usage","bufferCapacity = bufferVar.capacity","bufferCapacity","The maximum number of readings the buffer can store","bufferVar","The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer","Details","This read-only attribute reads the number of readings that can be stored in the buffer.","For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.","The buffer's capacity does not change as readings fill the buffer. A dedicated reading buffer that only collects basic items can store over 140,000 readings. Turning on additional collection items, such as timestamps and source values, decreases the capacity of a dedicated reading buffer (for example, smua.nvbuffer1), but does not change the capacity of a user-defined dynamically allocated buffer. A user-defined dynamically allocated buffer has a fixed capacity that is set when the buffer is created.","See the smuX.nvbufferY attribute for details on accessing dedicated reading buffers. See the smuX.makebuffer() function for information on creating user-defined dynamically allocated reading buffers.","Example","bufferCapacity = smua.nvbuffer1.capacity","print(bufferCapacity)","Reads the capacity of dedicated reading buffer 1.","Output: ","1.49789e+05","The above output indicates that the buffer can hold 149789 readings.","Also see","Reading buffers","smuX.makebuffer()","smuX.measure.overlappedY()","smuX.measure.Y()","smuX.nvbufferY","smuX.trigger.measure.Y()","bufferVar.capacity","15129.html");
+Page[74]=new Array("This function clears the buffer.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","bufferVar.clear()","bufferVar","The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer","Details","This function clears all readings and associated recall attributes (for example, bufferVar.timestamps and bufferVar.statuses) from the specified buffer.","Example","smua.nvbuffer1.clear()","Clears dedicated reading buffer 1.","Also see","smuX.nvbufferY","Reading buffers","bufferVar.clear()","15130.html");
+Page[75]=new Array("This function clears the cache.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","bufferVar.clearcache()","bufferVar","The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer","Details","This function clears all readings from the specified cache. ","If you run successive operations that overwrite reading buffer data, the reading buffer may return stale cache data. This can happen when:","Initiating successive sweeps without reconfiguring the sweep measurements. Watch for this when running Lua code remotely on more than one node, because values in the reading buffer cache may change while the Lua code is running.","Overwriting data in the reading buffer by setting the bufferVar.fillmode attribute to smuX.FILL_WINDOW. ","To avoid this, you can include explicit calls to the bufferVar.clearcache() function to remove stale values from the reading buffer cache.","Example","smua.nvbuffer1.clearcache()","Clears the reading buffer cache for dedicated reading buffer 1.","Also see","bufferVar.fillmode","smuX.nvbufferY","Reading buffers","Removing stale values from the reading buffer","bufferVar.clearcache()","15131.html");
+Page[76]=new Array("This attribute sets whether or not source values will be stored with the readings in the buffer.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Not applicable","See Details","0 (disabled)","Usage","state = bufferVar.collectsourcevalues","bufferVar.collectsourcevalues = state","state","Source value collection status; set to one of the following:","0: Source value collection disabled (off)","1: Source value collection enabled (on)","bufferVar","The reading buffer; can be a dynamically allocated buffer (user‑defined), or a dedicated reading buffer (such as smua.nvbuffer1)","Details","Assigning a value to this attribute enables or disables the storage of source values. Reading this attribute returns the state of source value collection. This value can only be changed with an empty buffer. Empty the buffer using the bufferVar.clear() function.","For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.","When on, source values will be stored with readings in the buffer. This requires four extra bytes of storage per reading. Turning on additional collection items, such as source values (this attribute) and timestamps, decreases the capacity of a dedicated reading buffer (for example, smua.nvbuffer1), but does not change the capacity of a user-defined dynamically allocated buffer.","This value, off or on, can only be changed when the buffer is empty. Empty the buffer using the bufferVar.clear() function.","Example","smua.nvbuffer1.collectsourcevalues = 1","Include source values with readings for dedicated reading buffer 1.","Also see","bufferVar.clear()","smuX.measure.overlappedY()","smuX.measure.Y()","smuX.nvbufferY","smuX.trigger.measure.Y()","Reading buffers","bufferVar.collectsourcevalues","15132.html");
+Page[77]=new Array("This attribute sets whether or not timestamp values will be stored with the readings in the buffer.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Not applicable","See Details","0 (disabled)","Usage","state = bufferVar.collecttimestamps","bufferVar.collecttimestamps = state","state","Timestamp value collection status; set to one of the following:","0: Timestamp value collection disabled (off)","1: Timestamp value collection enabled (on)","bufferVar","The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer","Details","Assigning a value to this attribute enables or disables the storage of timestamps. Reading this attribute returns the state of timestamp collection. ","For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.","When on, timestamp values will be stored with readings in the buffer. This requires four extra bytes of storage per reading. Turning on additional collection items, such as timestamps (this attribute)and source values, decreases the capacity of a dedicated reading buffer (for example, smua.nvbuffer1), but does not change the capacity of a user-defined dynamically allocated buffer.","This value, off (0) or on (1), can only be changed when the buffer is empty. Empty the buffer using the bufferVar.clear() function.","Example","smua.nvbuffer1.collecttimestamps = 1","Include timestamps with readings for dedicated reading buffer 1.","Also see","bufferVar.clear()","smuX.measure.overlappedY()","smuX.measure.Y()","smuX.nvbufferY","smuX.trigger.measure.Y()","Reading buffers","bufferVar.collecttimestamps","15133.html");
+Page[78]=new Array("This attribute sets the reading buffer fill count.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Not applicable","See Details","0","Usage","fillCount = bufferVar.fillcount","bufferVar.fillcount = fillCount","fillCount","The reading buffer fill count","bufferVar","The reading buffer; can be a dynamically allocated buffer (user‑defined), or a dedicated reading buffer (such as smua.nvbuffer1)","Details","The reading buffer fill count sets the number of readings to store before restarting at index 1. If the value is zero (0), then the capacity of the buffer is used. Use this attribute to control when the SMU restarts filling the buffer at index 1, rather than having it restart when the buffer is full. ","If the bufferVar.fillcount attribute is set to a value higher than the capacity of the buffer, after storing the element at the end of the buffer, the SMU will overwrite the reading at index 1, the reading after that will overwrite the reading at index 2, and so on.","This attribute is only used when the bufferVar.fillmode attribute is set to smuX.FILL_WINDOW.","For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.","Example","smua.nvbuffer1.fillcount = 50","Sets fill count of dedicated reading buffer 1 to 50.","Also see","bufferVar.fillmode","bufferVar.fillcount","18551.html");
+Page[79]=new Array("This attribute sets the reading buffer fill mode.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Not applicable","See Details","0 (smuX.FILL_ONCE)","Usage","fillMode = bufferVar.fillmode","bufferVar.fillmode = fillMode","fillMode","The reading buffer fill mode; set to one of the following:","0 or smuX.FILL_ONCE: Do not overwrite old data","1 or smuX.FILL_WINDOW: New readings restart at index 1 after acquiring reading at index bufferVar.fillcount","bufferVar","The reading buffer; can be a dynamically allocated buffer (user‑defined), or a dedicated reading buffer (such as smua.nvbuffer1)","Details","When this attribute is set to smuX.FILL_ONCE, the reading buffer will not overwrite readings. If the buffer fills up, new readings will be discarded. ","When this attribute is set to smuX.FILL_WINDOW, new readings will be added after existing data until the buffer holds bufferVar.fillcount elements. Continuing the sequence, the next reading will overwrite the reading at index 1, the reading after that will overwrite the reading at index 2, and so on. ","For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.","Example","smua.nvbuffer1.fillmode = smua.FILL_ONCE","Sets fill mode of dedicated reading buffer 1 to fill once (do not overwrite old data).","Also see","bufferVar.fillcount","bufferVar.fillmode","18552.html");
+Page[80]=new Array("This attribute contains the measurement function that was used to acquire a reading stored in a specified reading buffer.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Clearing the buffer","See Details","Not applicable","Usage","measurefunction = bufferVar.measurefunctions[N]","measurefunction","The measurement function used ("current", "voltage", "ohms", or "watts") to acquire reading number N in the specified buffer","bufferVar","The reading buffer; can be a dynamically allocated buffer (user‑defined), or a dedicated reading buffer (such as smua.nvbuffer1)","N","The reading number (1 to bufferVar.n)","Details","The measurefunctions buffer recall attribute is like an array (a Lua table) of strings indicating the function measured for the reading.","For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.","Example 1","measurefunction = smua.nvbuffer1.measurefunctions[5]","Store the measure function used to make reading number 5.","Example 2","printbuffer(1, 5, smua.nvbuffer1.measurefunctions)","Print the measurement function that was used to measure the first five readings saved in dedicated reading buffer 1. Example output:","Current, Current, Current, Current, Current","Also see","bufferVar.measureranges","bufferVar.n","bufferVar.readings","bufferVar.sourcefunctions","bufferVar.sourceoutputstates","bufferVar.sourceranges","bufferVar.sourcevalues","bufferVar.statuses","bufferVar.timestamps","bufferVar.measurefunctions","19914.html");
+Page[81]=new Array("This attribute contains the measurement range values that were used for readings stored in a specified buffer.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Clearing the buffer","See Details","Not applicable","Usage","measurerange = bufferVar.measureanges[N]","measurerange","The measurement range used to acquire reading number N in the specified buffer","bufferVar","The reading buffer; can be a dynamically allocated buffer (user‑defined), or a dedicated reading buffer (such as smua.nvbuffer1)","N","The reading number (1 to bufferVar.n)","Details","The measureranges buffer recall attribute is like an array (a Lua table) of full-scale range values for the measure range used when the measurement was made.","For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.","Example","measurerange = smua.nvbuffer1.measureranges[1]","Store the measure range that was used to make reading number 1.","printbuffer(1, 10, smua.nvbuffer1.measureranges)","Print the range values that were used for the first 10 readings saved in dedicated reading buffer 1.","Example output:","1.00000e-07, 1.00000e-07, 1.00000e-07, 1.00000e-07, 1.00000e-07, 1.00000e-07, 1.00000e-07, 1.00000e-07, 1.00000e-07, 1.00000e-07","Also see","bufferVar.measurefunctions","bufferVar.n","bufferVar.readings","bufferVar.sourcefunctions","bufferVar.sourceoutputstates","bufferVar.sourceranges","bufferVar.sourcevalues","bufferVar.statuses","bufferVar.timestamps","bufferVar.measureranges","19915.html");
+Page[82]=new Array("This attribute contains the number of readings in the buffer.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Clearing the buffer","See Details","Not applicable","Usage","numberOfReadings = bufferVar.n","numberOfReadings","The number of readings stored in the buffer","bufferVar","The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer","Details","This read-only attribute contains the number of readings presently stored in the buffer.","For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.","Example","numberOfReadings = smua.nvbuffer1.n","print(numberOfReadings)","Reads the number of readings stored in dedicated reading buffer 1.","Output: 1.250000+02","The above output indicates that there are 125 readings stored in the buffer.","Also see","bufferVar.measurefunctions","bufferVar.measureranges","bufferVar.readings","bufferVar.sourcefunctions","bufferVar.sourceoutputstates","bufferVar.sourceranges","bufferVar.sourcevalues","bufferVar.statuses","bufferVar.timestamps","Reading buffers","smuX.measure.overlappedY()","smuX.measure.Y()","smuX.nvbufferY","smuX.trigger.measure.Y()","bufferVar.n","15134.html");
+Page[83]=new Array("This attribute contains the readings stored in a specified reading buffer.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Clearing the buffer","See Details","Not applicable","Usage","reading = bufferVar.readings[N]","reading","The value of the reading in the specified reading buffer","bufferVar","The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer","N","The reading number (1 to bufferVar.n)","Details","The readings buffer recall attribute is like an array (a Lua table) of the readings stored in the reading buffer. This array holds the same data that is returned when the reading buffer is accessed directly; that is, rb[2] and rb.readings[2] access the same value.","For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.","Example","print(smua.nvbuffer1.readings[1])","Output the first reading saved in dedicated reading buffer 1.","Output:","8.81658e-08","Also see","bufferVar.measurefunctions","bufferVar.measureranges","bufferVar.n","bufferVar.sourcefunctions","bufferVar.sourceoutputstates","bufferVar.sourceranges","bufferVar.sourcevalues","bufferVar.statuses","bufferVar.timestamps","Reading buffers","bufferVar.readings","19920.html");
+Page[84]=new Array("This attribute contains the source function that was used for readings stored in a specified reading buffer.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Clearing the buffer","See Details","Not applicable","Usage","sourcefunction = bufferVar.sourcefunctions[N]","sourcefunction","The source function used ("current" or "voltage") to acquire reading number N in the specified buffer","bufferVar","The reading buffer; can be a dynamically allocated buffer (user‑defined), or a dedicated reading buffer (such as smua.nvbuffer1)","N","The reading number (1 to bufferVar.n)","Details","The sourcefunctions buffer recall attribute is like an array (a Lua table) of strings indicating the source function at the time of the measurement.","For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.","Example 1","sourcefunction = smua.nvbuffer1.sourcefunctions[3]","Store the source function used to make reading number 3.","Example 2","printbuffer(1, 10, smua.nvbuffer1.sourcefunctions)","Print the source function used for 10 readings stored in dedicated reading buffer 1.","Example output:","Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage","Also see","bufferVar.measurefunctions","bufferVar.measureranges","bufferVar.n","bufferVar.readings","bufferVar.sourceoutputstates","bufferVar.sourceranges","bufferVar.sourcevalues","bufferVar.statuses","bufferVar.timestamps","bufferVar.sourcefunctions","19916.html");
+Page[85]=new Array("This attribute indicates the state of the source output for readings stored in a specified buffer.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Clearing the buffer","See Details","Not applicable","Usage","state = bufferVar.sourceoutputstates[N]","state ","The output state ("Off" or "On") when reading N of the specified buffer was acquired","bufferVar","The reading buffer; can be a dynamically allocated buffer (user‑defined), or a dedicated reading buffer (such as smua.nvbuffer1)","N","The reading number (1 to bufferVar.n)","Details","The sourceoutputstates buffer recall attribute is like an array (a Lua table) of strings indicating the state of the source output ("Off" or "On") at the time of the measurement.","For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.","Example","printbuffer(1, 1, smua.nvbuffer1.sourceoutputstates)","Print the source output for the first reading stored in dedicated reading buffer 1.","Example output: On","Also see","bufferVar.measurefunctions","bufferVar.measureranges","bufferVar.n","bufferVar.readings","bufferVar.sourcefunctions","bufferVar.sourceranges","bufferVar.sourcevalues","bufferVar.statuses","bufferVar.timestamps","bufferVar.sourceoutputstates","19917.html");
+Page[86]=new Array("This attribute contains the source range that was used for readings stored in a specified reading buffer.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Clearing the buffer","See Details","Not applicable","Usage","sourcerange = bufferVar.sourceranges[N]","sourcerange","The source range used to acquire reading number N in the specified buffer","bufferVar","The reading buffer; can be a dynamically allocated buffer (user‑defined), or a dedicated reading buffer (such as smua.nvbuffer1)","N","The reading number (1 to bufferVar.n)","Details","The sourceranges buffer recall attribute is like an array (a Lua table) of full-scale range values for the source range used when the measurement was made.","For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.","Example 1","sourcerange = smua.nvbuffer1.sourceranges[1]","Store the source range that was used for the first reading stored in dedicated reading buffer 1.","Example 2","printbuffer(1, 6, smua.nvbuffer1.sourceranges)","Print the source ranges that were used for the first 6 readings stored in source‑measure unit (SMU) A, buffer 1.","Example output:","1.00000e-04, 1.00000e-04, 1.00000e-04, 1.00000e-04, 1.00000e-04, 1.00000e-04","Also see","bufferVar.measurefunctions","bufferVar.measureranges","bufferVar.n","bufferVar.readings","bufferVar.sourcefunctions","bufferVar.sourceoutputstates","bufferVar.sourcevalues","bufferVar.statuses","bufferVar.timestamps","bufferVar.sourceranges","19918.html");
+Page[87]=new Array("When enabled by the bufferVar.collectsourcevalues attribute, this attribute contains the source levels being output when readings in the reading buffer were acquired.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Clearing the buffer","See Details","Not applicable","Usage","sourcevalue = bufferVar.sourcevalues[N]","sourcevalue","The source's output value when reading N of the specified buffer was acquired","bufferVar","The reading buffer; can be a dynamically allocated buffer (user‑defined), or a dedicated reading buffer (such as smua.nvbuffer1)","N","The reading number (1 to bufferVar.n)","Details","If the bufferVar.collectsourcevalues attribute is enabled before readings are taken, the bufferVar.sourcevalues buffer recall attribute is like an array (a Lua table) of the sourced value in effect at the time of the reading. Note that you can set the bufferVar.collectsourcevalues attribute only if the affected reading buffer is empty. See bufferVar.collectsourcevalues for more detailed information.","For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.","Example 1","sourcevalue = smua.nvbuffer1.sourcevalues[1]","Get the sourced value of the first reading stored in dedicated reading buffer 1.","Example 2","printbuffer(1, 6, smua.nvbuffer1.sourcevalues)","Print the sourced value of the first 6 readings stored in source‑measure unit (SMU) A, buffer 1.","Example output:","1.00000e-04, 1.00000e-04,","1.00000e-04, 1.00000e-04,","1.00000e-04, 1.00000e-04","Also see","bufferVar.measurefunctions","bufferVar.measureranges","bufferVar.n","bufferVar.readings","bufferVar.sourcefunctions","bufferVar.sourceoutputstates","bufferVar.sourceranges","bufferVar.statuses","bufferVar.timestamps","bufferVar.sourcevalues","19919.html");
+Page[88]=new Array("This attribute contains the status values of readings in the reading buffer.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Clearing the buffer","See Details","Not applicable","Usage","statusInformation = bufferVar.statuses[N]","statusInformation","The status value when reading N of the specified buffer was acquired ","bufferVar","The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer","N","The reading number (1 to bufferVar.n)","Details","This read‑only buffer recall attribute is like an array (a Lua table) of the status values for all of the readings in the buffer. The status values are floating-point numbers that encode the status value; see the following table for values. ","For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.","Buffer status bits","Bit","Name","Hex value","Description","B0","FastADC","0x01","Fast ADC was used to make the reading","B1","Overtemp","0x02","Over temperature condition","B2","AutoRangeMeas","0x04","Measure range was autoranged","B3","AutoRangeSrc","0x08","Source range was autoranged","B4","4Wire","0x10","4-wire (remote) sense mode enabled","B5","Rel","0x20","Rel applied to reading","B6","Compliance","0x40","Source function in compliance","B7","Filtered","0x80","Reading was filtered","Also see","bufferVar.measurefunctions","bufferVar.measureranges","bufferVar.n","bufferVar.readings","bufferVar.measurefunctions","bufferVar.measureranges","bufferVar.timestamps","Reading buffers","bufferVar.statuses","19921.html");
+Page[89]=new Array("This attribute contains the timestamp's resolution.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Not applicable","See Details","1e-6 (1 ms)","Usage","resolution = bufferVar.timestampresolution","resolution","Timestamp resolution in seconds","bufferVar","The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer","Details","Assigning a value to this attribute sets the resolution for the timestamps. Reading this attribute returns the timestamp resolution value.This value can only be changed with an empty buffer. Empty the buffer using the bufferVar.clear() function.","The finest timestamp resolution is 0.000001 seconds (1 μs). At this resolution, the reading buffer can store unique timestamps for up to 71 minutes. This value can be increased for very long tests.","The value specified when setting this attribute will be rounded to an even power of 2 μs.","For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.","Example","smua.nvbuffer1.timestampresolution = 0.000008","Sets the timestamp resolution of dedicated reading buffer 1 to 8 μs.","Also see","bufferVar.clear()","bufferVar.collecttimestamps","bufferVar.timestamps","smuX.measure.overlappedY()","smuX.measure.Y()","smuX.nvbufferY","smuX.trigger.measure.Y()","Reading buffers","bufferVar.timestampresolution","15135.html");
+Page[90]=new Array("When enabled by the bufferVar.collecttimestamps attribute, this attribute contains the timestamp (in seconds) of when each reading saved in the specified reading buffer occurred.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Clearing the buffer","See Details","Not applicable","Usage","timestamp = bufferVar.timestamps[N]","timestamp","The timestamp of reading number N in the specified buffer when the reading was acquired","bufferVar","The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer","N","The reading number (1 to bufferVar.n)","Details","The bufferVar.timestamps information from a reading buffer is only available if the bufferVar.collecttimestamps attribute is set to 1 (default setting). If it is set to 0, you will not be able to access any time information from a reading buffer. ","If enabled, this buffer recall attribute is like an array (a Lua table) containing timestamps, in seconds, of when each reading occurred. These are relative to the bufferVar.basetimestamp for the buffer. See Reading buffer commands for more information.","For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.","Example","timestamp = smua.nvbuffer1.timestamps[1]","Get the timestamp of the first reading stored in dedicated reading buffer 1.","Also see","bufferVar.clear()","bufferVar.collecttimestamps","bufferVar.measurefunctions","bufferVar.n","bufferVar.measureranges","bufferVar.readings","bufferVar.sourcefunctions","bufferVar.sourceoutputstates","bufferVar.sourceranges","bufferVar.sourcevalues","bufferVar.statuses","Reading buffers","bufferVar.timestamps","19922.html");
+Page[91]=new Array("This KIPulse factory script function configures a current pulse train with a voltage measurement at each point.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, "," tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)","f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, "," tag, sync_in, sync_out, sync_in_timeout)","f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, "," tag, sync_in, sync_out)","f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, "," tag, sync_in)","f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, "," tag)","f","A Boolean flag. This flag will be true when the pulse was successfully configured, false when errors were encountered ","msg","A string message; if the f flag is false, msg will contain an error message; if it is true, msg will contain a string indicating successful configuration","smu","System SourceMeter® instrument channel (set to smua)","bias","Bias level in amperes","level","Pulse level in amperes","limit","Voltage limit (for example, compliance) in volts","ton","Pulse on time in seconds","toff","Pulse off time in seconds","points","Number of pulse-measure cycles","buffer","Reading buffer where pulsed measurements will be stored; if this is nil when the function is called, no measurements will be made when the pulse train is initiated","tag","Numeric identifier to be assigned to the defined pulse train","sync_in","Defines a digital I/O trigger input line; if programmed, the pulse train will wait for a trigger input before executing each pulse","sync_out","Defines a digital I/O trigger output line; if programmed, the pulse train will generate a trigger output immediately before the start of ton (this parameter is optional)","sync_in_timeout","Specifies the length of time (in seconds) to wait for input trigger; default value is 10 s","sync_in_abort","Specifies whether or not to abort pulse if input trigger is not received. If pulse aborts because of a missed trigger, a timer timeout message is returned; true or false","Details","Data for pulsed voltage measurements are stored in the reading buffer specified by the buffer input parameter.","Configures a current pulse train with a voltage measurement at each point. Measurements are made at the end of the ton time. ","This function does not cause the specified smu to output a pulse train. It simply checks to see if all of the pulse dimensions are achievable, and if they are, assigns the indicated tag or index to the pulse train. The InitiatePulseTest(tag) function is used to initiate a pulse train assigned to a valid tag.","Example","ConfigPulseIMeasureV(smua, 0, 5, 10,"," 0.001, 0.080, 1, smua.nvbuffer1, 1)","Set up a pulse train that uses System SourceMeter® instrument channel A. The pulse amplitude will be 5 A and will return to 0 A after 1 ms. The pulse will remain at 0 A for 80 ms and the voltage limit will be 10 V during the pulse. The pulse train will consist of only 1 pulse, and this pulse will be assigned a tag index of 1.","Also see","InitiatePulseTest()","ConfigPulseIMeasureV()","12926.html");
+Page[92]=new Array("This KIPulse factory script function configures a linear pulsed current sweep with a voltage measurement at each point.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)","f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)","f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)","f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)","f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)","f","A Boolean flag; this flag will be true when the pulse was successfully configured, false when errors were encountered","msg","A string message; if the f flag is false, msg will contain an error message; if it is true, msg will contain a string indicating successful configuration","smu","System SourceMeter® instrument channel (set to smua)","bias","Bias level in amperes","start","Pulse sweep start level in volts","stop","Pulse sweep stop level in volts","limit","Voltage limit (for example, compliance) in volts","ton","Pulse on time in seconds","toff","Pulse off time in seconds","points","Number of pulse-measure cycles","buffer","Reading buffer where pulsed measurements will be stored; if this is nil when the function is called, no measurements will be made when the pulse train is initiated","tag","Numeric identifier to be assigned to the defined pulse train","sync_in","Defines a digital I/O trigger input line; if programmed, the pulse train will wait for a trigger input before executing each pulse (this parameter is optional)","sync_out","Defines a digital I/O trigger output line; if programmed, the pulse train will generate a trigger output immediately before the start of ton (this parameter is optional)","sync_in_timeout","Specifies the length of time (in seconds) to wait for input trigger; default value is 10 s","sync_in_abort","Specifies whether or not to abort pulse if input trigger is not received. If pulse aborts because of a missed trigger, a timer timeout message is returned; true or false","Details","Data for pulsed voltage measurements are stored in the reading buffer specified by the buffer input parameter.","Configures a linear pulsed current sweep with a voltage measurement at each point. Measurements are made at the end of the ton time.","The magnitude of the first pulse will be start amperes; the magnitude of the last pulse will be stop amperes. The magnitude of each pulse in between will be step amperes larger than the previous pulse, where:","step = (stop - start) / (points - 1) ","This function does not cause the specified smu to output a pulse train. It simply checks to see if all of the pulse dimensions are achievable, and if they are, assigns the indicated tag or index to the pulse train. The InitiatePulseTest(tag) function is used to initiate a pulse train assigned to a valid tag.","Example","ConfigPulseIMeasureVSweepLin(smua, 0,"," 0.01, 0.05, 1, 1e-3, 0.1, 20,"," smua.nvbuffer2, 3)","Set up a pulsed sweep that will use System SourceMeter® instrument channel A. The pulsed sweep will start at 10 mA, end at 50 mA, and return to a 0 mA bias level between pulses. Each pulsed step will be on for 1 ms, and then at the bias level for 100 ms. The voltage limit will be 1 V during the entire pulsed sweep. The pulse train will be comprised of 20 pulsed steps and the pulse train will be assigned a tag index of 3.","Also see","InitiatePulseTest()","ConfigPulseIMeasureVSweepLin()","12937.html");
+Page[93]=new Array("This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff,"," points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)","f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff,"," points, buffer, tag, sync_in, sync_out, sync_in_timeout)","f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff,"," points, buffer, tag, sync_in, sync_out)","f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff,"," points, buffer, tag, sync_in)","f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff,"," points, buffer, tag)","f","A Boolean flag; this flag will be true when the pulse was successfully configured, false when errors were encountered ","msg","A string message; if the f flag is false, msg will contain an error message; if it is true, msg will contain a string indicating successful configuration","smu","System SourceMeter® instrument channel (set to smua)","bias","Bias level in amperes","start","Pulse sweep start level in amperes","stop","Pulse sweep stop level in amperes","limit","Voltage limit (for example, compliance) in volts","ton","Pulse on time in seconds","toff","Pulse off time in seconds","points","Number of pulse-measure cycles","buffer","Reading buffer where pulsed measurements will be stored; if this is nil when the function is called, no measurements will be made when the pulse train is initiated","tag","Numeric identifier to be assigned to the defined pulse train","sync_in","Defines a digital I/O trigger input line; if programmed, the pulse train will wait for a trigger input before executing each pulse (this parameter is optional)","sync_out","Defines a digital I/O trigger output line; if programmed, the pulse train will generate a trigger output immediately before the start of ton (this parameter is optional)","sync_in_timeout","Specifies the length of time (in seconds) to wait for input trigger; default value is 10 s","sync_in_abort","Specifies whether or not to abort pulse if input trigger is not received. If pulse aborts because of a missed trigger, a timer timeout message is returned; true or false ","Details","Data for pulsed voltage measurements are stored in the reading buffer specified by the buffer input parameter.","Configures a logarithmic pulsed current sweep with a voltage measurement at each point. Measurements are made at the end of the ton time.","The magnitude of the first pulse will be start amperes; the magnitude of the last pulse will be stop amperes. The magnitude of each pulse in between will be LogStepn amperes larger than the previous pulse, where:","LogStepSize = (log10(stop) - log10(start)) / (points -1)","LogStepn = (n - 1) * (LogStepSize), where n = [1, points]","SourceStepLeveln = antilog(LogStepn) * start","This function does not cause the specified smu to output a pulse train. It simply checks to see if all of the pulse dimensions are achievable, and if they are, assigns the indicated tag or index to the pulse train. The InitiatePulseTest(tag) function is used to initiate a pulse train assigned to a valid tag.","Example","ConfigPulseIMeasureVSweepLog(smua, 0,"," 1e-3, 0.01, 1, 1e-3, 10e-3, 10,"," smua.nvbuffer1, 5)","Set up a pulsed logarithmic sweep that uses System SourceMeter® instrument channel A. The pulsed sweep will start at 1 mA, end at 10 mA, and return to a 0 A bias level between pulses. Each pulsed step will be on for 1 ms, and then at the bias level for 10 ms. The voltage limit will be 1 V during the entire pulsed sweep. The pulse train will be comprised of 10 pulsed steps, and the pulse train will be assigned a tag index of 5.","Also see","InitiatePulseTest()","ConfigPulseIMeasureVSweepLog()","12943.html");
+Page[94]=new Array("This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, "," tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)","f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, "," tag, sync_in, sync_out, sync_in_timeout)","f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, "," tag, sync_in, sync_out)","f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, "," tag, sync_in)","f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, "," tag)","f","A Boolean flag; this flag will be true when the pulse was successfully configured, false when errors were encountered ","msg","A string message; if the f flag is false, msg will contain an error message; if it is true, msg will contain a string indicating successful configuration","smu","System SourceMeter® instrument channel (set to smua)","bias","Bias level in volts","level","Pulse level in volts","limit","Current limit (for example, compliance) in amperes","ton","Pulse on time in seconds","toff","Pulse off time in seconds","points","Number of pulse-measure cycles","buffer","Reading buffer where pulsed measurements will be stored; if this is nil when the function is called, no measurements will be made when the pulse train is initiated","tag","Numeric identifier to be assigned to the defined pulse train","sync_in","Defines a digital I/O trigger input line; if programmed, the pulse train will wait for a trigger input before executing each pulse (this parameter is optional)","sync_out","Defines a digital I/O trigger output line; if programmed, the pulse train will generate a trigger output immediately before the start of ton (this parameter is optional)","sync_in_timeout","Specifies the length of time (in seconds) to wait for input trigger; default value is 10 s","sync_in_abort","Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or false","Details","Data for pulsed current measurements are stored in the reading buffer specified by the buffer input parameter.","Configures a voltage pulse train with a current measurement at each point. Measurements are made at the end of the ton time. ","This function does not cause the specified smu to output a pulse train. It simply checks to see if all of the pulse dimensions are achievable, and if they are, assigns the indicated tag or index to the pulse train.The InitiatePulseTest(tag) function is used to initiate a pulse train assigned to a valid tag.","Example 1","ConfigPulseVMeasureI(smua, 0, 20, 1,"," 0.001, 0.080, 10, smua.nvbuffer1, 2)","Set up a pulse train that uses System SourceMeter® instrument channel A. The pulse amplitude will be 20 V and will return to 0 V after 1 ms. The pulse will remain at 0 V for 80 ms, and the current limit will be 1 A during the pulse. The pulse train will consist of 10 pulses, and the pulse train will be assigned a tag index of 2.","Example 2","local timelist = { 1, 2, 3, 4, 5 }","f, msg = ConfigPulseVMeasureI(smua, 0, 1,"," 100e-3, 1, timelist, 5, nil, 1)","Variable off time between pulses in a pulse train.","Configure a pulse with 1 second on-time and variable off-time, no measurement.","Example 3","rbi = smua.makebuffer(10)","rbv = smua.makebuffer(10)","rbi.appendmode = 1","rbv.appendmode = 1","rbs = { i = rbi, v = rbv }","f, msg = ConfigPulseVMeasureI(smua, 0, 10,"," 1e-3, 1e-3, 1e-3, 2, rbs, 1)","Simultaneous IV measurement during pulse.","Also see","InitiatePulseTest()","ConfigPulseVMeasureI()","12931.html");
+Page[95]=new Array("This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff,"," points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)","f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff,"," points, buffer, tag, sync_in, sync_out, sync_in_timeout)","f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff,"," points, buffer, tag, sync_in, sync_out)","f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff,"," points, buffer, tag, sync_in)","f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff,"," points, buffer, tag)","f","A Boolean flag. This flag will be true when the pulse was successfully configured, false when errors were encountered ","msg","A string message; if the f flag is false, msg will contain an error message; if it is true, msg will contain a string indicating successful configuration","smu","System SourceMeter® instrument channel (set to smua)","bias","Bias level in volts","start","Pulse sweep start level in volts","stop","Pulse sweep stop level in volts","limit","Current limit (for example, compliance) in amperes","ton","Pulse on time in seconds","toff","Pulse off time in seconds","points","Number of pulse-measure cycles","buffer","Reading buffer where pulsed measurements will be stored; if this is nil when the function is called, no measurements will be made when the pulse train is initiated","tag","Numeric identifier to be assigned to the defined pulse train","sync_in","Defines a digital I/O trigger input line; if programmed, the pulse train will wait for a trigger input before executing each pulse (this parameter is optional)","sync_out","Defines a digital I/O trigger output line; if programmed, the pulse train will generate a trigger output immediately before the start of ton (this parameter is optional)","sync_in_timeout","Specifies the length of time (in seconds) to wait for input trigger; default value is 10 s","sync_in_abort","Specifies whether or not to abort pulse if input trigger is not received. If pulse aborts because of a missed trigger, a timer timeout message is returned; true or false","Details","Data for pulsed current measurements are stored in the reading buffer specified by the buffer input parameter.","Configures a linear pulsed voltage sweep with a current measurement at each point. Measurements are made at the end of the ton time.","The magnitude of the first pulse will be start volts; the magnitude of the last pulse will be stop volts. The magnitude of each pulse in between will be step volts larger than the previous pulse, where:","step = (stop - start) / (points - 1)","This function does not cause the specified smu to output a pulse train. It simply checks to see if all of the pulse dimensions are achievable, and if they are, assigns the indicated tag or index to the pulse train. The InitiatePulseTest(tag) function is used to initiate a pulse train assigned to a valid tag.","Example","ConfigPulseVMeasureISweepLin(smua, 0, 1,"," 10, 1, 10e-3, 20e-3, 16,"," smua.nvbuffer1, 4)","Set up a pulsed sweep that will use System SourceMeter® instrument channel A. The pulsed sweep will start at 1 V, end at 10 V, and return to a 0 V bias level between pulses. Each pulsed step will be on for 10 ms, and then at the bias level for 20 ms. ","The current limit will be 1 A during the entire pulsed sweep. The pulse train will be comprised of 16 pulsed steps, and the pulse train will be assigned a tag index of 4.","Also see","InitiatePulseTest()","ConfigPulseVMeasureISweepLin()","12940.html");
+Page[96]=new Array("This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, "," points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)","f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, "," points, buffer, tag, sync_in, sync_out, sync_in_timeout)","f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, "," points, buffer, tag, sync_in, sync_out)","f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, "," points, buffer, tag, sync_in)","f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, "," points, buffer, tag)","f","A Boolean flag. This flag will be true when the pulse was successfully configured, false when errors were encountered","msg","A string message; if the f flag is false, msg will contain an error message; if it is true, msg will contain a string indicating successful configuration","smu","System SourceMeter® instrument channel (set to smua)","bias","Bias level in volts","start","Pulse sweep start level in volts","stop","Pulse sweep stop level in volts","limit","Current limit (for example, compliance) in amperes","ton","Pulse on time in seconds","toff","Pulse off time in seconds","points","Number of pulse-measure cycles","buffer","Reading buffer where pulsed measurements will be stored; if this is nil when the function is called, no measurements will be made when the pulse train is initiated","tag","Numeric identifier to be assigned to the defined pulse train","sync_in","Defines a digital I/O trigger input line; if programmed, the pulse train will wait for a trigger input before executing each pulse (this parameter is optional)","sync_out","Defines a digital I/O trigger output line; if programmed, the pulse train will generate a trigger output immediately before the start of ton (this parameter is optional)","sync_in_timeout","Specifies the length of time (in seconds) to wait for input trigger; default value is 10 s","sync_in_abort","Specifies whether or not to abort pulse if input trigger is not received. If pulse aborts because of a missed trigger, a timer timeout message is returned; true or false","Details","Data for pulsed current measurements are stored in the reading buffer specified by the buffer input parameter.","Configures a logarithmic pulsed voltage sweep with a current measurement at each point. Measurements are made at the end of the ton time.","The magnitude of the first pulse will be start volts; the magnitude of the last pulse will be stop volts. The magnitude of each pulse in between will be LogStepn volts larger than the previous pulse, where:","LogStepSize = (log10(stop) - log10(start)) / (points -1)","LogStepn = (n - 1) * (LogStepSize), where n = [1, points]","SourceStepLeveln = antilog(LogStepn) * start","This function does not cause the specified smu to output a pulse train. It simply checks to see if all of the pulse dimensions are achievable, and if they are, assigns the indicated tag or index to the pulse train. The InitiatePulseTest(tag)function is used to initiate a pulse train assigned to a valid tag.","Example","ConfigPulseVMeasureISweepLog(smua, 0, 1,"," 10, 1, 10e-3, 20e-3, 10,"," smua.nvbuffer1, 6)","Set up a pulsed logarithmic sweep that will use System SourceMeter® instrument channel A. The pulsed sweep will start at 1 V, end at 10 V, and return to a 0 V bias level between pulses. Each pulsed step will be on for 10 ms, and then at the bias level for 20 ms. ","The current limit will be 1 A during the entire pulsed sweep. The pulse train will be comprised of 10 pulsed steps, and the pulse train will be assigned a tag index of 6.","Also see","InitiatePulseTest()","ConfigPulseVMeasureISweepLog()","12946.html");
+Page[97]=new Array("This function adds an entry to the data queue.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","result = dataqueue.add(value)","result = dataqueue.add(value, timeout)","result","The resulting value of true or false based on the success of the function","value","The data item to add; value can be of any type","timeout","The maximum number of seconds to wait for space in the data queue","Details","You cannot use the timeout value when accessing the data queue from a remote node (you can only use the timeout value while adding data to the local data queue).","The timeout value is ignored if the data queue is not full.","The dataqueue.add() function returns false:","If the timeout expires before space is available in the data queue","If the data queue is full and a timeout value is not specified","If the value is a table, a duplicate of the table and any subtables is made. The duplicate table does not contain any references to the original table or to any subtables.","Example","dataqueue.clear()","dataqueue.add(10)","dataqueue.add(11, 2)","result = dataqueue.add(12, 3)","if result == false then"," print("Failed to add 12 to the dataqueue")","end","print("The dataqueue contains:")","while dataqueue.count > 0 do"," print(dataqueue.next())","end","Clear the data queue.","Each line adds one item to the data queue.","Output:","The dataqueue contains:","1.00000e+01","1.10000e+01","1.20000e+01","Also see","dataqueue.CAPACITY","dataqueue.clear()","dataqueue.count","dataqueue.next()","dataqueue.add()","14654.html");
+Page[98]=new Array("This constant is the maximum number of entries that you can store in the data queue.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Constant","Yes","Usage","count = dataqueue.CAPACITY","count","The variable assigned the value of dataqueue.CAPACITY","Details","This constant always returns the maximum number of entries that can be stored in the data queue.","Example","MaxCount = dataqueue.CAPACITY","while dataqueue.count < MaxCount do"," dataqueue.add(1)","end","print("There are " .. dataqueue.count"," .. " items in the data queue")","Add items to the data queue until it is at capacity.","Output:","There are 128 items in the data queue","Also see","dataqueue.add()","dataqueue.clear()","dataqueue.count","dataqueue.next()","dataqueue.CAPACITY","14656.html");
+Page[99]=new Array("This function clears the data queue.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","dataqueue.clear()","Details","This function forces all dataqueue.add() commands that are in progress to time out.","The function deletes all data from the data queue.","Example","MaxCount = dataqueue.CAPACITY","while dataqueue.count < MaxCount do"," dataqueue.add(1)","end","print("There are " .. dataqueue.count"," .. " items in the data queue")","dataqueue.clear()","print("There are " .. dataqueue.count"," .. " items in the data queue")","This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.","Output:","There are 128 items in the data queue","There are 0 items in the data queue","Also see","dataqueue.add()","dataqueue.CAPACITY","dataqueue.count","dataqueue.next()","dataqueue.clear()","14655.html");
+Page[100]=new Array("This attribute contains the number of items in the data queue.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Power cycle","Not saved","Not applicable","Usage","count = dataqueue.count","count","The number of items in the data queue","Details","The count gets updated as entries are added with dataqueue.add() and read from the data queue with dataqueue.next(). It is also updated when the dataqueue is cleared with dataqueue.clear().","A maximum of dataqueue.CAPACITY items can be stored at any one time in the data queue.","Example","MaxCount = dataqueue.CAPACITY","while dataqueue.count < MaxCount do"," dataqueue.add(1)","end","print("There are " .. dataqueue.count"," .. " items in the data queue")","dataqueue.clear()","print("There are " .. dataqueue.count"," .. " items in the data queue")","Add items to the data queue until it is at capacity.","Output:","There are 128 items in the data queue","There are 0 items in the data queue","Also see","dataqueue.add()","dataqueue.CAPACITY","dataqueue.clear()","dataqueue.next()","dataqueue.count","14657.html");
+Page[101]=new Array("This function removes the next entry from the data queue.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","value = dataqueue.next()","value = dataqueue.next(timeout)","value","The next entry in the data queue","timeout","The number of seconds to wait for data in the queue","Details","If the data queue is empty, the function waits up to the timeout value.","If data is not available in the data queue before the timeout expires, the return value is nil.","The entries in the data queue are removed in first-in, first-out (FIFO) order.","If the value is a table, a duplicate of the original table and any subtables is made. The duplicate table does not contain any references to the original table or to any subtables.","Example","dataqueue.clear()","for i = 1, 10 do"," dataqueue.add(i)","end","print("There are " .. dataqueue.count"," .. " items in the data queue")","while dataqueue.count > 0 do"," x = dataqueue.next()"," print(x)","end","print("There are " .. dataqueue.count"," .. " items in the data queue")","Clears the data queue, adds ten entries, then reads the entries from the data queue.","Output:","There are 10 items in the data queue","1.00000e+00","2.00000e+00","3.00000e+00","4.00000e+00","5.00000e+00","6.00000e+00","7.00000e+00","8.00000e+00","9.00000e+00","1.00000e+01","There are 0 items in the data queue","Also see","dataqueue.add()","dataqueue.CAPACITY","dataqueue.clear()","dataqueue.count","dataqueue.next()","14658.html");
+Page[102]=new Array("This function delays the execution of the commands that follow it.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","delay(seconds)","seconds","The number of seconds to delay, maximum 100,000","Details","You cannot set a delay for zero seconds.","The system delays execution of the commands for at least the specified number of seconds and fractional seconds. However, the processing time may cause the system to delay 5 μs to 10 μs (typical) more than the requested delay.","Example 1","beeper.beep(0.5, 2400)","delay(0.250)","beeper.beep(0.5, 2400)","Emit a double‑beep at 2400 Hz. The sequence is 0.5 s on, 0.25 s off, 0.5 s on.","Example 2","dataqueue.clear()","dataqueue.add(35)","timer.reset()","delay(0.5)","dt = timer.measure.t()","print("Delay time was " .. dt)","print(dataqueue.next())","Clear the data queue, add 35 to it, then delay 0.5 seconds before reading it.","Output:","Delay time was 0.500099","3.50000e+01","Also see","None","delay()","13949.html");
+Page[103]=new Array("This function reads one digital I/O line.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","data = digio.readbit(N)","data","A custom variable that stores the state of the I/O line","N","Digital I/O line number to be read (1 to 14)","Details","A returned value of zero (0) indicates that the line is low. A returned value of one (1) indicates that the line is high.","Example","print(digio.readbit(4))","Assume line 4 is set high, and it is then read.","Output:","1.00000e+00","Also see","Digital I/O port","digio.readport()","digio.writebit()","digio.writeport()","digio.readbit()","14668.html");
+Page[104]=new Array("This function reads the digital I/O port.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","data = digio.readport()","data","The present value of the input lines on the digital I/O port","Details","The binary equivalent of the returned value indicates the value of the input lines on the I/O port. The least significant bit (bit B1) of the binary number corresponds to line 1; bit B14 corresponds to line 14.","For example, a returned value of 170 has a binary equivalent of 000000010101010, which indicates that lines 2, 4, 6, and 8 are high (1), and the other 10 lines are low (0).","Example","data = digio.readport()","print(data)","Assume lines 2, 4, 6, and 8 are set high when the I/O port is read.","Output:","1.70000e+02","This is binary 10101010","Also see","Digital I/O port","digio.readbit()","digio.writebit()","digio.writeport()","digio.readport()","14669.html");
+Page[105]=new Array("This function asserts a trigger on one of the digital I/O lines.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","digio.trigger[N].assert()","N","Digital I/O trigger line (1 to 14)","Details","The set pulsewidth determines how long the trigger is asserted.","Example","digio.trigger[2].assert()","Asserts a trigger on digital I/O line 2.","Also see","digio.trigger[N].pulsewidth","digio.trigger[N].assert()","14670.html");
+Page[106]=new Array("This function clears the trigger event on a digital I/O line.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","digio.trigger[N].clear()","N","Digital I/O trigger line (1 to 14)","Details","The event detector of a trigger recalls if a trigger event has been detected since the last digio.trigger[N].wait() command. This function clears the event detector of the specified trigger line, discards the previous history of the trigger line, and clears the digio.trigger[N].overrun attribute.","Example","digio.trigger[2].clear()","Clears the trigger event detector on I/O line 2.","Also see","digio.trigger[N].overrun","digio.trigger[N].wait()","digio.trigger[N].clear()","14671.html");
+Page[107]=new Array("This constant identifies the trigger event generated by the digital I/O line N.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Constant","Yes","Usage","eventID = digio.trigger[N].EVENT_ID","eventID","The trigger event number","N","Digital I/O trigger line (1 to 14)","Details","To have another trigger object respond to trigger events generated by the trigger line, set the other object's stimulus attribute to the value of this constant.","Example 1","digio.trigger[5].stimulus = digio.trigger[3].EVENT_ID","Uses a trigger event on digital I/O trigger line 3 to be the stimulus for digital I/O trigger line 5.","Example 2","smua.trigger.arm.stimulus ="," digio.trigger[3].EVENT_ID","Uses a trigger event on digital I/O trigger line 3 to be the trigger stimulus for the SMU.","Also see","None","digio.trigger[N].EVENT_ID","14672.html");
+Page[108]=new Array("This attribute sets the mode in which the trigger event detector and the output trigger generator operate on the given trigger line.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Digital I/O trigger N reset Recall setup","Not saved ","0 (digio.TRIG_BYPASS)","Usage","triggerMode = digio.trigger[N].mode","digio.trigger[N].mode = triggerMode","triggerMode","The trigger mode; see Details for values","N","Digital I/O trigger line (1 to 14)","Details","Set triggerMode to one of the following values:","Trigger mode values","triggerMode","Description","digio.TRIG_BYPASS or 0","Allows direct control of the line.","digio.TRIG_FALLING or 1","Detects falling‑edge triggers as input; asserts a TTL-low pulse for output.","digio.TRIG_RISING or 2","If the programmed state of the line is high, the digio.TRIG_RISING mode behavior is similar to digio.TRIG_RISINGA. If the programmed state of the line is low, the digio.TRIG_RISING mode behavior is similar to digio.TRIG_RISINGM. This setting should only be used if necessary for compatibility with other Keithley Instruments products.","digio.TRIG_EITHER or 3","Detects rising- or falling‑edge triggers as input. Asserts a TTL‑low pulse for output.","digio.TRIG_SYNCHRONOUSA or 4","Detects the falling‑edge input triggers and automatically latches and drives the trigger line low. Asserting the output trigger releases the latched line.","digio.TRIG_SYNCHRONOUS or 5","Detects the falling‑edge input triggers and automatically latches and drives the trigger line low. Asserts a TTL‑low pulse as an output trigger.","digio.TRIG_SYNCHRONOUSM or 6","Detects rising‑edge triggers as input. Asserts a TTL‑low pulse for output.","digio.TRIG_RISINGA or 7","Detects rising‑edge triggers as input. Asserts a TTL‑low pulse for output.","digio.TRIG_RISINGM or 8","Asserts a TTL-high pulse for output. Input edge detection is not possible in this mode.","When programmed to any mode except digio.TRIG_BYPASS, the output state of the I/O line is controlled by the trigger logic, and the user‑specified output state of the line is ignored.","Use of either digio.TRIG_SYNCHRONOUSA or digio.TRIG_SYNCHRONOUSM is preferred over digio.TRIG_SYNCHRONOUS, because digio.TRIG_SYNCHRONOUS is provided for compatibility with the digital I/O and TSP-Link triggering on other Keithley Instruments products.","To control the line state, set the mode to digio.TRIG_BYPASS and use the digio.writebit() and digio.writeport() commands.","Example","digio.trigger[4].mode = 2","Sets the trigger mode for I/O line 4 to digio.TRIG_RISING.","Also see","digio.trigger[N].clear()","digio.trigger[N].reset()","digio.writebit()","digio.writeport()","Sweep operation","digio.trigger[N].mode","14674.html");
+Page[109]=new Array("Use this attribute to read the event detector overrun status.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Instrument reset Digital I/O trigger N clear Digital I/O trigger N reset Recall setup","Not saved","Not applicable","Usage","overrun = digio.trigger[N].overrun","overrun","Trigger overrun state (true or false)","N","Digital I/O trigger line (1 to 14)","Details","If this is true, an event was ignored because the event detector was already in the detected state when the event occurred.","This is an indication of the state of the event detector built into the line itself. It does not indicate if an overrun occurred in any other part of the trigger model or in any other detector that is monitoring the event.","Example","overrun = digio.trigger[1].overrun","print(overrun)","If there is no trigger overrun, the following text is output:","false","Also see","digio.trigger[N].clear()","digio.trigger[N].reset()","digio.trigger[N].overrun","14675.html");
+Page[110]=new Array("This attribute describes the length of time that the trigger line is asserted for output triggers.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Digital I/O trigger N reset Recall setup","Not saved ","10e-6 (10 µs)","Usage","width = digio.trigger[N].pulsewidth","digio.trigger[N].pulsewidth = width","width","The pulse width (seconds)","N","Digital I/O trigger line (1 to 14)","Details","Setting width to zero (0) seconds asserts the trigger indefinitely. To release the trigger line, use digio.trigger[N].release().","Example","digio.trigger[4].pulsewidth = 20e-6","Sets the pulse width for trigger line 4 to 20 μs.","Also see","digio.trigger[N].assert()","digio.trigger[N].reset()","digio.trigger[N].release()","digio.trigger[N].pulsewidth","17691.html");
+Page[111]=new Array("This function releases an indefinite length or latched trigger.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","digio.trigger[N].release()","N","Digital I/O trigger line (1 to 14)","Details","Releases a trigger that was asserted with an indefinite pulse width time, as well as a trigger that was latched in response to receiving a synchronous mode trigger. Only the specified trigger line (N) is affected.","Example","digio.trigger[4].release()","Releases digital I/O trigger line 4.","Also see","digio.trigger[N].pulsewidth","digio.trigger[N].release()","14677.html");
+Page[112]=new Array("This function resets trigger values to their factory defaults.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","digio.trigger[N].reset()","N","Digital I/O trigger line (1 to 14)","Details","This function resets the following attributes to factory default settings:","digio.trigger[N].mode","digio.trigger[N].pulsewidth","digio.trigger[N].stimulus","It also clears digio.trigger[N].overrun.","Example","digio.trigger[3].mode = 2","digio.trigger[3].pulsewidth = 50e-6","digio.trigger[3].stimulus = digio.trigger[5].EVENT_ID","print(digio.trigger[3].mode, digio.trigger[3].pulsewidth, digio.trigger[3].stimulus)","digio.trigger[3].reset()","print(digio.trigger[3].mode, digio.trigger[3].pulsewidth, digio.trigger[3].stimulus)","Set the digital I/O trigger line 3 for a falling edge with a pulsewidth of 50 microseconds.","Use digital I/O line 5 to trigger the event on line 3.","Reset the line back to factory default values.","Output before reset:","2.00000e+00 5.00000e-05 5.00000e+00","Output after reset:","0.00000e+00 1.00000e-05 0.00000e+00","Also see","digio.trigger[N].mode","digio.trigger[N].overrun","digio.trigger[N].pulsewidth","digio.trigger[N].stimulus","digio.trigger[N].reset()","17719.html");
+Page[113]=new Array("This attribute selects the event that causes a trigger to be asserted on the digital output line.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Digital I/O trigger N reset Recall setup","Not saved","0","Usage","triggerStimulus = digio.trigger[N].stimulus","digio.trigger[N].stimulus = triggerStimulus","triggerStimulus","The event identifier for the triggering event","N","Digital I/O trigger line (1 to 14)","Details","Set this attribute to zero (0) to disable the automatic trigger output.","Do not use the stimulus attribute for generating output triggers under script control. Use digio.trigger[N].assert() instead.","The trigger stimulus for a digital I/O line may be set to one of the existing trigger event IDs, described in the following table.","Trigger event IDs*","Event ID","Event description","smua.trigger.SWEEPING_EVENT_ID","Occurs when the source‑measure unit (SMU) transitions from the idle state to the arm layer of the trigger model","smua.trigger.ARMED_EVENT_ID","Occurs when the SMU moves from the arm layer to the trigger layer of the trigger model","smua.trigger.SOURCE_COMPLETE_EVENT_ID","Occurs when the SMU completes a source action","smua.trigger.MEASURE_COMPLETE_EVENT_ID","Occurs when the SMU completes a measure action","smua.trigger.PULSE_COMPLETE_EVENT_ID","Occurs when the SMU completes a pulse","smua.trigger.SWEEP_COMPLETE_EVENT_ID","Occurs when the SMU completes a sweep","smua.trigger.IDLE_EVENT_ID","Occurs when the SMU returns to the idle state","digio.trigger[N].EVENT_ID","Occurs when an edge is detected on a digital I/O line","tsplink.trigger[N].EVENT_ID","Occurs when an edge is detected on a TSP‑Link line","lan.trigger[N].EVENT_ID","Occurs when the appropriate LXI trigger packet is received on LAN trigger object N","display.trigger.EVENT_ID","Occurs when the TRIG key on the front panel is pressed","trigger.EVENT_ID","Occurs when a *TRG command is received on the remote interface","(GPIB only) Occurs when a GET bus command is received","(VXI-11 only) Occurs with the VXI-11 command device_trigger; reference the VXI-11 standard for additional details on the device trigger operation","trigger.blender[N].EVENT_ID","Occurs after a collection of events is detected","trigger.timer[N].EVENT_ID","Occurs when a delay expires","* Use the name of the trigger event ID to set the stimulus value rather than the numeric value. Using the name makes the code compatible for future upgrades (for example, if the numeric values must change when enhancements are added to the instrument).","Example 1","digio.trigger[3].stimulus = 0","Clear the trigger stimulus of digital I/O line 3.","Example 2","digio.trigger[3].stimulus ="," smua.trigger.SOURCE_COMPLETE_EVENT_ID","Set the trigger stimulus of digital I/O line 3 to be the source complete event.","Also see","digio.trigger[N].assert()","digio.trigger[N].clear()","digio.trigger[N].reset()","digio.trigger[N].stimulus","19521.html");
+Page[114]=new Array("This function waits for a trigger.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","triggered = digio.trigger[N].wait(timeout)","triggered","The value true if a trigger is detected, or false if no triggers are detected during the timeout period","N","Digital I/O trigger line (1 to 14)","timeout","Timeout in seconds","Details","This function pauses for up to timeout seconds for an input trigger. If one or more trigger events are detected since the last time digio.trigger[N].wait() or digio.trigger[N].clear() was called, this function returns a value immediately. After waiting for a trigger with this function, the event detector is automatically reset and ready to detect the next trigger. This is true regardless of the number of events detected.","Example","triggered = digio.trigger[4].wait(3)","print(triggered)","Waits up to three seconds for a trigger to be detected on trigger line 4, then outputs the results.","Output if no trigger is detected:","false","Output if a trigger is detected:","true","Also see","digio.trigger[N].clear()","digio.trigger[N].wait()","14679.html");
+Page[115]=new Array("This function sets a digital I/O line high or low.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","digio.writebit(N, data)","N","Digital I/O trigger line (1 to 14)","data","The value to write to the bit:","0 (low)","Non‑zero (high)","Details","If the output line is write‑protected using the digio.writeprotect attribute, the command is ignored.","The reset() function does not affect the present state of the digital I/O lines.","Use the digio.writebit() and digio.writeport() commands to control the output state of the synchronization line when trigger operation is set to digio.TRIG_BYPASS.","The data must be zero (0) to clear the bit. Any value other than zero (0) sets the bit.","Example","digio.writebit(4, 0)","Sets digital I/O line 4 low (0).","Also see","digio.readbit()","digio.readport()","digio.trigger[N].mode","digio.writeport()","digio.writeprotect","digio.writebit()","14680.html");
+Page[116]=new Array("This function writes to all digital I/O lines.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","digio.writeport(data)","data","Value to write to the port (0 to 16383)","Details","The binary representation of data indicates the output pattern to be written to the I/O port. For example, a data value of 170 has a binary equivalent of 00000010101010. Lines 2, 4, 6, and 8 are set high (1), and the other 10 lines are set low (0).","Write‑protected lines are not changed.","The reset() function does not affect the present states of the digital I/O lines.","Use the digio.writebit() and digio.writeport() commands to control the output state of the synchronization line when trigger operation is set to digio.TRIG_BYPASS.","Example","digio.writeport(255)","Sets digital I/O Lines 1 through 8 high (binary 00000011111111).","Also see","digio.readbit()","digio.readport()","digio.writebit()","digio.writeprotect","digio.writeport()","14681.html");
+Page[117]=new Array("This attribute contains the write‑protect mask that protects bits from changes from the digio.writebit() and digio.writeport() functions.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Recall setup ","Saved setup ","0","Usage","mask = digio.writeprotect","digio.writeprotect = mask","mask","Sets the value that specifies the bit pattern for write‑protect","Details","Bits that are set to one cause the corresponding line to be write‑protected.","The binary equivalent of mask indicates the mask to be set for the I/O port. For example, a mask value of 7 has a binary equivalent of 00000000000111. This mask write‑protects Lines 1, 2, and 3.","Example","digio.writeprotect = 15","Write‑protects lines 1, 2, 3, and 4.","Also see","digio.writebit()","digio.writeport()","digio.writeprotect","14682.html");
+Page[118]=new Array("This function clears all lines of the display.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","display.clear()","Details","This function switches to the user screen and then clears the display.","The display.clear(), display.setcursor(), and display.settext() functions are overlapped, nonblocking commands. That is, the script does not wait for one of these commands to complete. These nonblocking functions do not immediately update the display. For performance considerations, they update the physical display as soon as processing time becomes available.","Also see","display.setcursor()","display.settext()","display.clear()","14699.html");
+Page[119]=new Array("This function reads the annunciators (indicators) that are presently turned on.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","annunciators = display.getannunciators()","annunciators","The bitmasked value that shows which indicators are turned on","Details","This function returns a bitmasked value showing which indicators are turned on. The 16‑bit binary equivalent of the returned value is the bitmask. The return value is a sum of set annunciators, based on the weighted value, as shown in the following table.","Annunciator (indicator) bitmasked values and equivalent constants","Indicator","Bit","Weighted value","Equivalent constant","FILT","1","1","display.ANNUNCIATOR_FILTER","MATH","2","2","display.ANNUNCIATOR_MATH","4W","3","4","display.ANNUNCIATOR_4_WIRE","AUTO","4","8","display.ANNUNCIATOR_AUTO","ARM","5","16","display.ANNUNCIATOR_ARM","TRIG","6","32","display.ANNUNCIATOR_TRIGGER","* (star)","7","64","display.ANNUNCIATOR_STAR","SMPL","8","128","display.ANNUNCIATOR_SAMPLE","EDIT","9","256","display.ANNUNCIATOR_EDIT","ERR","10","512","display.ANNUNCIATOR_ERROR","REM","11","1024","display.ANNUNCIATOR_REMOTE","TALK","12","2048","display.ANNUNCIATOR_TALK ","LSTN","13","4096","display.ANNUNCIATOR_LISTEN","SRQ","14","8192","display.ANNUNCIATOR_SRQ","REAR","15","16384","display.ANNUNCIATOR_REAR","REL","16","32768","display.ANNUNCIATOR_REL","Example 1","testAnnunciators = display.getannunciators()","print(testAnnunciators)","rem = bit.bitand(testAnnunciators, 1024)","if rem > 0 then"," print("REM is on")","else"," print("REM is off")","end","REM indicator is turned on.","Output:","1.28000e+03","REM is on","Example 2","print(display.ANNUNCIATOR_EDIT)","print(display.ANNUNCIATOR_TRIGGER)","print(display.ANNUNCIATOR_AUTO)","Output:","2.56000e+02","3.20000e+01","8.00000e+00","Also see","bit.bitand()","display.getannunciators()","14719.html");
+Page[120]=new Array("This function reads the present position of the cursor on the front panel display.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","row, column, style = display.getcursor()","row","The row where the cursor is: 1 (top row); 2 (bottom row)","column","The column where the cursor is:","If the cursor is in the top row: 1 to 20","If the cursor is in the bottom row: 1 to 32","style","Visibility of the cursor: 0 (invisible cursor); 1 (blinking cursor)","Details","This function switches the display to the user screen (the text set by display.settext()), and then returns values to indicate the cursor's row and column position and cursor style.","Columns are numbered from left to right on the display.","Example 1","testRow, testColumn = display.getcursor()","print(testRow, testColumn)","This example reads the cursor position into local variables and prints them. Example output:","1.00000e+00 1.00000e+00","Example 2","print(display.getcursor())","This example prints the cursor position directly. In this example, the cursor is in row 1 at column 3, with an invisible cursor:","1.00000e+00 3.00000e+00 0.00000e+00","Also see","display.gettext()","display.screen","display.setcursor()","display.settext()","display.getcursor()","14700.html");
+Page[121]=new Array("This function retrieves the key code for the last pressed key.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","keyCode = display.getlastkey()","keyCode","A returned value that represents the last front-panel key pressed; see Details for more information","Details","A history of the key code for the last pressed front‑panel key is maintained by the instrument. When the instrument is turned on, or when it is transitioning from local to remote operation, the key code is set to 0 (display.KEY_NONE).","Pressing the EXIT (LOCAL) key normally aborts a script. To use this function with the EXIT (LOCAL) key, display.locallockout must be used.","The table below lists the keyCode value for each front‑panel action.","Key codes","Value","Key list","Value","Key list","0","display.KEY_NONE","82","display.KEY_ENTER","65","display.KEY_RANGEUP","85","display.KEY_RECALL","68","display.KEY_MENU","86","display.KEY_MEASA","69","display.KEY_MODEA","87","display.KEY_DIGITSA","70","display.KEY_RELA","92","display.KEY_TRIG","71","display.KEY_RUN","93","display.KEY_LIMITA","72","display.KEY_DISPLAY","94","display.KEY_SPEEDA","73","display.KEY_AUTO","95","display.KEY_LOAD","75","display.KEY_EXIT","97","display.WHEEL_ENTER","77","display.KEY_FILTERA","103","display.KEY_RIGHT","78","display.KEY_STORE","104","display.KEY_LEFT","79","display.KEY_SRCA","107","display.WHEEL_LEFT","80","display.KEY_CONFIG","114","display.WHEEL_RIGHT","81","display.KEY_RANGEDOWN","@ When using this function, use built-in constants such as display.KEY_RIGHT (rather than the numeric value of 103). This will allow for better forward compatibility with firmware revisions.","The OUTPUT ON/OFF control cannot be tracked by this function.","Example","key = display.getlastkey()","print(key)","On the front panel, press the MENU key and then send the code to the left. This retrieves the key code for the last pressed key.","Output:","6.80000e+01","Also see","display.locallockout","display.sendkey()","display.getlastkey()","17047.html");
+Page[122]=new Array("This function reads the text displayed on the instrument front panel.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","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)","text","The returned value, which contains the text that is presently displayed","embellished","Indicates type of returned text: false (simple text); true (text with embedded character codes)","row","Selects the row from which to read the text: 1 (row 1); 2 (row 2). If row is not included, both rows of text are read","columnStart","Selects the first column from which to read text; for row 1, the valid column numbers are 1 to 20; for row 2, the valid column numbers are 1 to 32; if nothing is selected, 1 is used","columnEnd","Selects the last column from which to read text; for row 1, the valid column numbers are 1 to 20; for row 2, the valid column numbers are 1 to 32; the default is 20 for row 1, and 32 for row 2","Details","Using the command without any parameters returns both lines of the display.","The $N character code is included in the returned value to show where the top line ends and the bottom line begins. This is not affected by the value of embellished.","When embellished is set to true, all other character codes are returned along with the message. When embellished is set to false, only the message and the $N character code is returned. For information on the embedded character codes, see display.settext().","The display is not switched to the user screen (the screen set using display.settext()). Text will be read from the active screen.","Example 1","display.clear()","display.setcursor(1, 1)","display.settext("ABCDEFGHIJ$DKLMNOPQRST")","display.setcursor(2, 1)","display.settext("abcdefghijklm$Bnopqrstuvwxyz$F123456")","print(display.gettext())","print(display.gettext(true))","print(display.gettext(false, 2))","print(display.gettext(true, 2, 9))","print(display.gettext(false, 2, 9, 10))","This example shows how to retrieve the display text in multiple ways. The output is:","ABCDEFGHIJKLMNOPQRST$Nabcdefghijklmnopqrstuvwxyz123456","$RABCDEFGHIJ$DKLMNOPQRST$N$Rabcdefghijklm$Bnopqrstuvwxyz$F123456","abcdefghijklmnopqrstuvwxyz123456","$Rijklm$Bnopqrstuvwxyz$F123456","ij","Example 2","display.clear()","display.settext("User Screen")","text = display.gettext()","print(text)","This outputs all text in both lines of the display:","User Screen $N","This indicates that the message “User Screen” is on the top line. The bottom line is blank.","Also see","display.clear()","display.getcursor()","display.setcursor()","display.settext()","display.gettext()","14702.html");
+Page[123]=new Array("This function displays a formatted input field on the instrument display that the operator can edit.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","display.inputvalue(format)","display.inputvalue(format, default)","display.inputvalue(format, default, minimum)","display.inputvalue(format, default, minimum, maximum)","format","A string that defines how the input field is formatted; see Details for more information","default","The default value for the input value","minimum","The minimum input value","maximum","The maximum input value","Details","The format parameter uses zeros (0), the decimal point, polarity sign, and exponents to define how the input field is formatted. The format parameter can include the options shown in the following table.","Option","Description","Examples","E","Include the E to display the value exponentially","0.00000e+0","+","Allows operators to enter positive or negative values; if the "+" sign is not included, the operator cannot enter a negative value","+0.00","0","Defines the digit positions for the value; you can use up to six zeros (0)","+00.0000e+00",".","Include to have a decimal point appear in the value","+0.00","The default parameter is the value shown when the value is first displayed.","The minimum and maximum parameters can be used to limit the values that can be entered. When + is not selected for format, the minimum limit must be more than or equal to zero (0). When limits are used, you cannot enter values above or below these limits.","The input value is limited to ±1e37.","Before calling display.inputvalue(), you should send a message prompt to the operator using display.prompt(). Make sure to position the cursor where the edit field should appear.","After this command is sent, script execution pauses until you enter a value and press the ENTER key.","For positive and negative entry (plus sign (+) used for the value field and/or the exponent field), polarity of a nonzero value or exponent can be toggled by positioning the cursor on the polarity sign and turning the navigation wheel @. Polarity will also toggle when using the navigation wheel @ to decrease or increase the value or exponent past zero. A zero (0) value or exponent (for example, +00) is always positive and cannot be toggled to negative polarity.","After executing this command and pressing the EXIT (LOCAL) key, the function returns nil.","Example","display.clear()","display.settext("Enter value between$N -0.10 and 2.00: ")","value = display.inputvalue("+0.00", 0.5, -0.1, 2.0)","print("Value entered = ", value)","Displays an editable field (+0.50) for operator input. The valid input range is -0.10 to +2.00, with a default of 0.50.","Output:","Value entered = 1.35000e+00","Also see","display.prompt()","display.setcursor()","display.settext()","display.inputvalue()","14703.html");
+Page[124]=new Array("This function adds an entry to the User menu, which can be accessed by pressing the LOAD key on the instrument front panel.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","display.loadmenu.add(displayName, code)","display.loadmenu.add(displayName, code, memory)","displayName","The name that is added to the User menu","code","The code that is run from the User menu","memory","Determines if code is saved to nonvolatile memory:","0 or display.DONT_SAVE: Does not save the code to nonvolatile memory","1 or display.SAVE: Saves the code to nonvolatile memory (default)","Details","After adding code to the load menu, you can run it from the front panel by pressing the LOAD key, then selecting USER to select from the available code to load. Pressing the RUN key will then run the script.","You can add items in any order. They are always displayed in alphabetical order when the menu is selected.","Any Lua code can be can be included in the code parameter. If memory is set to display.SAVE, the entry (name and code) is saved in nonvolatile memory. Scripts, functions, and variables used in the code are not saved by display.SAVE. Functions and variables need to be saved with the code. If the code is not saved in nonvolatile memory, it will be lost when the Model 2651A is turned off. See Example 2 below.","If you do not make a selection for memory, the code is automatically saved to nonvolatile memory.","@ You can create a script that defines several functions, and then use the display.loadmenu.add() command to add items that call those individual functions. This allows the operator to run tests from the front panel.","Example 1","display.loadmenu.add("Test9", "Test9()")","Assume a user script named "Test9" has been loaded into the run-time environment. Adds the menu entry to the User menu to run the script after loading.","Example 2","display.loadmenu.add("," "Test", "DUT1() beeper.beep(2, 500)", display.SAVE)","Assume a script with a function named “DUT1” has already been loaded into the instrument, and the script has NOT been saved in nonvolatile memory.","Now assume you want to add a test named “Test” to the USER TESTS menu. You want the test to run the function named “DUT1” and sound the beeper. This example adds “Test” to the menu, defines the code, and then saves the displayName and code in nonvolatile memory.","When “Test” is run from the front panel USER TESTS menu, the function named “DUT1” executes and the beeper beeps for two seconds.","Now assume you turn off instrument power. Because the script was not saved in nonvolatile memory, the function named “DUT1” is lost when you turn the instrument on. When “Test” is again run from the front panel, an error is generated because DUT1 no longer exists in the instrument as a function.","Example 3","display.loadmenu.add("Part1", "testpart([[Part1]], 5.0)", display.SAVE)","Adds an entry called “Part1” to the front panel “USER TESTS” load menu for the code testpart([[Part1]], 5.0), and saves it in nonvolatile memory.","Also see","display.loadmenu.delete()","display.loadmenu.add()","19382.html");
+Page[125]=new Array("This function creates an iterator for the user menu items accessed using the LOAD key on the instrument front panel.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","for displayName in display.loadmenu.catalog() do body end","for displayName, code in display.loadmenu.catalog() do body end","displayName","The name displayed in the menu","code","The code associated with the displayName","body","The body of the code to process the entries in the loop","Details","Each time through the loop, displayName and code will take on the values in the User menu.","The instrument goes through the list in random order.","Example","for displayName, code in display.loadmenu.catalog() do"," print(displayName, code)","end","Output:","Test DUT1() beeper.beep(2, 500)","Part1 testpart([[Part1]], 5.0)","Test9 Test9()","Also see","display.loadmenu.add()","display.loadmenu.delete()","display.loadmenu.catalog()","14705.html");
+Page[126]=new Array("This function removes an entry from the User menu, which can be accessed using the LOAD key on the instrument front panel.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","display.loadmenu.delete(displayName)","displayName","The name to be deleted from the User menu","Details","If you delete an entry from the User menu, you can no longer run it by pressing the LOAD key.","Example","display.loadmenu.delete("Test9")","for displayName, code in display.loadmenu.catalog() do"," print(displayName, code)","end","Deletes the entry named "Test9"","Output:","Test DUT1() beeper.beep(2, 500)","Part1 testpart([[Part1]], 5.0) ","Also see","display.loadmenu.add()","display.loadmenu.catalog()","display.loadmenu.delete()","14706.html");
+Page[127]=new Array("This attribute describes whether or not the EXIT (LOCAL) key on the instrument front panel is enabled.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Power cycle","Not saved","0 (display.UNLOCK)","Usage","lockout = display.locallockout","display.locallockout = lockout"," ","lockout","0 or display.UNLOCK: Unlocks EXIT (LOCAL) key","1 or display.LOCK: Locks out EXIT (LOCAL) key","Details","Set display.locallockout to display.LOCK to prevent the user from interrupting remote operation by pressing the EXIT (LOCAL) key.","Set this attribute to display.UNLOCK to allow the EXIT (LOCAL) key to interrupt script/remote operation.","Example","display.locallockout = display.LOCK","Disables the front‑panel EXIT (LOCAL) key.","Also see","None","display.locallockout","14707.html");
+Page[128]=new Array("This function presents a menu on the front panel display.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","selection = display.menu(name, items)","selection","Name of the variable that holds the menu item selected","name","Menu name to display on the top line","items","Menu items to display on the bottom line","Details","The menu consists of the menu name string on the top line, and a selectable list of items on the bottom line. The menu items must be a single string with each item separated by whitespace. The name for the top line is limited to 20 characters.","After sending this command, script execution pauses for the operator to select a menu item. An item is selected by rotating the navigation wheel @ to place the blinking cursor on the item, and then pressing the navigation wheel @ (or the ENTER key). When an item is selected, the text of that selection is returned.","Pressing the EXIT (LOCAL) key will not abort the script while the menu is displayed, but it will return nil. The script can be aborted by calling the exit function when nil is returned.","Example","selection = display.menu("Menu", "Test1 Test2 Test3")","print(selection)","Displays a menu with three menu items. If the second menu item is selected, selection is given the value Test2.","Output:","Test2","Also see","None","display.menu()","14708.html");
+Page[129]=new Array("This attribute controls whether the front panel keys act as a numeric keypad during value entry.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Recall setup","Saved setup","1 (display.ENABLE)","Usage","numericKeypad = display.numpad","display.numpad = numericKeypad","numericKeypad","Enable the numeric keypad feature (1 or display.ENABLE)","Disable the numeric keypad feature (0 or display.DISABLE)","Details","The numeric keypad feature is only available when editing a numeric value at the same time that the EDIT indicator is lit.","Example","display.numpad = display.ENABLE","Turn on the numeric keypad feature.","Also see","Setting a value","display.numpad","14709.html");
+Page[130]=new Array("This function prompts the user to enter a parameter from the front panel of the instrument.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","display.prompt(format, units, help)","display.prompt(format, units, help, default)","display.prompt(format, units, help, default, minimum)","display.prompt(format, units, help, default, minimum, maximum)","format","A string that defines how the input field is formatted; see Details for more information","units","Set the units text string for the top line (eight characters maximum); this indicates the units (for example, "V" or "A") for the value","help","Text string to display on the bottom line (32 characters maximum)","default","The value that is shown when the value is first displayed","minimum","The minimum input value that can be entered","maximum","The maximum input value that can be entered (must be more than minimum)","Details","This function creates 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 parameter uses zeros (0), the decimal point, polarity sign, and exponents to define how the input field is formatted.","The format parameter can include the options shown in the following table.","Option","Description","Examples","E","Include the E to display the value exponentially. Include a plus sign (+) for positive/negative exponent entry. Do not include the plus sign (+) to prevent negative value entry. 0 defines the digit positions for the exponent.","0.00000E+0","+","Allows operators to enter positive or negative values. If the plus sign (+) is not included, the operator cannot enter a negative value.","+0.00","0","Defines the digit positions for the value. You can use up to six zeros (0).","+00.0000E+00",".","The decimal point where needed for the value.","+0.00","The minimum and maximum parameters can be used to limit the values that can be entered. When a plus sign (+) is not selected for format, the minimum limit must be greater than or equal to zero (0). When limits are used, the operator cannot enter values above or below these limits.","The input value is limited to ±1e37.","After sending this command, script execution pauses for the operator to enter a value and press ENTER.","For positive and negative entry (plus sign (+) used for the value field and the exponent field), polarity of a nonzero value or exponent can be toggled by positioning the cursor on the polarity sign and turning the navigation wheel @. Polarity will also toggle when using the navigation wheel @ to decrease or increase the value or exponent past zero. A zero value or exponent (for example, +00) is always positive and cannot be toggled to negative polarity.","After executing this command and pressing the EXIT (LOCAL) key, the value returns nil.","Example","value = display.prompt("0.00", "V", "Input 0 to +2V", 0.5, 0, 2)","print(value)","The above command prompts the operator to enter a voltage value. The valid input range is 0 to +2.00, with a default of 0.50:","0.50V","Input 0 to +2V","If the operator enters 0.70, the output is:","7.00000e-01","Also see","display.inputvalue()","display.prompt()","14740.html");
+Page[131]=new Array("This attribute contains the selected display screen.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Recall setup","Saved setup","0 (display.SMUA)","Usage","displayID = display.screen","display.screen = displayID","displayID","One of the following values:","0 or display.SMUA: Displays source-measure and compliance","3 or display.USER: Displays the user screen","Details","Setting this attribute selects the display screen for the front panel. This performs the same action as pressing the DISPLAY key on the front panel. The text for the display screen is set by display.settext().","Read this attribute to determine which of the available display screens was last selected.","Example","display.screen = display.SMUA","Selects the source-measure and compliance limit display for the SMU.","Also see","display.settext()","display.screen","14741.html");
+Page[132]=new Array("This function sends a code that simulates the action of a front panel control.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","display.sendkey(keyCode)","keyCode","A parameter that specifies the key to virtually press; see Details for more information","Details","This command simulates the pressing of a front panel key or navigation wheel, or the turning the navigation wheel one click to the left or right.","Key codes","Value","Key list","Value","Key list","0","display.KEY_NONE","82","display.KEY_ENTER","65","display.KEY_RANGEUP","85","display.KEY_RECALL","68","display.KEY_MENU","86","display.KEY_MEASA","69","display.KEY_MODEA","87","display.KEY_DIGITSA","70","display.KEY_RELA","88","display.KEY_OUTPUTA","71","display.KEY_RUN","92","display.KEY_TRIG","72","display.KEY_DISPLAY","93","display.KEY_LIMITA","73","display.KEY_AUTO","94","display.KEY_SPEEDA","75","display.KEY_EXIT","95","display.KEY_LOAD","77","display.KEY_FILTERA","97","display.WHEEL_ENTER","78","display.KEY_STORE","103","display.KEY_RIGHT","79","display.KEY_SRCA","104","display.KEY_LEFT","80","display.KEY_CONFIG","107","display.WHEEL_LEFT","81","display.KEY_RANGEDOWN","114","display.WHEEL_RIGHT","@ When using this function, use built-in constants such as display.KEY_RIGHT (rather than the numeric value of 103). This will allow for better forward compatibility with firmware revisions.","Example","display.sendkey(display.KEY_RUN)","Simulates pressing the RUN key.","Also see","Front panel","display.sendkey()","17055.html");
+Page[133]=new Array("This function sets the position of the cursor.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","display.setcursor(row, column)","display.setcursor(row, column, style)","row","The row number for the cursor (1 or 2)","column","The active column position to set; row 1 has columns 1 to 20, row 2 has columns 1 to 32","style","Set the cursor to invisible (0, default) or blinking (1)","Details","Sending this command selects the user screen and then moves the cursor to the given location.","The display.clear(), display.setcursor(), and display.settext() functions are overlapped, nonblocking commands. That is, the script does not wait for one of these commands to complete. These nonblocking functions do not immediately update the display. For performance considerations, they update the physical display as soon as processing time becomes available.","An out‑of-range parameter for row sets the cursor to row 2. An out‑of‑range parameter for column sets the cursor to column 20 for row 1, or 32 for row 2.","An out‑of‑range parameter for style sets it to 0 (invisible).","A blinking cursor is only visible when it is positioned over displayed text. It cannot be seen when positioned over a space character.","Example","display.clear()","display.setcursor(1, 8)","display.settext("Hello")","display.setcursor(2, 14)","display.settext("World")","This example displays a message on the instrument front panel, approximately center. Note that the top line of text is larger than the bottom line of text.","The front panel of the instrument displays "Hello" on the top line and "World" on the second line.","Also see","display.clear()","display.getcursor()","display.gettext()","display.screen","display.settext()","display.setcursor()","14711.html");
+Page[134]=new Array("This function displays text on the user screen.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","display.settext(text)","text","Text message to be displayed, with optional character codes","Details","This function selects the user display screen and displays the given text.","After the instrument is turned on, the first time you use a display command to write to the display, the message "User Screen" is cleared. After the first write, you need to use display.clear() to clear the message.","The display.clear(), display.setcursor(), and display.settext() functions are overlapped, nonblocking commands. That is, the script does not wait for one of these commands to complete. These nonblocking functions do not immediately update the display. For performance considerations, they update the physical display as soon as processing time becomes available.","The text starts at the present cursor position. After the text is displayed, the cursor is after the last character in the display message.","Top line text does not wrap to the bottom line of the display automatically. Any text that does not fit on the current line is truncated. If the text is truncated, the cursor remains 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:","Display character codes","Character Code","Description","$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 intensity, nonblinking","$B","Sets text to blink","$D","Sets text to dim intensity","$F","Sets the text to background blink","$$","Escape sequence to display a single dollar symbol ($)","Example","display.clear()","display.settext("Normal $BBlinking$N")","display.settext("$DDim $FBackgroundBlink$R $$$$ 2 dollars")","This example sets the display to:","Normal Blinking","Dim BackgroundBlink $$ 2 dollars","with the named effect on each word.","Also see","display.clear()","display.getcursor()","display.gettext()","display.screen","display.setcursor()","display.settext()","14712.html");
+Page[135]=new Array("This attribute sets the display resolution of the selected measurement.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Recall setup","Saved setup","5 (display.DIGITS_5_5)","Usage","digits = display.smuX.digits","display.smuX.digits = digits","digits","Set digits to one of the following values:","Select 4-1/2 digit resolution (4 or display.DIGITS_4_5)","Select 5-1/2 digit resolution (5 or display.DIGITS_5_5)","Select 6-1/2 digit resolution (6 or display.DIGITS_6_5)","X","Source‑measure unit (SMU) channel (for example, display.smua.digits applies to SMU channel A)","Details","This attribute sets the display resolution.","Example","display.smua.digits = display.DIGITS_5_5","Select 5-1/2 digit resolution for SMU A.","Also see","Display resolution","display.smuX.digits","14713.html");
+Page[136]=new Array("This attribute specifies the type of measurement being displayed.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Recall setup","Saved setup","1 (display.MEASURE_DCVOLTS)","Usage","func = display.smuX.measure.func","display.smuX.measure.func = func","func","One of the following values:","0 or display.MEASURE_DCAMPS: Selects current measure function","1 or display.MEASURE_DCVOLTS: Selects volts measure function","2 or display.MEASURE_OHMS: Selects ohms measure function","3 or display.MEASURE_WATTS: Selects power measure function","X","Source‑measure unit (SMU) channel (for example, display.smua.measure.func applies to SMU channel A)","Details","Selects the displayed measurement function: Amperes, volts, ohms, or watts.","Example","display.smua.measure.func = display.MEASURE_DCAMPS","Selects the current measure function for SMU A.","Also see","display.smuX.limit.func","display.smuX.measure.func","14714.html");
+Page[137]=new Array("This function clears the front‑panel trigger event detector.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","display.trigger.clear()","Details","The trigger event detector remembers if an event has been detected since the last display.trigger.wait() call. This function clears the trigger’s event detector and discards the previous history of TRIG key presses.","This attribute also clears the display.trigger.overrun attribute.","Also see","display.trigger.overrun","display.trigger.wait()","display.trigger.clear()","14715.html");
+Page[138]=new Array("This constant is the event ID of the event generated when the front‑panel TRIG key is pressed.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Constant","Yes","Usage","eventID = display.trigger.EVENT_ID","eventID","The trigger event number","Details","Set the stimulus of any trigger event detector to the value of this constant to have it respond to front panel trigger key events.","Also see","None","display.trigger.EVENT_ID","14716.html");
+Page[139]=new Array("This attribute contains the event detector overrun status.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Display trigger clear Instrument reset Recall setup","Not saved","false","Usage","overrun = display.trigger.overrun","overrun","The trigger overrun state","Details","Indicates if a trigger event was ignored because the event detector was already in the detected state when the TRIG button was pressed.","Indicates the overrun state of the event detector built into the display.","This attribute does not indicate whether an overrun occurred in any other part of the trigger model or in any other detector that is monitoring the event.","Example","overrun = display.trigger.overrun","Sets the variable overrun equal to the present state of the event detector built into the display. ","Also see","display.trigger.clear()","display.trigger.overrun","14739.html");
+Page[140]=new Array("This function waits for the TRIG key on the front panel to be pressed.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","triggered = display.trigger.wait(timeout)","triggered","true: Trigger was detected","false: The operation timed out","timeout","Timeout in seconds","Details","If the trigger key was previously pressed and one or more trigger events were detected, this function returns immediately.","After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.","Use the display.trigger.clear() call to clear the trigger event detector.","Example","triggered = display.trigger.wait(5)","print(triggered)","Waits up to five seconds for the TRIG key to be pressed. If TRIG is pressed within five seconds, the output is true. If not, the output is false.","Also see","display.trigger.clear()","display.trigger.wait()","14717.html");
+Page[141]=new Array("This function captures the key code value for the next front‑panel action.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","keyCode = display.waitkey()","keyCode","See Details for more information","Details","After you send this function, script execution pauses until a front‑panel action (for example, pressing a key or the navigation wheel @, or turning the navigation wheel @). After the action, the value of the key (or action) is returned.","If the EXIT (LOCAL) key is pressed while this function is waiting for a front‑panel action, the script is not aborted.","The table below lists the keyCode value for each front panel action.","Key codes","Value","Key (or action)","Value","Key (or action)","0","display.KEY_NONE","82","display.KEY_ENTER","65","display.KEY_RANGEUP","85","display.KEY_RECALL","68","display.KEY_MENU","86","display.KEY_MEASA","69","display.KEY_MODEA","86","display.KEY_DIGITSA","70","display.KEY_RELA","88","display.KEY_OUTPUTA","71","display.KEY_RUN","92","display.KEY_TRIG","72","display.KEY_DISPLAY","93","display.KEY_LIMITA","73","display.KEY_AUTO","94","display.KEY_SPEEDA","75","display.KEY_EXIT","95","display.KEY_LOAD","77","display.KEY_FILTERA","97","display.WHEEL_ENTER","78","display.KEY_STORE","103","display.KEY_RIGHT","79","display.KEY_SRCA","104","display.KEY_LEFT","80","display.KEY_CONFIG","107","display.WHEEL_LEFT","81","display.KEY_RANGEDOWN","114","display.WHEEL_RIGHT","@ When using this function, use built-in constants such as display.KEY_RIGHT (rather than the numeric value of 103). This will allow for better forward compatibility with firmware revisions.","Example","key = display.waitkey()","print(key)","Pause script execution until the operator presses a key or the navigation wheel, or rotates the navigation wheel.","If the output is:","8.60000e+01","It indicates that the MEAS(A) key was pressed.","Also see","Capturing key-press codes","display.getlastkey()","display.sendkey()","display.settext()","display.waitkey()","20641.html");
+Page[142]=new Array("This function clears all entries out of the error queue.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","errorqueue.clear()","Details","See the Reading errors and Status model topics for additional information about the error queue.","Also see","errorqueue.count","errorqueue.next()","Reading errors","Status model","errorqueue.clear()","14749.html");
+Page[143]=new Array("This attribute gets the number of entries in the error queue.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Power cycle Clearing error queue Reading error messages","Not applicable","Not applicable","Usage","count = errorqueue.count","count","The number of entries in the error queue","Example","count = errorqueue.count","print(count)","Returns the number of entries in the error queue.","The output below indicates that there are four entries in the error queue:","4.00000e+00","Also see","errorqueue.clear()","errorqueue.next()","errorqueue.count","14750.html");
+Page[144]=new Array("This function reads the oldest entry from the error queue and removes it from the queue.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","errorCode, message, severity, errorNode = errorqueue.next()","errorCode","The error code number for the entry","message","The message that describes the error code","severity","The severity level (0, 10, 20, 30, or 40); see Details for more information","errorNode","The node number where the error originated","Details","Entries are stored in a first-in, first-out (FIFO) queue. This functions reads the oldest entry and removes it from the queue.","Error codes and messages are listed in the Error and status messages topics.","If there are no entries in the queue, code 0, "Queue is Empty" is returned.","Returned severity levels are described in the following table.","Severity level descriptions","Number","Level","Description","0 ","Informational","Indicates that there are no entries in the queue.","10 ","Informational","Indicates a status message or minor error.","20","Recoverable","Indicates possible invalid user input; operation continues but action should be taken to correct the error.","30","Serious","Indicates a serious error that may require technical assistance, such as corrupted data.","40","Fatal","Indicates that the Model 2651A is nonoperational and requires service. Contact information for service is provided at the front of this manual. Examples: “Bad SMU AFPGA image size,” “SMU is unresponsive,” and “Communication Timeout with DFPGA.”","In an expanded system, each TSP‑Link enabled instrument is assigned a node number. The variable errorNode stores the node number where the error originated.","Example","errorcode, message = errorqueue.next()","print(errorcode, message)","Reads the oldest entry in the error queue. The output below indicates that the queue is empty.","Output:","0.00000e+00 Queue Is Empty","Also see","errorqueue.clear()","errorqueue.count","Error and status messages","Status model","errorqueue.next()","17242.html");
+Page[145]=new Array("This function returns all entries from the event log as a single string and removes them from the event log.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","logString = eventlog.all()","logString","A listing of all event log entries","Details","This function returns all events in the event log. Logged items are shown from oldest to newest. The response is a string that has the messages delimited with a new line character.","This function also clears the event log.","If there are no entries in the event log, this function returns the value nil.","Example","print(eventlog.all())","Get and print all entries from the event log and remove the entries from the log.","Output:","17:26:35.690 10 Oct 2007, LAN0, 192.168.1.102, LXI, 0, 1192037132, 1192037155.733269000, 0, 0x0","17:26:39.009 10 Oct 2007, LAN5, 192.168.1.102, LXI, 0, 1192037133, 1192037159.052777000, 0, 0x0","Also see","eventlog.clear()","eventlog.count","eventlog.enable","eventlog.next()","eventlog.overwritemethod","eventlog.all()","14756.html");
+Page[146]=new Array("This function clears the event log.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","eventlog.clear()","Details","This function erases any messages in the event log.","Also see","eventlog.all()","eventlog.count","eventlog.enable","eventlog.next()","eventlog.overwritemethod","eventlog.clear()","14758.html");
+Page[147]=new Array("This attribute gets the number of events contained in the event log.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Instrument reset Clearing event log Reading event log","Not applicable","Not applicable","Usage","N = eventlog.count","N","The number of events in the event log","Example","print(eventlog.count)","Displays the present number of events contained in the Model 2651A event log.","Output looks similar to:","3.00000e+00","Also see","eventlog.all()","eventlog.clear()","eventlog.enable","eventlog.next()","eventlog.overwritemethod","eventlog.count","14757.html");
+Page[148]=new Array("This attribute enables or disables the event log.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Recall setup","Not saved","1 (eventlog.ENABLE)","Usage","status = eventlog.enable","eventlog.enable = status","status","The enable status of the event log:","1 or eventlog.ENABLE: Event log enable","0 or eventlog.DISABLE: Event log disable","Details","When the event log is disabled (eventlog.DISABLE or 0), no new events are added to the event log. You can, however, read and remove existing events.","When the event log is enabled, new events are logged.","Example","print(eventlog.enable)","eventlog.enable = eventlog.DISABLE","print(eventlog.enable)","Displays the present status of the Model 2651A event log.","Output:","1.00000e+00","0.00000e+00","Also see","eventlog.all()","eventlog.clear()","eventlog.count","eventlog.next()","eventlog.overwritemethod","eventlog.enable","14760.html");
+Page[149]=new Array("This function returns the oldest message from the event log and removes it from the log.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","logString = eventlog.next()","logString","The next log entry","Details","Returns the next entry from the event log and removes it from the log.","If there are no entries in the event log, returns the value nil.","Example 1","print(eventlog.next())","Get the oldest message in the event log and remove that entry from the log.","Output:","17:28:22.085 10 Oct 2009, LAN2, 192.168.1.102, LXI, 0, 1192037134, <no time>, 0, 0x0","Example 2","print(eventlog.next())","If you send this command when there is nothing in the event log, you will get the following output:","nil","Also see","eventlog.all()","eventlog.clear()","eventlog.count","eventlog.enable","eventlog.overwritemethod","eventlog.next()","14761.html");
+Page[150]=new Array("This attribute controls how the event log processes events if the event log is full.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Recall setup","Not saved ","1 (eventlog.DISCARD_OLDEST)","Usage","method = eventlog.overwritemethod","eventlog.overwritemethod = method","method","Set to one of the following values:","0 or eventlog.DISCARD_NEWEST: New entries are not logged","1 or eventlog.DISCARD_OLDEST: Old entries are deleted as new events are logged","Details","When this attribute is set to eventlog.DISCARD_NEWEST, new entries are not be logged.","When this attribute is set to eventlog.DISCARD_OLDEST, the oldest entry is discarded when a new entry is added.","Example","eventlog.overwritemethod = 0","When the log is full, the event log will ignore new entries.","Also see","eventlog.all()","eventlog.clear()","eventlog.count","eventlog.enable","eventlog.next()","eventlog.overwritemethod","14759.html");
+Page[151]=new Array("This function stops a script that is presently running.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","exit()","Details","Terminates script execution when called from a script that is being executed.","This command does not wait for overlapped commands to complete before terminating script execution. If overlapped commands are required to finish, use the waitcomplete() function before calling exit().","Also see","waitcomplete()","exit()","14769.html");
+Page[152]=new Array("This function closes the file that is represented by the fileVar variable.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","fileVar:close()","fileVar","The file descriptor variable to close","Details","This command is equivalent to io.close(fileVar).","Note that files are automatically closed when the file descriptors are garbage collected.","Also see","fileVar:flush()","fileVar:read()","fileVar:seek()","fileVar:write()","io.close()","io.open()","fileVar:close()","14772.html");
+Page[153]=new Array("This function writes buffered data to a file.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","fileVar:flush()","fileVar","The file descriptor variable to flush","Details","The fileVar:write() or io.write() functions buffer data, which may not be written immediately to the USB flash drive. Use this function to flush this data. Using this function removes the need to close a file after writing to it, allowing it to be left open to write more data. Data may be lost if the file is not closed or flushed before a script ends. ","If there is going to be a time delay before more data is written to a file, and you want to keep the file open, flush the file after you write to it to prevent loss of data.","Also see","fileVar:write()","io.open()","io.write()","fileVar:flush()","14786.html");
+Page[154]=new Array("This function reads data from a file.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","data1 = fileVar:read() ","data1 = fileVar:read(format1) ","data1, data2 = fileVar:read(format1, format2) ","data1, ..., datan = fileVar:read(format1, ..., formatn) ","data1","First data read from the file","data2","Second data read from the file","datan","Last data read from the file","fileVar","The descriptor of the file to be read","format1","A string or number indicating the first type of data to be read","format2","A string or number indicating the second type of data to be read","formatn","A string or number indicating the last type of data to be read","...","One or more entries (or values) separated by commas","Details","The format parameters may be any of the following:",""*n": Returns a number.",""*a": Returns the whole file, starting at the current position (returns an empty string if the current file position is at the end of the file).",""*l": Returns the next line, skipping the end of line; returns nil if the current file position is at the end of file.","n: Returns a string with up to n characters; returns an empty string if n is zero; returns nil if the current file position is at the end of file.","If no format parameters are provided, the function will perform as if the function is passed the value "*l".","Any number of format parameters may be passed to this command, each corresponding to a returned data value.","Also see","fileVar:write()","io.input()","io.open()","fileVar:read()","14787.html");
+Page[155]=new Array("This function sets and gets a file's current position.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","position, errorMsg = fileVar:seek()","position, errorMsg = fileVar:seek(whence)","position, errorMsg = fileVar:seek(whence, offset)","position","The new file position, measured in bytes from the beginning of the file","errorMsg","A string containing the error message","fileVar","The file descriptor variable","whence","A string indicating the base against which offset is applied; the whence attribute is optional (default is "cur")","offset","The intended new position, measured in bytes from a base indicated by whence (optional, default is 0)","Details","The whence parameters may be any of the following:",""set": Beginning of file",""cur": Current position",""end": End of file","If an error is encountered, it is logged to the error queue, and the command returns nil and the error string.","Also see","io.open()","Reading errors","fileVar:seek()","14788.html");
+Page[156]=new Array("This function writes data to a file.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","fileVar:write(data)","fileVar:write(data1, data2)","fileVar:write(data1, ..., datan)","fileVar","The file descriptor variable","data","Write all data to the file","data1","The first data to write to the file","data2","The second data to write to the file","datan","The last data to write to the file","...","One or more entries (or values) separated by commas","Details","This function may buffer data until a flush (fileVar:flush() or io.flush()) or close (fileVar:close() or io.close()) operation is performed.","Also see","fileVar:close()","fileVar:flush()","io.close()","io.open()","fileVar:write()","14789.html");
+Page[157]=new Array("This attribute sets the precision (number of digits) for all numbers printed with the ASCII format.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","No","Instrument reset Recall setup","Not saved ","6","Usage","precision = format.asciiprecision","format.asciiprecision = precision","precision","A number representing the number of digits to be printed for numbers printed with the print(), printbuffer(), and printnumber() functions; must be a number between 1 and 16","Details","This attribute specifies the precision (number of digits) for numeric data printed with the print(), printbuffer(), and printnumber() functions. The format.asciiprecision attribute is only used with the ASCII format. The precision value must be a number between 1 and 16.","Note that the precision is the number of significant digits printed. There is always one digit to the left of the decimal point; be sure to include this digit when setting the precision.","Example","format.asciiprecision = 10","x = 2.54","printnumber(x)","format.asciiprecision = 3","printnumber(x)","Output:","2.540000000e+00","2.54e+00","Also see","format.byteorder","format.data","print()","printbuffer()","printnumber()","format.asciiprecision","14797.html");
+Page[158]=new Array("This attribute sets the binary byte order for data printed using the printnumber() and printbuffer() functions.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Recall setup","Not saved","1 (format.LITTLEENDIAN)","Usage","order = format.byteorder","format.byteorder = order","order","Byte order value as follows:","Most significant byte first: 0, format.NORMAL, format.NETWORK, or format.BIGENDIAN","Least significant byte first: 1, format.SWAPPED or format.LITTLEENDIAN","Details","This attribute selects the byte order in which data is written when printing data values with the printnumber() and printbuffer() functions. The byte order attribute is only used with the format.SREAL, format.REAL, format.REAL32, and format.REAL64 data formats.","format.NORMAL, format.BIGENDIAN, and format.NETWORK select the same byte order. format.SWAPPED and format.LITTLEENDIAN select the same byte order. Selecting which to use is a matter of preference.","Select the format.SWAPPED or format.LITTLEENDIAN byte order when sending data to a computer with a Microsoft Windows operating system.","Example","x = 1.23","format.data = format.REAL32","format.byteorder = format.LITTLEENDIAN","printnumber(x)","format.byteorder = format.BIGENDIAN","printnumber(x)","Output depends on the terminal program you use, but will look something like:","#0¤p??","#0??p¤","Also see","format.asciiprecision","format.data","printbuffer()","printnumber()","format.byteorder","14801.html");
+Page[159]=new Array("This attribute sets the data format for data printed using the printnumber() and printbuffer() functions.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","No","Instrument reset Recall setup","Not saved ","1 (format.ASCII)","Usage","value = format.data","format.data = value","value","The format to use for data, set to one of the following values:","ASCII format: 1 or format.ASCII","Single‑precision IEEE Std 754 binary format: 2, format.SREAL, or format.REAL32","Double‑precision IEEE Std 754 binary format: 3, format.REAL, format.REAL64, or format.DREAL","Details","The precision of numeric values can be controlled with the format.asciiprecision attribute. The byte order of format.SREAL, format.REAL, format.REAL32, and format.REAL64 can be selected with the format.byteorder attribute.","REAL32 and SREAL select the same single precision format. REAL and REAL64 select the same double precision format. They are alternative identifiers. Selecting which to use is a matter of preference.","The IEEE Std 754 binary formats use four bytes each for single‑precision values and eight bytes each for double‑precision values.","When data is written with any of the binary formats, the response message starts with “#0” and ends with a new line. When data is written with the ASCII format, elements are separated with a comma and space.","@ Binary formats are not intended to be interpreted by humans.","Example","format.asciiprecision = 10","x = 3.14159265","format.data = format.ASCII","printnumber(x)","format.data = format.REAL64","printnumber(x)","Output a number represented by x in ASCII using a precision of 10, then output the same number in binary using double precision format.","Output:","3.141592650e+00","#0ñÔÈSû! @","Also see","format.asciiprecision","format.byteorder","printbuffer()","printnumber()","format.data","14803.html");
+Page[160]=new Array("This function sets the current working directory.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","workingDirectory = fs.chdir(path)","workingDirectory","Returned value containing the working path","path","A string indicating the new working directory path","Details","The new working directory path may be absolute or relative to the current working directory.","An error is logged to the error queue if the given path does not exist.","Example","testPath = fs.chdir("/usb1/")","Change the working directory to usb1.","Also see","None","fs.chdir()","14808.html");
+Page[161]=new Array("This function returns the absolute path of the current working directory.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","path = fs.cwd()","path","The absolute path of the current working directory","Also see","None","fs.cwd()","14810.html");
+Page[162]=new Array("This function tests whether or not the specified path refers to a directory.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","status = fs.is_dir(path)","status","Whether or not the given path is a directory (true or false)","path","The path of the file system entry to test","Details","The file system path may be absolute or relative to the current working system path.","Also see","fs.is_file()","fs.is_dir()","14811.html");
+Page[163]=new Array("Tests whether the specified path refers to a file (as opposed to a directory).","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","status = fs.is_file(path)","status","true if the given path is a file; otherwise, false","path","The path of the file system entry to test","Details","The file system path may be absolute or relative to the current working system path.","Also see","fs.is_dir()","fs.is_file()","14824.html");
+Page[164]=new Array("This function creates a directory at the specified path.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","path = fs.mkdir(newPath)","path","The returned path of the new directory","newpath","Location (path) of where to create the new directory","Details","The directory path may be absolute or relative to the current working directory.","An error is logged to the error queue if the parent folder of the new directory does not exist, or if a file system entry already exists at the given path.","Also see","fs.rmdir()","fs.mkdir()","14812.html");
+Page[165]=new Array("This function returns a list of the file system entries in the directory.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","files = fs.readdir(path)","files","A table containing the names of all the file system entries in the specified directory","path","The directory path","Details","The directory path may be absolute or relative to the current working directory.","This command is nonrecursive. For example, entries in subfolders are not returned.","An error is logged to the error queue if the given path does not exist or does not represent a directory.","Also see","None","fs.readdir()","14814.html");
+Page[166]=new Array("This function removes a directory from the file system.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","fs.rmdir(path)","path","The path of the directory to remove","Details","This path may be absolute or relative to the current working directory.","An error is logged to the error queue if the given path does not exist, or does not represent a directory, or if the directory is not empty.","Also see","fs.mkdir()","fs.rmdir()","14815.html");
+Page[167]=new Array("This function retrieves the local time zone.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","timeZone = gettimezone()","timeZone","The local timezone of the instrument","Details","See settimezone() for additional details on the time zone format and a description of the fields. timeZone can be in either of the following formats:","If one argument was used with settimezone(), the format used is: GMThh:mm:ss","If four arguments were used with settimezone(), the format used is: GMThh:mm:ssGMThh:mm:ss,Mmm.w.dw/hh:mm:ss,Mmm.w.dw/hh:mm:ss","Example","timezone = gettimezone()","Reads the value of the local timezone.","Also see","settimezone()","gettimezone()","15011.html");
+Page[168]=new Array("This KIParlib factory script function performs a linear current sweep and calculates the transconductance (Gm) at each point.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","gm_array, vbuf, ibuf = gm_isweep(smu, start_i, stop_i, points)","gm_array","A Lua table containing the calculated Gm values at each point","vbuf","A reading buffer containing the measured voltage at each point","ibuf","A reading buffer containing the measured current at each point","smu","System SourceMeter® instrument channel (set to smua)","start_i","Starting current level of the sweep ","stop_i","Ending current level of the sweep ","points","Number of measurements between start_i and stop_i (must be ≥ 2)","Details","Output data includes transconductance values, reading buffer with measured voltages, reading buffer with measured voltages and currents.","If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.","The gm_isweep() function performs a linear current sweep, measuring voltage and current, and then calculating the transconductance (Gm) at each point using the central difference method. It can return an array of Gm values, a reading buffer with the measured voltages, and a reading buffer with the measured currents.","Example","gm_array = gm_isweep(smua, 0, 0.01, 20)","gm_array, vbuf = gm_isweep(smua, 0, 0.01, 20)","gm_array, vbuf, ibuf = gm_isweep(smua, 0,"," 0.01, 20)","Source‑measure unit (SMU) A returns Gm values only.","SMU A returns Gm and reading buffer with measured voltages.","SMU A returns Gm and reading buffers with measured voltages and currents.","Also see","gm_vsweep()","gm_isweep()","12957.html");
+Page[169]=new Array("This KIParlib factory script function performs a linear voltage sweep and calculates the transconductance (Gm) at each point.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","gm_array, ibuf, vbuf = gm_vsweep(smu, start_v, stop_v, points)","gm_array","A Lua table containing the calculated Gm values at each point","ibuf","A reading buffer containing the measured current at each point","vbuf","A reading buffer containing the measured voltage at each point","smu","System SourceMeter® instrument channel (set to smua)","start_v","Starting voltage level of the sweep ","stop_v","Ending voltage level of the sweep ","points","Number of measurements between start_v and stop_v (must be ≥ 2)","Details","Output data includes transconductance values, reading buffer with measured currents, reading buffer with measured currents and voltages.","The gm_vsweep() function performs a linear voltage sweep, measuring voltage and current, and then calculating the transconductance (Gm) at each point using the central difference method. It can return an array of Gm values, a reading buffer with the measured currents, and a reading buffer with the measured voltages.","Example","gm_array = gm_vsweep(smua, 0, 5, 20)","gm_array, ibuf = gm_vsweep(smua, 0, 5, 20)","gm_array, ibuf, vbuf = gm_vsweep(smua, 0, 5, 20)","SMU A returns Gm values only.","SMU A returns Gm and reading buffer with measured currents.","SMU A returns Gm and reading buffers with measured currents and voltages.","Also see","gm_isweep()","gm_vsweep()","12955.html");
+Page[170]=new Array("This attribute contains the GPIB address.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Not applicable","Nonvolatile memory","26","Usage","address = gpib.address","gpib.address = address","address","GPIB address (0 to 30)","Details","A new GPIB address takes affect when the command to change it is processed. If there are response messages in the output queue when this command is processed, they must be read at the new address.","If command messages are being queued (sent before this command has executed), the new settings may take effect in the middle of a subsequent command message, so care should be exercised when setting this attribute from the GPIB interface.","You should allow ample time for the command to be processed before attempting to communicate with the instrument again. After sending this command, make sure to use the new address to communicate with the instrument.","The GPIB address is stored in nonvolatile memory. The reset function has no affect on the address.","Example","gpib.address = 26","address = gpib.address","print(address)","Sets the GPIB address and reads the address.","Output:","2.600000e+01","Also see","GPIB operation","gpib.address","14860.html");
+Page[171]=new Array("This KIHighC factory script function performs a current leakage measurement after stepping the output voltage.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","imeas = i_leakage_measure(smu, levelv, limiti, sourcedelay, measurei, measuredelay)","imeas","The measured current","smu","System SourceMeter® instrument channel (set to smua)","levelv","Voltage level to step to when this function is called","limiti","Current limit setting for the voltage step","sourcedelay","Delay to wait before lowering the current limit for measurement","measurei","Current limit (and measure range); note the current limit is lower at this level and because high-capacitance mode is active, the measure range will follow","measuredelay","Delay to wait after lowering the current limit before taking the measurement","Details","Use this function when high-capacitance mode is active.","When the instrument is in high-capacitance mode, this function causes the smu to:","Change its current limit to limiti with a voltage output of levelv for sourcedelay time, and then changes its current limit to measurei (that also changes the measurement range to measurei) for measuredelay time ","When measuredelay time expires, a measurement is taken and returned as imeas.","When measuring leakage current:","Charge the capacitor before calling this function (the instrument's output is usually at a nonzero voltage prior to calling this function; when measuring leakage, this function does not charge the capacitor). ","Set levelv = 0","Example","smua.source.highc = smua.ENABLE","smua.source.levelv = 5","smua.source.output = smua.OUTPUT_ON","delay(1)","imeas = i_leakage_measure(smua, 0, 1, 300e‑3,"," 10e-6, .1)","Enable high-capacitance mode.","Charge the capacitor at 5 V for 1 second set by delay(1).","The parameters passed on to the i_leakage_measure() function in this example are:","smu = smua","levelv = 0 V","limiti = 1 A","sourcedelay = 300 ms","measurei = 10 mA range","measuredelay = 100 ms","The levels and delays will depend on the value and type of capacitor used.","Also see","i_leakage_threshold()","High-capacitance mode","i_leakage_measure()","12951.html");
+Page[172]=new Array("This KIHighC factory script function measures the current and compares it to a threshold until either the measured current drops below the threshold or the timeout expires.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","f = i_leakage_threshold(smu, levelv, limiti, sourcedelay, measurei, measuredelay, threshold, timeout)","f","A Boolean flag; this flag will be true when the current is below the threshold, false if threshold is not reached before timeout expires","smu","System SourceMeter® instrument channel (set to smua)","levelv","Voltage level to step to when this function is called","limiti","Current limit setting for the voltage step","sourcedelay","Delay to wait before lowering the current limit for measurement","measurei","Current limit (and measure range); note the current limit is lower at this level and because high-capacitance mode is active, the measure range will follow","measuredelay","Delay before the first measurement after measure range is changed","threshold","The specified current that establishes the test limit","timeout","Amount of time (in seconds) to wait for the current to drop to threshold after all the delays have occurred","Details","This function is intended to be used when high-capacitance mode is active.","When the instrument is in high-capacitance mode, this function causes the smu to:","Change its current limit to limiti with a voltage output of levelv for sourcedelay time, and then changes its current limit to measurei (that also changes the measurement range to measurei) for measuredelay time ","When measuredelay time expires, measurements are taken at a rate determined by the smuX.measure.nplc setting","The function returns true if threshold is reached; the function returns false if threshold is not reached before timeout expires.","When testing the leakage current threshold:","Charge the capacitor before calling this function (the instrument's output is usually at a non-zero voltage prior to calling this function; when measuring leakage, this function does not charge the capacitor).","If testing the device's leakage current threshold, set levelv = 0.","Example","smua.source.highc = smua.ENABLE","smua.source.levelv = 5","smua.source.output = smua.OUTPUT_ON","delay(1)","pass = i_leakage_threshold(smua, 0, 1,"," 300e-3, 10e-6, 100e-3, 1e-6, 1)","Enable high-capacitance mode.","Charge the capacitor. ","The parameters passed on to the i_threshold_measure() function in this example are:","smu = smua","levelv = 0 V","limiti = 1 A","sourcedelay = 300 ms","measurei = 10 mA range","measuredelay = 100 ms","threshold = 1 mA","timeout = 1 s","The levels and delays will depend on the value and type of capacitor used.","Sets pass = true if the current is measured below 1 mA in less than 1 second.","Also see","i_leakage_measure()","High-capacitance mode","i_leakage_threshold()","12953.html");
+Page[173]=new Array("This KIPulse factory script function initiates the pulse configuration assigned to tag.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","f, msg = InitiatePulseTest(tag)","f","A Boolean flag; this flag will be true when the pulse was successfully configured, false when errors were encountered","msg","A string message; if the f flag is false, msg will contain an error message; if it is true, msg will contain a string indicating successful configuration","tag","Numeric identifier of the pulse configuration to be initiated","Details","This function will only initiate configured pulse trains assigned to a valid tag. Configure the pulse before initiating it using one of the ConfigurePulse* functions (refer to the Also see section).","Example","smua.reset()","smua.source.rangev = 5","smua.source.rangei = 1","smua.source.levelv = 0","smua.measure.rangev = 5","smua.measure.rangei = 1","smua.measure.nplc = 0.01","smua.measure.autozero = smua.AUTOZERO_ONCE","smua.nvbuffer1.clear()","smua.nvbuffer1.appendmode = 1","smua.source.output = smua.OUTPUT_ON","f1, msg1 = ConfigPulseVMeasureI(smua, 0, 5,"," 1, 0.002, 0.2, 10, smua.nvbuffer1, 1)","if f1 == true then"," f2, msg2 = InitiatePulseTest(1)"," print("Initiate message:", msg2)","else"," print("Config errors:", msg1)","end","Configure System SourceMeter® instrument channel A to generate a pulse train. If no errors are encountered, initiate the pulse train. Channel A will pulse voltage from a bias level of 0 V to a pulse level of 5 V. The pulse level will be present for 2 ms and the bias level for 200 ms, with a 1 A limit setting. A total of 10 pulses will be generated, and the measurement data will be stored in smua.nvbuffer1. This pulse train will be assigned to tag = 1.","Also see","ConfigPulseIMeasureV()","ConfigPulseVMeasureI()","ConfigPulseIMeasureVSweepLin()","ConfigPulseVMeasureISweepLin()","ConfigPulseIMeasureVSweepLog()","ConfigPulseVMeasureISweepLog()","InitiatePulseTest()","12929.html");
+Page[174]=new Array("This function closes a file.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes (see Details)","Usage","io.close()","io.close(file)","file","The descriptor of the file to close","Details","If a file is not specified, the default output file closes.","Only io.close(), used without specifying a parameter, can be accessed from a remote node.","Example","testFile, testError = io.open("testfile.txt", "w")","if nil == testError then"," testFile:write("This is my test file")"," io.close(testFile)","end","Opens file testfile.txt for writing. If no errors were found while opening, writes "This is my test file" and closes the file.","Also see","io.open()","io.close()","14868.html");
+Page[175]=new Array("This function saves buffered data to a file.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","io.flush()","Details","You must use the io.flush() or io.close() functions to write data to the file system.","@ Data is not automatically written to a file when you use the io.write() function. The io.write() function buffers data; it may not be written to the USB drive immediately. Use the io.flush() function to immediately write buffered data to the drive.","This function only flushes the default output file.","Using this command removes the need to close a file after writing to it and allows it to be left open to write more data. Data may be lost if the file is not closed or flushed before an application ends. To prevent the loss of data if there is going to be a time delay before more data is written (and when you want to keep the file open and not close it), flush the file after writing to it.","Also see","fileVar:flush()","fileVar:write()","io.write()","io.flush()","14870.html");
+Page[176]=new Array("This function assigns a previously opened file, or opens a new file, as the default input file.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes (see Details)","Usage","fileVar = io.input()","fileVar = io.input(newfile)","fileVar","The descriptor of the input file or an error message (if the function fails)","newfile","A string representing the path of a file to open as the default input file, or the file descriptor of an open file to use as the default input file","Details","The newfile path may be absolute or relative to the current working directory.","When using this function from a remote TSP-Link® node, this command does not accept a file descriptor and does not return a value.","If the function fails, an error message is returned.","Also see","io.open()","io.output()","io.input()","14871.html");
+Page[177]=new Array("This function opens a file for later reference.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","fileVar, errorMsg = io.open(path)","fileVar, errorMsg = io.open(path, mode)","fileVar","The descriptor of the opened file","errorMsg","Indicates whether an error was encountered while processing the function","path","The path of the file to open","mode","A string representing the intended access mode ("r" = read, "w" = write, and "a" = append)","Details","The path to the file to open may be absolute or relative to the current working directory. If you successfully open the file, errorMsg is nil and fileVar has the descriptor that can be used to access the file.","If an error is encountered, the command returns nil for fileVar and an error string.","Example","testFile, testError = io.open("testfile.txt", "w")","if testError == nil then"," testFile:write("This is my test file")"," io.close(testFile)","end","Opens file testfile.txt for writing. If no errors were found while opening, writes "This is my test file" and closes the file.","Also see","io.close()","io.open()","14872.html");
+Page[178]=new Array("This function assigns a previously opened file, or opens a new file, as the default output file.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes (see Details)","Usage","fileVar = io.output()","fileVar = io.output(newfile)","fileVar","The descriptor of the output file or an error message (if the function fails)","newfile","A file descriptor to assign (or the path of a file to open) as the default output file","Details","The path of the file to open may be absolute or relative to the current working directory.","When accessed from a remote node using the TSP-Link network, this command does not accept a file descriptor parameter and does not return a value.","If the function fails, an error message is returned.","Also see","io.input()","io.open()","io.output()","14873.html");
+Page[179]=new Array("This function reads data from the default input file.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","data1 = io.read()","data1 = io.read(format1)","data1, data2 = io.read(format1, format2)","data1, ..., dataN = io.read(format1, ..., formatN)","data1","The data read from the file","data2","The data read from the file","dataN","The data read from the file; the number of return values matches the number of format values given","format1","A string or number indicating the type of data to be read","format2","A string or number indicating the type of data to be read","formatN","A string or number indicating the type of data to be read","...","One or more entries (or values) separated by commas","Details","The format parameters may be any of the following:","Format parameter","Description",""*N"","Returns a number",""*a"","Returns the whole file, starting at the current position; returns an empty string if it is at the end of file",""*l"","Returns the next line, skipping the end of line; returns nil if the current file position is at the end of file","N","Returns a string with up to N characters; returns an empty string if N is zero (0); returns nil if the current file position is at the end of file","Any number of format parameters may be passed to this command, each corresponding to a returned data value.","If no format parameters are provided, the function will perform as if the function was passed the value "*l".","Also see","None","io.read()","14874.html");
+Page[180]=new Array("This function checks whether or not a given object is a file handle.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","type = io.type(obj)","type","Indicates whether the object is an open file handle","obj","Object to check","Details","Returns the string "file" if the object is an open file handle. If it is not an open file handle, nil is returned.","Also see","io.open()","io.type()","14875.html");
+Page[181]=new Array("This function writes data to the default output file.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","io.write()","io.write(data1)","io.write(data1, data2)","io.write(data1, ..., dataN)","data1","The data to be written","data2","The data to be written","dataN","The data to be written","...","One or more values separated by commas","Details","All data parameters must be either strings or numbers.","@ Data is not immediately written to a file when you use the io.write() function. The io.write() function buffers data; it may not be written to the USB drive immediately. Use the io.flush() function to immediately write buffered data to the drive.","Also see","io.flush()","io.write()","14877.html");
+Page[182]=new Array("This function re-initializes the LAN interface with new settings.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","lan.applysettings()","Details","Disconnects all existing LAN connections to the instrument and re-initializes the LAN with the current configuration settings.","This function initiates a background operation. LAN configuration could be a lengthy operation. Although the function returns immediately, the LAN initialization will continue to run in the background.","Even though the LAN configuration settings may not have changed since the LAN was last connected, new settings may take effect due to the dynamic nature of DHCP or DLLA configuration.","Re-initialization takes effect even if the configuration has not changed since the last time the instrument connected to the LAN.","Example","lan.applysettings()","Re-initialize the LAN interface with new settings.","Also see","None","lan.applysettings()","14890.html");
+Page[183]=new Array("This attribute is used to enable or disable link monitoring.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","LAN restore defaults","Nonvolatile memory","1 (lan.ENABLE)","Usage","state = lan.autoconnect","lan.autoconnect = state","state","LAN link monitoring state:","1 or lan.ENABLE: Enables automatic link reconnection and monitoring","0 or lan.DISABLE: Disables automatic link reconnection and monitoring","Details","This attribute sets the LAN link monitoring and automatic connection state.","When this is set to lan.ENABLE, all connections are closed if the link to the LAN is lost for more than the time specified by lan.linktimeout.","Set this attribute to lan.ENABLE to automatically reset the LAN configuration after the LAN link is established.","Also see","lan.linktimeout","lan.restoredefaults()","lan.autoconnect","14891.html");
+Page[184]=new Array("Configures DNS server IP addresses.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","LAN restore defaults","Nonvolatile memory",""0.0.0.0"","Usage","dnsAddress = lan.config.dns.address[N]","lan.config.dns.address[N] = dnsAddress","dnsAddress","DNS server IP address","N","Entry index (1 or 2)","Details","This attribute is an array of DNS (domain name system) server addresses. These addresses take priority for DNS lookups and are consulted before any server addresses that are obtained using DHCP. This allows local DNS servers to be specified that take priority over DHCP‑configured global DNS servers.","You can specify up to two addresses. The address specified by 1 is consulted first for DNS lookups.","Unused entries will be returned as "0.0.0.0" when read. dnsAddress must be a string specifying the DNS server’s IP address in dotted decimal notation. To disable an entry, set its value to "0.0.0.0" or the empty string "".","Although only two address may be manually specified here, the instrument will use up to three DNS server addresses. If two are specified here, only one that is given by a DHCP server is used. If no entries are specified here, up to three addresses that are given by a DHCP server are used. The IP address obtained from the DHCP server takes priority for all DNS lookups.","Example","dnsaddress = "164.109.48.173"","lan.config.dns.address[1] = dnsaddress","Configure DNS address 1 to "164.109.48.173"","Also see","lan.config.dns.domain","lan.config.dns.dynamic","lan.config.dns.hostname","lan.config.dns.verify","lan.restoredefaults()","lan.config.dns.address[N]","14898.html");
+Page[185]=new Array("Configures the dynamic DNS domain.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","LAN restore defaults","Nonvolatile memory","""","Usage","domain = lan.config.dns.domain","lan.config.dns.domain = domain","domain","Dynamic DNS registration domain; use a string of 255 characters or less","Details","This attribute holds the domain to request during dynamic DNS registration. Dynamic DNS registration works with DHCP to register the domain specified in this attribute with the DNS server.","The length of the fully qualified host name (combined length of the domain and host name with separator characters) must be less than or equal to 255 characters. Although up to 255 characters are allowed, you must make sure the combined length is also no more than 255 characters.","Example","print(lan.config.dns.domain)","Outputs the present dynamic DNS domain. For example, if the domain is "Matrix", the response would be:","Matrix","Also see","lan.config.dns.dynamic","lan.config.dns.hostname","lan.config.dns.verify","lan.restoredefaults()","lan.config.dns.domain","14899.html");
+Page[186]=new Array("Enables or disables the dynamic DNS registration.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","LAN restore defaults","Nonvolatile memory","1 (lan.ENABLE)","Usage","state = lan.config.dns.dynamic","lan.config.dns.dynamic = state","state","The dynamic DNS registration state. It may be one of the following values:","1 or lan.ENABLE: Enabled 0 or lan.DISABLE: Disabled","Details","Dynamic DNS registration works with DHCP to register the host name with the DNS server. The host name is specified in the lan.config.dns.hostname attribute.","Example","print(lan.config.dns.dynamic)","Outputs the dynamic registration state.","If dynamic DNS registration is enabled, the response is:","1.00000e+00","Also see","lan.config.dns.hostname","lan.restoredefaults()","lan.config.dns.dynamic","14900.html");
+Page[187]=new Array("This attribute defines the dynamic DNS host name.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","LAN restore defaults","Nonvolatile memory","Instrument‑specific (see Details)","Usage","hostName = lan.config.dns.hostname","lan.config.dns.hostname = hostName","hostName","The host name to use for dynamic DNS registration; the host name must:","be a string of 255 characters or less","start with a letter","end with a letter or digit","contain only letters, digits, and hyphens","Details","This attribute holds the host name to request during dynamic DNS registration. Dynamic DNS registration works with DHCP to register the host name specified in this attribute with the DNS server.","The format for hostName is "k‑<model number>‑<serial number>", where <model number> and <serial number> are replaced with the actual model number and serial number of the instrument (for example, "k‑2651A‑1234567"). Note that hyphens separate the characters of hostName. ","The length of the fully qualified host name (combined length of the domain and host name with separator characters) must be less than or equal to 255 characters. Although up to 255 characters can be entered here, care must be taken to be sure the combined length is also no more than 255 characters.","Example","print(lan.config.dns.hostname)","Outputs the present dynamic DNS host name.","Also see","lan.config.dns.dynamic","lan.restoredefaults()","lan.config.dns.hostname","14901.html");
+Page[188]=new Array("This attribute defines the DNS host name verification state.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","LAN restore defaults","Nonvolatile memory","1 (lan.ENABLE)","Usage","state = lan.config.dns.verify","lan.config.dns.verify = state","state","DNS hostname verification state:","1 or lan.ENABLE: DNS host name verification enabled 0 or lan.DISABLE: DNS host name verification disabled","Details","When this is enabled, the instrument performs DNS lookups to verify that the DNS host name matches the value specified by lan.config.dns.hostname.","Example","print(lan.config.dns.verify)","Outputs the present DNS host name verification state.","If it is enabled, the output is:","1.00000e+00","Also see","lan.config.dns.hostname","lan.restoredefaults()","lan.config.dns.verify","14902.html");
+Page[189]=new Array("This attribute defines the LAN duplex mode.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","LAN restore defaults","Nonvolatile memory","1 (lan.FULL)","Usage","duplex = lan.config.duplex","lan.config.duplex = duplex","duplex","LAN duplex setting can be one of the following values:","1 or lan.FULL: Selects full-duplex operation 0 or lan.HALF: Selects half-duplex operation","Details","This attribute does not indicate the actual setting currently in effect. Use the lan.status.duplex attribute to determine the current operating state of the LAN.","Also see","lan.restoredefaults()","lan.config.duplex","14903.html");
+Page[190]=new Array("This attribute contains the LAN default gateway address.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","LAN restore defaults","Nonvolatile memory",""0.0.0.0"","Usage","gatewayAddress = lan.config.gateway","lan.config.gateway = gatewayAddress","gatewayAddress","LAN default gateway address; must be a string specifying the default gateway’s IP address in dotted decimal notation","Details","This attribute specifies the default gateway IP address to use when manual or DLLA configuration methods are used to configure the LAN. If DHCP is enabled, this setting is ignored.","This attribute does not indicate the actual setting currently in effect. Use the lan.status.gateway attribute to determine the current operating state of the LAN.","The IP address must be formatted in four groups of numbers each separated by a decimal.","Example","print(lan.config.gateway)","Outputs the default gateway address. For example, you might see the output:","192.168.0.1","Also see","lan.status.gateway","lan.restoredefaults()","lan.config.gateway","14904.html");
+Page[191]=new Array("This attribute specifies the LAN IP address.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","LAN restore defaults","Nonvolatile memory",""192.168.0.2"","Usage","ipAddress = lan.config.ipaddress","lan.config.ipaddress = ipAddress","ipAddress","LAN IP address; must be a string specifying the IP address in dotted decimal notation","Details","This attribute specifies the LAN IP address to use when the LAN is configured using the manual configuration method. This setting is ignored when DLLA or DHCP is used.","This attribute does not indicate the actual setting currently in effect. Use the lan.status.ipaddress attribute to determine the current operating state of the LAN.","Example","ipaddress = lan.config.ipaddress","Retrieves the presently set LAN IP address.","Also see","lan.restoredefaults()","lan.status.ipaddress","lan.config.ipaddress","14905.html");
+Page[192]=new Array("This attribute contains the LAN settings configuration method.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","LAN restore defaults","Nonvolatile memory","0 (lan.AUTO)","Usage","method = lan.config.method","lan.config.method = method","method","The method for configuring LAN settings; it can be one of the following values:","0 or lan.AUTO: Selects automatic sequencing of configuration methods","1 or lan.MANUAL: Use only manually specified configuration settings","Details","This attribute controls how the LAN IP address, subnet mask, default gateway address, and DNS server addresses are determined.","When method is lan.AUTO, the instrument first attempts to configure the LAN settings using dynamic host configuration protocol (DHCP). If DHCP fails, it tries dynamic link local addressing (DLLA). If DLLA fails, it uses the manually specified settings.","When method is lan.MANUAL, only the manually specified settings are used. Neither DHCP nor DLLA are attempted.","Example","print(lan.config.method)","Outputs the current method.","For example:","1.00000e+00","Also see","lan.restoredefaults()","lan.config.method","14906.html");
+Page[193]=new Array("This attribute contains the LAN speed used when restarting in manual configuration mode.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","LAN restore defaults","Nonvolatile memory","100 (100 Mbps)","Usage","speed = lan.config.speed","lan.config.speed = speed","speed","LAN speed setting in Mbps (10 or 100)","Details","This attribute does not indicate the actual setting currently in effect. Use the lan.status.speed attribute to determine the current operating state of the LAN.","This attribute stores the speed that will be used if the LAN is restarted for manual configuration operation.","The LAN speed is measured in megabits per second (Mbps).","Example","lan.config.speed = 100","Configure LAN speed for 100.","Also see","lan.restoredefaults()","lan.status.speed","lan.config.speed","14907.html");
+Page[194]=new Array("This attribute contains the LAN subnet mask.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","LAN restore defaults","Nonvolatile memory",""255.255.255.0"","Usage","mask = lan.config.subnetmask","lan.config.subnetmask = mask","mask","LAN subnet mask value string that specifies the subnet mask in dotted decimal notation","Details","This attribute specifies the LAN subnet mask to use when the manual configuration method is used to configure the LAN. This setting is ignored when DLLA or DHCP is used.","This attribute does not indicate the actual setting currently in effect. Use the lan.status.subnetmask attribute to determine the current operating state of the LAN.","Example","print(lan.config.subnetmask)","Outputs the LAN subnet mask, such as:","255.255.255.0","Also see","lan.restoredefaults()","lan.status.subnetmask","lan.config.subnetmask","14908.html");
+Page[195]=new Array("This attribute contains the LAN link timeout period.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","LAN restore defaults","Nonvolatile memory","20 (20 s)","Usage","timeout = lan.linktimeout ","lan.linktimeout = timeout","timeout","The LAN link monitor time-out period (in seconds)","Details","You must enable the command lan.autoconnect before you can use this attribute.","The timeout value represents the amount of time that passes before the instrument disconnects from the LAN due to the loss of the LAN link integrity.","The LAN interface does not disconnect if the connection to the LAN is reestablished before the timeout value expires.","If the LAN link integrity is not restored before the timeout value expires, the instrument begins to monitor for a new connection.","Example","print(lan.linktimeout)","Outputs the present LAN link timeout setting.","Also see","lan.autoconnect","lan.restoredefaults()","lan.linktimeout","14892.html");
+Page[196]=new Array("This attribute contains the LXI domain.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","LAN restore defaults","Nonvolatile memory","0","Usage","domain = lan.lxidomain","lan.lxidomain = domain","domain","The LXI domain number (0 to 255)","Details","This attribute sets the LXI domain number.","All outgoing LXI packets will be generated with this domain number. All inbound LXI packets will be ignored unless they have this domain number.","Example","print(lan.lxidomain)","Displays the LXI domain.","Also see","lan.restoredefaults()","lan.lxidomain","14893.html");
+Page[197]=new Array("This attribute controls the state of the LAN Nagle algorithm.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Power cycle","Not saved","0 (lan.DISABLE)","Usage","state = lan.nagle","lan.nagle = state","state","1 or lan.ENABLE: Enable the LAN Nagle algorithm for TCP connections","0 or lan.DISABLE: Disable the Nagle algorithm for TCP connections","Details","This attribute enables or disables the use of the LAN Nagle algorithm on transmission control protocol (TCP) connections.","Also see","lan.restoredefaults()","lan.nagle","14894.html");
+Page[198]=new Array("This function resets the LAN interface.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","lan.reset()","Details","This function resets the LAN interface. It performs the commands lan.restoredefaults() and lan.applysettings().","Also see","lan.applysettings()","lan.restoredefaults()","lan.reset()","14895.html");
+Page[199]=new Array("This function resets LAN settings to default values.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","lan.restoredefaults()","Details","The settings that are restored are shown in the following table.","Settings that are restored to default","Attribute","Default setting","lan.autoconnect","lan.ENABLE","lan.config.dns.address[N]",""0.0.0.0"","lan.config.dns.domain","""","lan.config.dns.dynamic","lan.ENABLE","lan.config.dns.hostname","""","lan.config.dns.verify","lan.ENABLE","lan.config.duplex","lan.FULL","lan.config.gateway",""0.0.0.0"","lan.config.ipaddress",""192.168.0.2"","lan.config.method","lan.AUTO","lan.config.speed","100","lan.config.subnetmask",""255.255.255.0"","lan.linktimeout","20 (seconds)","lan.lxidomain","0","lan.nagle","lan.ENABLE","lan.timedwait","20 (seconds)","The lan.restoredefaults() function does not reset the LAN password. The localnode.password attribute controls the web password, which can be reset separately.","This command is run when lan.reset() is sent.","Example","lan.restoredefaults()","Restores the LAN defaults.","Also see","lan.reset()","localnode.password","lan.restoredefaults()","14896.html");
+Page[200]=new Array("This attribute contains the DNS server IP addresses.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not applicable","Not applicable","Usage","dnsAddress = lan.status.dns.address[N]","dnsAddress","DNS server IP address","N","Entry index (1, 2, or 3)","Details","This attribute is an array of DNS server addresses. The system can use up to three addresses.","Unused or disabled entries are returned as "0.0.0.0" when read. The dnsAddress returned is a string specifying the IP address of the DNS server in dotted decimal notation.","You can only specify two addresses manually. However, the instrument uses up to three DNS server addresses. If two are specified, only the one given by a DHCP server is used. If no entries are specified here, up to three address given by a DHCP server are used.","The value of lan.status.dns.address[1] is referenced first for all DNS lookups. The values of lan.status.dns.address[2] and lan.status.dns.address[3] are referenced second and third, respectively.","Example","print(lan.status.dns.address[1])","Outputs DNS server address 1, for example:","164.109.48.173","Also see","lan.status.dns.name","lan.status.dns.address[N]","14909.html");
+Page[201]=new Array("This attribute contains the present DNS fully qualified host name.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not applicable","Not applicable","Usage","hostName = lan.status.dns.name","hostName","Fully qualified DNS host name that can be used to connect to the instrument","Details","A fully qualified domain name (FQDN), sometimes referred to as an absolute domain name, is a domain name that specifies its exact location in the tree hierarchy of the Domain Name System (DNS).","A FQDN is the complete domain name for a specific computer or host on the LAN. The FQDN consists of two parts: the host name and the domain name.","If the DNS host name for an instrument is not found, this attribute stores the IP address in dotted decimal notation.","Example","print(lan.status.dns.name)","Outputs the dynamic DNS host name.","Also see","lan.config.dns.address[N]","lan.config.dns.hostname","lan.status.dns.name","14910.html");
+Page[202]=new Array("This attribute contains the duplex mode presently in use by the LAN interface.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not applicable","Not applicable","Usage","duplex = lan.status.duplex","duplex","LAN duplex setting can be one of the following values: 0 or lan.HALF: half-duplex operation 1 or lan.FULL: full-duplex operation","Example","print(lan.status.duplex)","Outputs the present LAN duplex mode, such as:","1.00000e+00","Also see","None","lan.status.duplex","14911.html");
+Page[203]=new Array("This attribute contains the gateway address presently in use by the LAN interface.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not applicable","Not applicable","Usage","gatewayAddress = lan.status.gateway","gatewayAddress","LAN gateway address presently being used","Details","The value of gatewayAddress is a string that indicates the IP address of the gateway in dotted decimal notation.","Example","print(lan.status.gateway)","Outputs the gateway address, such as:","192.168.0.1","Also see","lan.config.gateway","lan.status.gateway","14912.html");
+Page[204]=new Array("This attribute contains the LAN IP address presently in use by the LAN interface.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not applicable","Not applicable","Usage","ipAddress = lan.status.ipaddress","ipAddress","LAN IP address specified in dotted decimal notation","Details","The IP address is a character string that represents the IP address assigned to the instrument.","Example","print(lan.status.ipaddress)","Outputs the LAN IP address currently in use, such as:","192.168.0.2","Also see","lan.config.ipaddress","lan.status.ipaddress","14913.html");
+Page[205]=new Array("This attribute contains the LAN MAC address.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not applicable","Not applicable","Usage","macAddress = lan.status.macaddress","macAddress","The instrument MAC address","Details","The MAC address is a character string representing the instrument's MAC address in hexadecimal notation. The string includes colons that separate the address octets (see Example).","Example","print(lan.status.macaddress)","Outputs the MAC address of the instrument, for example:","00:60:1A:00:00:57","Also see","None","lan.status.macaddress","14914.html");
+Page[206]=new Array("This attribute contains the LAN dead socket termination port number.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not applicable","Not applicable","Usage","port = lan.status.port.dst","port","Dead socket termination socket port number","Details","This attribute holds the TCP port number used to reset all other LAN socket connections.","To reset all LAN connections, open a connection to the DST port number.","Example","print(lan.status.port.dst)","Outputs the LAN dead socket termination port number, such as:","5.03000e+03","Also see","None","lan.status.port.dst","14915.html");
+Page[207]=new Array("This attribute contains the LAN raw socket connection port number.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not applicable","Not applicable","Usage","port = lan.status.port.rawsocket","port","Raw socket port number","Details","Stores the TCP port number used to connect the instrument and to control the instrument over a raw socket communication interface.","Example","print(lan.status.port.rawsocket)","Outputs the LAN raw socket port number, such as:","5.02500e+03","Also see","None","lan.status.port.rawsocket","14916.html");
+Page[208]=new Array("This attribute contains the LAN Telnet connection port number.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not applicable","Not applicable","Usage","port = lan.status.port.telnet","port","Telnet port number","Details","This attribute holds the TCP port number used to connect to the instrument to control it over a Telnet interface.","Example","print(lan.status.port.telnet)","Get the LAN Telnet connection port number.","Output:","2.30000e+01","Also see","None","lan.status.port.telnet","14917.html");
+Page[209]=new Array("This attribute contains the LAN VXI-11 connection port number.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not applicable","Not applicable","Usage","port = lan.status.port.vxi11","port","LAN VXI-11 port number","Details","This attribute stores the TCP port number used to connect to the instrument over a VXI-11 interface.","Example","print(lan.status.port.vxi11)","Outputs the VXI-11 number, such as:","1.02400e+03","Also see","None","lan.status.port.vxi11","14918.html");
+Page[210]=new Array("This attribute contains the LAN speed.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not applicable","Not applicable","Usage","speed = lan.status.speed","speed","LAN speed in Mbps, either 10 or 100","Details","This attribute indicates the transmission speed currently in use by the LAN interface.","Example","print(lan.status.speed)","Outputs the instrument's transmission speed presently in use, such as:","1.00000e+02","Also see","None","lan.status.speed","14919.html");
+Page[211]=new Array("This attribute contains the LAN subnet mask that is presently in use by the LAN interface.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not applicable","Not applicable","Usage","mask = lan.status.subnetmask","mask","A string specifying the subnet mask in dotted decimal notation","Details","Use this attribute to determine the present operating state of the LAN. This attribute will return the present LAN subnet mask value if the LAN is manually configured, or when DLLA or DHCP is used.","Example","print(lan.status.subnetmask)","Outputs the subnet mask of the instrument that is presently in use, such as:","255.255.255.0","Also see","lan.config.subnetmask","lan.status.subnetmask","14920.html");
+Page[212]=new Array("This attribute contains the LAN timed-wait state interval.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","LAN restore defaults","Nonvolatile memory","20 (20 s)","Usage","timeout = lan.timedwait","lan.timedwait = timeout","timeout","The LAN timed-wait state interval in seconds","Details","This attribute controls the amount of time that resources are allocated to closed TCP connections. When a TCP connection is closed, the connection is put in a timed-wait state and resources remain allocated for the connection until the timed-wait state ends. During the timed-wait interval, the instrument processes delayed packets that arrive after the connection is closed.","Use this attribute to tailor the timed-wait state interval for the instrument.","Also see","lan.restoredefaults()","lan.timedwait","14897.html");
+Page[213]=new Array("This function simulates the occurrence of the trigger and generates the corresponding event ID.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","lan.trigger[N].assert()","N","The LAN event number (1 to 8)","Details","Generates and sends a LAN trigger packet for the LAN event number specified.","Sets the pseudostate to the appropriate state.","The following indexes provide the listed events:","1:LAN0","2:LAN1","3:LAN2","…","8:LAN7","Example","lan.trigger[5].assert()","Creates a trigger with LAN packet 5.","Also see","lan.lxidomain","lan.trigger[N].clear()","lan.trigger[N].mode","lan.trigger[N].overrun","lan.trigger[N].stimulus","lan.trigger[N].wait()","lan.trigger[N].assert()","14921.html");
+Page[214]=new Array("This function clears the event detector for a trigger.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","lan.trigger[N].clear()","N","The LAN event number to clear (1 to 8)","Details","A trigger’s event detector remembers if an event has been detected since the last call. This function clears a trigger’s event detector and discards the previous history of the trigger packet.","This function clears all overruns associated with this LAN trigger.","Example","lan.trigger[5].clear()","Clears the event detector with LAN packet 5.","Also see","lan.trigger[N].assert()","lan.trigger[N].overrun","lan.trigger[N].stimulus","lan.trigger[N].wait()","lan.trigger[N].clear()","14922.html");
+Page[215]=new Array("This function prepares the event generator for outgoing trigger events.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","lan.trigger[N].connect()","N","The LAN event number (1 to 8)","Details","Prepares the event generator to send event messages. For TCP connections, this opens the TCP connection.","The event generator automatically disconnects when either the lan.trigger[N].protocol or lan.trigger[N].ipaddress attributes for this event are changed.","Example","lan.trigger[1].protocol = lan.MULTICAST","lan.trigger[1].connect()","lan.trigger[1].assert()","Set the protocol for LAN trigger 1 to be multicast when sending LAN triggers. Then, after connecting the LAN trigger, send a message on LAN trigger 1 by asserting it.","Also see","lan.trigger[N].assert()","lan.trigger[N].ipaddress","lan.trigger[N].overrun","lan.trigger[N].protocol","lan.trigger[N].stimulus","lan.trigger[N].wait()","lan.trigger[N].connect()","14923.html");
+Page[216]=new Array("This attribute stores the LAN event connection state.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not applicable","Not applicable","Usage","connected = lan.trigger[N].connected","connected","The LAN event connection state:","true: Connected","false: Not connected","N","The LAN event number (1 to 8)","Details","This read-only attribute is set to true when the LAN trigger is connected and ready to send trigger events following a successful lan.trigger[N].connect() command; if the LAN trigger is not ready to send trigger events, this value is false.","This attribute is also false when either lan.trigger[N].protocol or lan.trigger[N].ipaddress attributes are changed or the remote connection closes the connection.","Example","lan.trigger[1].protocol = lan.MULTICAST","print(lan.trigger[1].connected)","Outputs true if connected, or false if not connected.","Example output:","false","Also see","lan.trigger[N].connect()","lan.trigger[N].ipaddress","lan.trigger[N].protocol","lan.trigger[N].connected","14924.html");
+Page[217]=new Array("This function disconnects the LAN trigger.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","lan.trigger[N].disconnect()","N","The LAN event number (1 to 8)","Details","For TCP connections, this closes the TCP connection.","The LAN trigger automatically disconnects when either the lan.trigger[N].protocol or lan.trigger[N].ipaddress attributes for this event are changed.","Also see","lan.trigger[N].ipaddress","lan.trigger[N].protocol","lan.trigger[N].disconnect()","14925.html");
+Page[218]=new Array("This constant is the event identifier used to route the LAN trigger to other subsystems (using stimulus properties).","Type","TSP-Link accessible","Affected by","Where saved","Default value","Constant","Yes","Usage","lan.trigger[N].EVENT_ID","N","The LAN event number (1 to 8)","Details","Set the stimulus of any trigger event detector to the value of this constant to have it respond to incoming LAN trigger packets.","Example","digio.trigger[14].stimulus = lan.trigger[1].EVENT_ID","Route occurrences of triggers on LAN trigger 1 to digital I/O trigger 14.","Also see","None","lan.trigger[N].EVENT_ID","14926.html");
+Page[219]=new Array("This attribute specifies the address (in dotted‑decimal format) of UDP or TCP listeners.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset LAN trigger N reset Recall setup","Not saved ",""0.0.0.0"","Usage","ipAddress = lan.trigger[N].ipaddress","lan.trigger[N].ipaddress = ipAddress","ipAddress","The LAN address for this attribute as a string in dotted decimal notation","N","A number specifying the LAN event number (1 to 8)","Details","Sets the IP address for outgoing trigger events.","Set to "0.0.0.0" for multicast.","After changing this setting, the lan.trigger[N].connect() command must be called before outgoing messages can be sent.","Example","lan.trigger[3].protocol = lan.TCP","lan.trigger[3].ipaddress = "192.168.1.100"","lan.trigger[3].connect()","Set the protocol for LAN trigger 3 to be lan.TCP when sending LAN triggers.","Use IP address "192.168.1.100" to connect the LAN trigger.","Also see","lan.trigger[N].connect()","lan.trigger[N].ipaddress","14927.html");
+Page[220]=new Array("This attribute sets the trigger operation and detection mode.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset LAN trigger N reset Recall setup","Not saved ","0 (lan.TRIG_EITHER)","Usage","mode = lan.trigger[N].mode","lan.trigger[N].mode = mode","mode","A number representing the trigger mode (0 to 7); see the Details section for more information","N","A number representing the LAN event number (1 to 8)","Details","This attribute controls the mode in which the trigger event detector and the output trigger generator operate on the given trigger. These settings are intended to provide behavior similar to the digital I/O triggers.","Lan trigger mode values","mode ","Number","Trigger packets detected as input","LAN trigger packet generated for output with a…","lan.TRIG_EITHER","0","Rising or falling edge (positive or negative state)","negative state","lan.TRIG_FALLING","1","Falling edge (negative state)","negative state","lan.TRIG_RISING","2","Rising edge (positive state)","positive state","lan.TRIG_RISINGA","3","Rising edge (positive state)","positive state","lan.TRIG_RISINGM","4","Rising edge (positive state)","positive state","lan.TRIG_SYNCHRONOUS","5","Falling edge (negative state)","positive state","lan.TRIG_SYNCHRONOUSA","6","Falling edge (negative state)","positive state","lan.TRIG_SYNCHRONOUSM","7","Rising edge (positive state)","negative state","lan.TRIG_RISING and lan.TRIG_RISINGA are the same.","lan.TRIG_RISING and lan.TRIG_RISINGM are the same.","Use of either lan.TRIG_SYNCHRONOUSA or lan.TRIG_SYNCHRONOUSM over lan.TRIG_SYNCHRONOUS is preferred, as lan.TRIG_SYNCHRONOUS is provided for compatibility with other Keithley Instruments products.","Example","print(lan.trigger[1].mode)","Outputs the present LAN trigger mode of LAN event 1.","Also see","Digital I/O","TSP-Link system expansion interface","lan.trigger[N].mode","14928.html");
+Page[221]=new Array("This attribute contains the event detector's overrun status.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","LAN trigger N clear LAN trigger N reset Instrument reset Recall setup","Not applicable","Not applicable","Usage","overrun = lan.trigger[N].overrun","overrun","The trigger overrun state for the specified LAN packet (true or false)","N","A number representing the LAN event number (1 to 8)","Details","This attribute indicates whether an event has been ignored because the event detector was already in the detected state when the event occurred.","This is an indication of the state of the event detector built into the synchronization line itself. It does not indicate if an overrun occurred in any other part of the trigger model, or in any other construct that is monitoring the event.","It also is not an indication of an output trigger overrun. Output trigger overrun indications are provided in the status model.","Example","overrun = lan.trigger[5].overrun","print(overrun)","Checks the overrun status of a trigger on LAN5 and outputs the value, such as:","false","Also see","lan.trigger[N].assert()","lan.trigger[N].clear()","lan.trigger[N].stimulus","lan.trigger[N].wait()","lan.trigger[N].overrun","14929.html");
+Page[222]=new Array("This attribute sets the LAN protocol to use for sending trigger messages.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset LAN trigger N reset Recall setup","Not saved ","0 (lan.TCP)","Usage","protocol = lan.trigger[N].protocol","lan.trigger[N].protocol = protocol","protocol","The protocol to use for the trigger's messages:","0 or lan.TCP","1 or lan.UDP","2 or lan.MULTICAST","N","A number representing the LAN event number (1 to 8)","Details","The LAN trigger listens for trigger messages from all supported protocols, protocol but uses the designated protocol for sending outgoing messages. After changing this setting, lan.trigger[N].connect() must be called before outgoing event messages can be sent.","When the lan.MULTICAST protocol is selected, the lan.trigger[N].ipaddress attribute is ignored and event messages are sent to the multicast address 224.0.23.159.","Example","print(lan.trigger[1].protocol)","Get LAN protocol to use for sending trigger messages for LAN event 1.","Also see","lan.trigger[N].ipaddress","lan.trigger[N].connect()","lan.trigger[N].protocol","14930.html");
+Page[223]=new Array("This attribute sets the simulated line state for the LAN trigger.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset LAN trigger N reset Recall setup","Not saved ","1","Usage","pseudostate = lan.trigger[N].pseudostate","lan.trigger[N].pseudostate = pseudostate","pseudostate","The simulated line state (0 or 1)","N","A number representing the LAN event number (1 to 8)","Details","This attribute can be set to initialize the pseudo state to a known value.","Setting this attribute will not cause the LAN trigger to generate any events or output packets.","Example","print(lan.trigger[1].pseudostate)","Get the present simulated line state for the LAN event 1.","Also see","None","lan.trigger[N].pseudostate","14931.html");
+Page[224]=new Array("This attribute specifies events that cause this trigger to assert.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset LAN trigger N reset Recall setup","Not saved","0","Usage","triggerStimulus = lan.trigger[N].stimulus","lan.trigger[N].stimulus = triggerStimulus","triggerStimulus","The LAN event identifier used to trigger the event.","N","A number specifying the trigger packet over the LAN for which to set or query the trigger source (1 to 8).","Details","This attribute specifies which event causes a LAN trigger packet to be sent for this trigger. Set triggerStimulus to one of the existing trigger event IDs shown in the following table.","Trigger event IDs*","Event ID","Event description","smua.trigger.SWEEPING_EVENT_ID","Occurs when the source‑measure unit (SMU) transitions from the idle state to the arm layer of the trigger model","smua.trigger.ARMED_EVENT_ID","Occurs when the SMU moves from the arm layer to the trigger layer of the trigger model","smua.trigger.SOURCE_COMPLETE_EVENT_ID","Occurs when the SMU completes a source action","smua.trigger.MEASURE_COMPLETE_EVENT_ID","Occurs when the SMU completes a measure action","smua.trigger.PULSE_COMPLETE_EVENT_ID","Occurs when the SMU completes a pulse","smua.trigger.SWEEP_COMPLETE_EVENT_ID","Occurs when the SMU completes a sweep","smua.trigger.IDLE_EVENT_ID","Occurs when the SMU returns to the idle state","digio.trigger[N].EVENT_ID","Occurs when an edge is detected on a digital I/O line","tsplink.trigger[N].EVENT_ID","Occurs when an edge is detected on a TSP‑Link line","lan.trigger[N].EVENT_ID","Occurs when the appropriate LXI trigger packet is received on LAN trigger object N","display.trigger.EVENT_ID","Occurs when the TRIG key on the front panel is pressed","trigger.EVENT_ID","Occurs when a *TRG command is received on the remote interface","(GPIB only) Occurs when a GET bus command is received","(VXI-11 only) Occurs with the VXI-11 command device_trigger; reference the VXI-11 standard for additional details on the device trigger operation","trigger.blender[N].EVENT_ID","Occurs after a collection of events is detected","trigger.timer[N].EVENT_ID","Occurs when a delay expires","* Use the name of the trigger event ID to set the stimulus value rather than the numeric value. Using the name makes the code compatible for future upgrades (for example, if the numeric values must change when enhancements are added to the instrument).","Setting this attribute to zero disables automatic trigger generation.","If any events are detected prior to calling lan.trigger[N].connect(), the event is ignored and the action overrun is set.","Example","lan.trigger[5].stimulus = trigger.timer[1].EVENT_ID","Use timer 1 trigger event as the source for LAN packet 5 trigger stimulus.","Also see","lan.trigger[N].assert()","lan.trigger[N].clear()","lan.trigger[N].connect()","lan.trigger[N].overrun","lan.trigger[N].wait()","lan.trigger[N].stimulus","17679.html");
+Page[225]=new Array("This function waits for an input trigger.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","triggered = lan.trigger[N].wait(timeout)","triggered","Trigger detection indication","N","The trigger packet over LAN to wait for (1 to 8)","timeout","Maximum amount of time in seconds to wait for the trigger event","Details","If one or more trigger events have been detected since the last time lan.trigger[N].wait() or lan.trigger[N].clear() was called, this function returns immediately.","After waiting for a LAN trigger event with this function, the event detector is automatically reset and rearmed regardless of the number of events detected.","Example","triggered = lan.trigger[5].wait(3)","Wait for a trigger with LAN packet 5 with a timeout of 3 seconds.","Also see","lan.trigger[N].assert()","lan.trigger[N].clear()","lan.trigger[N].overrun","lan.trigger[N].stimulus","lan.trigger[N].wait()","14933.html");
+Page[226]=new Array("This attribute enables or disables automatic power line frequency detection at start‑up.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Not applicable","Nonvolatile memory","true (enabled)","Usage","flag = localnode.autolinefreq","localnode.autolinefreq = flag","flag","The auto line frequency detection setting: true or false","Details","Set flag to one of the following values:","true: Enable automatic line frequency detection at start-up.","false: Disable automatic line frequency detection at start-up.","When this attribute is set to true, the power line frequency is detected automatically the next time the Model 2651A powers up. After the power line frequency is automatically detected at power-up, the localnode.linefreq attribute will be set automatically to 50 or 60.","If the localnode.linefreq attribute is explicitly set, localnode.autolinefreq will be automatically set to false.","When using this command from a remote node, localnode should be replaced with the node reference, for example node[5].autolinefreq.","Also see","localnode.linefreq","localnode.autolinefreq","15007.html");
+Page[227]=new Array("This attribute stores a user-defined description of the instrument.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Not applicable","Nonvolatile memory","Instrument specific (see Details)","Usage","localnode.description = description","description = localnode.description","description","User-defined description of the instrument","Details","This attribute stores a string that contains a description of the instrument. This value appears on instrument's LXI home page.","This attribute's default value contains Keithley ModelNumber #SSSSSSSS, where: ModelNumber is the instrument's model number, and #SSSSSSSS is the instrument's eight-digit serial number. You can change it to a value that makes sense for your system.","When using this command from a remote node, localnode should be replaced with the node reference, for example node[5].description.","Example","description = "System in Lab 05"","localnode.description = description","Set description equal to "System in Lab 05".","Set the LXI home page of this instrument to display "System in Lab 05".","Also see","None","localnode.description","15008.html");
+Page[228]=new Array("This attribute contains the power line frequency setting used for NPLC calculations.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Not applicable","Nonvolatile memory","60 (60 Hz)","Usage","frequency = localnode.linefreq","localnode.linefreq = frequency","frequency","An integer representing the instrument's detected or specified line frequency","Details","To achieve optimum noise rejection when performing measurements at integer NPLC apertures, set the line frequency attribute to match the frequency (50 Hz or 60 Hz) of the AC power line. ","When using this command from a remote node, localnode should be replaced with the node reference, for example node[5].linefreq.","When this attribute is set, the localnode.autolinefreq attribute is automatically set to false. You can have the instrument automatically detect the AC power line frequency and set this attribute with the line frequency detected when the instrument power is turned on by setting the localnode.autolinefreq attribute to true.","Example 1","frequency = localnode.linefreq","Reads line frequency setting.","Example 2","localnode.linefreq = 60","Sets the line frequency to 60 Hz.","Also see","localnode.autolinefreq","localnode.linefreq","15012.html");
+Page[229]=new Array("This attribute stores the model number.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not applicable","Not applicable","Usage","model = localnode.model","model","The model number of the instrument","Details","When using this command from a remote node, localnode should be replaced with the node reference, for example node[5].model.","Example","print(localnode.model)","Outputs the model number.","Also see","localnode.description","localnode.revision","localnode.serialno","localnode.model","15013.html");
+Page[230]=new Array("This attribute stores the remote access password.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (W)","Yes","LAN reset LAN restore defaults","Nonvolatile memory","""","Usage","localnode.password = passWord","passWord","String containing the remote interface password","Details","This write-only attribute stores the password that is set for any remote interface. When password usage is enabled (localnode.passwordmode), you must supply this password to change the configuration or to control an instrument from a web page or other remote command interface.","The instrument continues to use the old password for all interactions until the command to change it executes. When changing the password, give the instrument time to execute the command before attempting to use the new password.","You cannot retrieve a lost password from any command interface.","The password can be reset by resetting the LAN from the front panel or by using the lan.reset() command.","When using this command from a remote node, localnode should be replaced with the node reference, for example node[5].password.","Example","localnode.password = "N3wpa55w0rd"","Changes the remote interface password to N3wpa55w0rd.","Also see","lan.reset()","localnode.passwordmode","localnode.password","15014.html");
+Page[231]=new Array("This attribute stores the remote access password enable mode.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Not applicable","Nonvolatile memory","1 (localnode.PASSWORD_WEB)","Usage","mode = localnode.passwordmode","localnode.passwordmode = mode","mode","The remote password enable mode","Details","This attribute controls if and where remote access passwords are required. Set this attribute to one of the values below to enable password checking:","localnode.PASSWORD_NONE or 0: Disable passwords everywhere","localnode.PASSWORD_WEB or 1: Use passwords on the web interface only","localnode.PASSWORD_LAN or 2: Use passwords on the web interface and all LAN interfaces","localnode.PASSWORD_ALL or 3: Use passwords on the web interface and all remote command interfaces","When using this command from a remote node, localnode should be replaced with the node reference, for example node[5].passwordmode.","Example","mode = localnode.PASSWORD_WEB","localnode.passwordmode = mode","Sets value of mode to PASSWORD_WEB.","Allows use of passwords on the web interface only.","Also see","localnode.password","localnode.passwordmode","15015.html");
+Page[232]=new Array("This attribute sets and reads the local node prompting state (enabled or disabled).","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Power cycle","Not saved","0 (disabled)","Usage","prompting = localnode.prompts","localnode.prompts = prompting","prompting","Prompting state (0 to disable or 1 to enable)","Details","The command messages do not generate prompts. The instrument generates prompts in response to command messages.","When the prompting mode is enabled (set to 1), the instrument generates prompts in response to command messages. There are three prompts that might be generated:","TSP> is the standard prompt. This prompt indicates that everything is normal and the command is done processing.","TSP? is issued if there are entries in the error queue when the prompt is issued. Like the TSP> prompt, it indicates the command is done processing. It does not mean the previous command generated an error, only that there are still errors in the queue when the command was done processing.",">>>> is the continuation prompt. This prompt is used when downloading scripts. When downloading scripts, many command messages must be sent as a group. The continuation prompt indicates that the instrument is expecting more messages as part of the current command.","When using this command from a remote node, localnode should be replaced with the node reference, for example, node[5].prompts.","@ Do not disable prompting when using Test Script Builder. Test Script Builder requires prompts and sets the prompting mode behind the scenes. If you disable prompting, using Test Script Builder causes the instrument to stop responding because it is waiting for the prompt that lets it know that the command is done executing.","Example","localnode.prompts = 1","Enable prompting.","Also see","localnode.showerrors","localnode.prompts4882","localnode.prompts","15016.html");
+Page[233]=new Array("This attribute enables and disables the generation of prompts for IEEE Std 488.2 common commands.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Power cycle","Not saved","1 (enabled)","Usage","prompting = localnode.prompts4882","localnode.prompts4882 = prompting","prompting","IEEE Std 488.2 prompting mode","Details","When set to 1, the IEEE Std 488.2 common commands generate prompts if prompting is enabled with the localnode.prompts attribute. If set to 1, limit the number of *trg commands sent to a running script to 50 regardless of the setting of the localnode.prompts attribute.","When set to 0, IEEE Std 488.2 common commands will not generate prompts. When using the *trg command with a script that executes trigger.wait() repeatedly, set localnode.prompts4882 to 0 to avoid problems associated with the command interface input queue filling.","This attribute resets to the default value each time the instrument power is cycled.","When using this command from a remote node, localnode should be replaced with the node reference, for example node[5].prompts4882.","Example","localnode.prompts4882 = 0","Disables IEEE Std 488.2 common command prompting.","Also see","localnode.prompts","localnode.prompts4882","15017.html");
+Page[234]=new Array("This function resets the local node instrument.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","localnode.reset()","Details","If you want to reset a specific instrument or a subordinate node, use the node[X].reset() command.","A local node reset includes:","Source‑measure unit (SMU) attributes affected by a SMU reset are reset","Other settings are restored back to factory default settings","A localnode.reset() is different than a reset() because reset() resets the entire system. ","When using this command from a remote node, localnode should be replaced with the node reference, for example node[5].reset().","Example","localnode.reset()","Resets the local node.","Also see","reset()","smuX.reset()","localnode.reset()","16978.html");
+Page[235]=new Array("This attribute stores the firmware revision level.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not applicable","Not applicable","Usage","revision = localnode.revision","revision","Firmware revision level","Details","This attribute indicates the firmware revision number currently running in the instrument.","When using this command from a remote node, localnode should be replaced with the node reference, for example node[5].revision.","Example","print(localnode.revision)","Outputs the present revision level. Sample output:","1.0.0","Also see","localnode.description","localnode.model","localnode.serialno","localnode.revision","15018.html");
+Page[236]=new Array("This attribute stores the instrument's serial number.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not applicable","Not applicable","Usage","serialno = localnode.serialno","serialno","The serial number of the instrument","Details","This read-only attribute indicates the instrument serial number.","When using this command from a remote node, localnode should be replaced with the node reference, for example node[5].serialno.","Example","display.clear()","display.settext(localnode.serialno)","Clears the unit's display.","Places the unit's serial number on the top line of its display.","Also see","localnode.description","localnode.model","localnode.revision","localnode.serialno","15019.html");
+Page[237]=new Array("This attribute sets whether or not the instrument automatically sends generated errors.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Power cycle","Not saved","0 (disabled)","Usage","errorMode = localnode.showerrors","localnode.showerrors = errorMode","errorMode","Enables (1) or disables (0) the show errors state","Details","If this attribute is set to 1, the instrument automatically sends any generated errors stored in the error queue, and then clears the queue. Errors are processed after executing a command message (just before issuing a prompt, if prompts are enabled).","If this attribute is set to 0, errors are left in the error queue and must be explicitly read or cleared.","When using this command from a remote node, localnode should be replaced with the node reference, for example, node[5].showerrors.","Example","localnode.showerrors = 1","Enables sending of generated errors.","Also see","localnode.prompts","localnode.showerrors","15022.html");
+Page[238]=new Array("This function creates a function to get the value of an attribute.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","getter = makegetter(table, attributeName)","getter","The return value","table","Read‑only table where the attribute is located","attributeName","A string representing the name of the attribute","Details","This function is useful for aliasing attributes to improve execution speed. Calling the function created with makegetter() executes faster than accessing the attribute directly.","Creating a getter function is only useful if it is going to be called several times. Otherwise, the overhead of creating the getter function outweighs the overhead of accessing the attribute directly.","Example","getlevel = makegetter(smua.source, "levelv")","v = getlevel()","Creates a getter function called getlevel.","When getlevel() is called, it returns the value of smua.source.levelv. "," ","Also see","makesetter()","makegetter()","15041.html");
+Page[239]=new Array("This function creates a function that, when called, sets the value of an attribute.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","setter = makesetter(table, attributeName)","setter","Function that sets the value of the attribute","table","Read-only table where the attribute is located","attributeName","The string name of the attribute","Details","This function is useful for aliasing attributes to improve execution speed. Calling the setter function will execute faster than accessing the attribute directly.","Creating a setter function is only useful if it is going to be called several times. If you are not calling the setter function several times, it is more efficient to access the attribute directly. ","Example","setlevel = makesetter(smua.source, "levelv")","for v = 1, 10 do"," setlevel(v)","end","Creates a setter function called setlevel.","Using setlevel() in the loop sets the value of smua.source.levelv, ","performing a source sweep.","Also see","makegetter()","makesetter()","15042.html");
+Page[240]=new Array("This function returns the current amount of available memory and the total amount of memory in the instrument.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","freeMem, totalMem = meminfo()","freeMem","The amount of free dynamically allocated memory available","totalMem","The total amount of dynamically allocated memory in the instrument","Details","This function returns two values:","The amount of free dynamically allocated memory available in kilobytes","The total amount of dynamically allocated memory on the instrument in kilobytes","The difference between the two values is the amount currently used.","Also see","None","meminfo()","15050.html");
+Page[241]=new Array("This function starts test scripts from a remote node.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes (see Details)","Usage","node[N].execute(scriptCode)","N","The node number of this instrument","scriptCode","A string containing the source code","Details","Only the remote master node can use the execute command to run a script on this node. This function does not run test scripts on the master node, only on this node when initiated by the master node.","This function may only be called when the group number of the node is different than the node of the master.","This function will not wait for the script to finish execution.","This function cannot be used from the local node. This command should only be used from a remote master when controlling this instrument over a TSP-link®.","Example 1","node[2].execute(sourcecode)","Runs script code on node 2. The code is in a string variable called sourcecode.","Example 2","node[3].execute("x = 5")","Runs script code in string constant ("x = 5") to set x","equal to 5 on node 3.","Example 3","node[32].execute(TestDut.source)","Runs the test script stored in the variable TestDut","(previously stored on the master node) on node 32.","Also see","tsplink.group","TSP advanced features","node[N].execute()","15009.html");
+Page[242]=new Array("This function returns the value of a global variable.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes (see Details)","Usage","value = node[N].getglobal(name)","value","The value of the variable","N","The node number of this instrument","name","The global variable name","Details","Use this function to have the remote master node retrieve the value of a global variable from this node's run-time environment.","Do not use this command to retrieve the value of a global variable from the local node (access the global variable directly). This command should only be used from a remote master when controlling this instrument over a TSP-link®.","Example","print(node[5].getglobal("test_val"))","Retrieves and outputs the value of the global variable named test_val from node 5.","Also see","TSP advanced features","node[N].setglobal()","node[N].getglobal()","15010.html");
+Page[243]=new Array("This function sets the value of a global variable.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes (see Details)","Usage","node[N].setglobal(name, value)","N","The node number of this instrument","name","The global variable name to set","value","The value to assign to the variable","Details","From a remote node, use this function to assign the given value to a global variable.","Do not use this command to create or set the value of a global variable from the local node (set the global variable directly instead). This command should only be used from a remote master when controlling this instrument over a TSP-link®.","Example","node[3].setglobal("x", 5)","Sets the global variable x on node 3 to the value of 5.","Also see","TSP advanced features","node[N].getglobal()","node[N].setglobal()","15020.html");
+Page[244]=new Array("This function sets the operation complete status bit when all overlapped commands are completed.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","opc()","Details","This function causes the operation complete bit in the Standard Event Status Register to be set when all previously started local overlapped commands are complete. ","Note that each node independently sets its operation complete bits in its own status model. Any nodes not actively performing overlapped commands will set their bits immediately. All remaining nodes will set their own bits as they complete their own overlapped commands.","Also see","waitcomplete()","Status model","opc()","15054.html");
+Page[245]=new Array("This function generates a response message.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","print(value1)","print(value1, value2)","print(value1, ..., valueN)","value1","The first argument to output","value2","The second argument to output","valueN","The last argument to output","...","One or more values separated with commas","Details","TSP-enabled instruments do not have inherent query commands. Like any other scripting environment, the print() command and other related print() commands generate output. The print() command creates one response message.","The output from multiple arguments are separated with a tab character.","Numbers are printed using the format.asciiprecision attribute. If you want use Lua formatting, print the return value from the tostring() function.","Example 1","x = 10","print(x)","Example of an output response message:","1.00000e+01","Note that your output might be different if you set your ASCII precision setting to a different value.","Example 2","x = 10","print(tostring(x))","Example of an output response message:","10","Also see","format.asciiprecision","print()","17645.html");
+Page[246]=new Array("This function prints data from tables or reading buffer subtables.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","printbuffer(startIndex, endIndex, buffer1)","printbuffer(startIndex, endIndex, buffer1, buffer2)","printbuffer(startIndex, endIndex, buffer1, ..., bufferN)","startIndex","Beginning index of the buffer to print","endIndex","Ending index of the buffer to print","buffer1","First table or reading buffer subtable to print","buffer2","Second table or reading buffer subtable to print","bufferN","The last table or reading buffer subtable to print","...","One or more tables or reading buffer subtables separated with commas","Details","The correct usage of this function for a buffer containing n elements is:","1 ≤ startIndex ≤ endIndex ≤ n","Where n refers to the index of the last entry in the tables to be printed.","If endIndex < startIndex or n < startIndex, no data is printed. If startIndex ≤ 1, 1 is used as startIndex. If n < endIndex, n is used as endIndex.","When any given reading buffers are used in overlapped commands that have not yet completed (at least to the desired index), this function outputs data as it becomes available.","When there are outstanding overlapped commands to acquire data, n refers to the index that the last entry in the table will have after all the measurements have completed.","If you pass a reading buffer instead of a reading buffer subtable, the default subtable for that reading buffer will be used.","This command generates a single response message that contains all data. The response message is stored in the output queue.","The format.data attribute controls the format of the response message.","Example","format.data = format.ASCII","format.asciiprecision = 6","printbuffer(1, rb1.n, rb1)","This assumes that rb1 is a valid reading buffer in the run-time environment. The use of rb1.n (bufferVar.n) indicates that the instrument should output all readings in the reading buffer. In this example, rb1.n equals 10.","Example of output data (rb1.readings):","4.07205e-05, 4.10966e-05, 4.06867e-05, 4.08865e-05, 4.08220e-05, 4.08988e-05, 4.08250e-05, 4.09741e-05, 4.07174e-05, 4.07881e-05","Also see","bufferVar.n","format.asciiprecision","format.byteorder","format.data","print()","printnumber()","printbuffer()","15057.html");
+Page[247]=new Array("This function prints numbers using the configured format.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","printnumber(value1)","printnumber(value1, value2)","printnumber(value1, ..., valueN)","value1","First value to print in the configured format","value2","Second value to print in the configured format","valueN","Last value to print in the configured format","...","One or more values separated with commas","Details","There are multiple ways to use this function, depending on how many numbers are to be printed.","This function prints the given numbers using the data format specified by format.data and format.asciiprecision.","Example","format.asciiprecision = 10","x = 2.54","printnumber(x)","format.asciiprecision = 3","printnumber(x, 2.54321, 3.1)","Configure the ASCII precision to 10 and set x to 2.54.","Read the value of x based on these settings.","Change the ASCII precision to 3.","View how the change affects the output of x and some numbers.","Output:","2.540000000e+00","2.54e+00, 2.54e+00, 3.10e+00","Also see","format.asciiprecision","format.byteorder","format.data","print()","printbuffer()","printnumber()","15058.html");
+Page[248]=new Array("This KIPulse factory script function performs a specified number of pulse I, measure V cycles.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","PulseIMeasureV(smu, bias, level, ton, toff, points)","smu","System SourceMeter® instrument channel (set to smua)","bias","Bias level in amperes","level","Pulse level in amperes","ton","Pulse on time in seconds","toff","Pulse off time in seconds","points","Number of pulse-measure cycles","Details","Data for pulsed voltage measurements, current levels, and timestamps are stored in smua.nvbuffer1.","If any parameters are omitted or nil, the operator will be prompted to enter them using the front panel.","To perform the specified number of pulse I, measure V cycles, this function:","1. Sets the smu to output bias amperes and dwell for toff seconds.","2. Sets the smu to output level amperes and dwell for ton seconds.","3. Performs voltage measurement with source at level amperes.","4. Sets the smu to output bias amperes for toff seconds.","5. Repeats steps 2 through 4 for all remaining points pulse-measure cycles.","Example","PulseIMeasureV(smua, 0.001, 1.0,"," 20e-3, 40e-3, 10)","SMU A will output 1 mA and dwell for 40 ms, output 1 A and dwell for 20 ms. The voltage measurements occur during each 20 ms dwell period. After the measurement, the output will return to 1 mA and dwell for 40 ms. This pulse‑measure process will repeat nine more times.","Also see","None","PulseIMeasureV()","12918.html");
+Page[249]=new Array("This KIPulse factory script function performs a specified number of pulse V, measure I cycles.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","PulseVMeasureI(smu, bias, level, ton, toff, points)","smu","System SourceMeter® instrument channel (set to smua)","bias","Bias level in volts","level","Pulse level in volts","ton","Pulse on time in seconds","toff","Pulse off time in seconds","points","Number of pulse-measure cycles","Details","If any parameters are omitted or nil, the operator will be prompted to enter them using the front panel. Data for pulsed current measurements, voltage levels, and timestamps are stored in smuX.nvbuffer1.","To perform the specified number of pulse V, measure I cycles, this function:","Sets the smu to output bias volts and dwell for toff seconds","Sets the smu to output level volts and dwell for ton seconds","Performs voltage measurement with source at level volts","Sets the smu to output bias volts for toff seconds","Repeats steps 2 through 4 for the remaining points pulse-measure cycles","Example 1","smua.measure.nplc = 0.001","PulseVMeasureI(smua, -1, 1, 1E-3, 2E-3, 20)","SMU A will output -1 V and dwell for 2 ms, output 1 V and dwell for 1 ms. The current measurement occurs during the dwell period. After the measurement, the output will return to -1 V and dwell for 2 ms. This pulse-measure process will repeat 19 more times.","Also see","None","PulseVMeasureI()","12923.html");
+Page[250]=new Array("This KIPulse factory script function allows you to inspect the settings of the preconfigured pulse train assigned to tag.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","tbl = QueryPulseConfig(tag)","tag","Numeric identifier to be assigned to the defined pulse train","tbl","Returned table","Details","Once a pulse train has been configured and assigned to a tag, it is often desirable to inspect the settings of this preconfigured pulse train. The QueryPulseConfig() command can be used for this purpose. ","This function will return a table containing the various settings associated with the tag input parameter.","Return values:","tostring()","A function that returns most elements in a string convenient for printing","tag","Identifying tag for this pulse train","smu","The SMU configured for pulsing","func","Pulse function: ","smua.OUTPUT_DCAMPS or ","smua.OUTPUT_DCVOLTS","bias","Pulse bias level","level","Pulse level for non sweeping pulses","start","Starting level for sweep pulses","stop","Ending level for sweep pulses","limit","Limit value","ton","On time in seconds","toff","Off time in seconds","points","The number of points in this pulse train","buf","Reference to buffer containing measurement data","sync_in","The sync_in digio line, if used","sync_out","The sync_out digio line, if used","sourcevalues","A table containing the source value for each point in the pulse train","Example","smua.reset()","smua.source.rangev = 5","smua.source.rangei = 1","smua.source.levelv = 0","smua.measure.rangev = 5","smua.measure.rangei = 1","smua.measure.nplc = 0.01","smua.measure.autozero = smua.AUTOZERO_ONCE","smua.nvbuffer1.clear()","smua.nvbuffer1.appendmode = 1","smua.source.output = smua.OUTPUT_ON","f1, msg1 = ConfigPulseVMeasureI(smua, 0, 5,"," 1, 0.002, 0.2, 10, smua.nvbuffer1, 1)","print(QueryPulseConfig(1).tostring())","Configure channel A to generate a pulse train, query configuration, and then display as a string. Channel A will pulse voltage from a bias level of 0 V to a pulse level of 5 V. The pulse level will be present for 2 ms, and the bias level for 200 ms with a 1 A limit setting. A total of 10 pulses will be generated, and the measurement data will be stored in smua.nvbuffer1. This pulse train will be assigned to tag = 1.","Output:",">> tag = 1",">> smu = smua",">> func = volts",">> type = pulse",">> bias = 0",">> level = 5",">> limit = 1",">> time on = 0.002",">> time off = 0.2",">> points = 10",">> measure = yes",">> sync_in = 0",">> sync_out = 0",">> sync_in_timeout = 0",">> sync_out_abort = 0",">> { 5, 5, 5, 5, 5, 5, 5, 5, 5, 5 }","Also see","ConfigPulseIMeasureV()","ConfigPulseVMeasureI()","ConfigPulseIMeasureVSweepLin()","ConfigPulseVMeasureISweepLin()","ConfigPulseIMeasureVSweepLog()","ConfigPulseVMeasureISweepLog()","QueryPulseConfig()","12949.html");
+Page[251]=new Array("This function resets commands to their default settings.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","reset()","reset(system)","system","true: If the node is the master, the entire system is reset","false: Only the local group is reset","Details","The reset() command in its simplest form resets the entire TSP‑enabled system, including the controlling node and all subordinate nodes.","If you want to reset a specific instrument, use either the localnode.reset() or node[X].reset() command. The localnode.reset() command is used for the local instrument. The node[X].reset() command is used to reset an instrument on a subordinate node.","When no value is specified for system, the default value is true.","Resetting the entire system using reset(true) is permitted only if the node is the master. If the node is not the master node, executing this command generates an error.","Example","reset(true)","If the node is the master node, the entire system is reset; if the node is not the master node, an error is generated.","Also see","localnode.reset()","reset()","13933.html");
+Page[252]=new Array("This KISavebuffer factory script function saves reading buffers as either a .CSV file or an .XML file.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","savebuffer(buffer, formatType, fileName)","buffer","The reading buffer to save","formatType","A string indicating which file type to use: .csv or .xml","fileName","The file name of the saved buffer","Details","Use this function to save the specified buffer to a USB flash drive.","This function will only save to a USB flash drive. ","You are not required to qualify the path to the USB flash drive, but if you wish to, add /usb1/ before the fileName (see Example 2).","Example 1","savebuffer(smua.nvbuffer1, "csv","," "mybuffer.csv") ","Save smua dedicated reading buffer 1 as a .CSV file named mybuffer.csv.","Example 2","savebuffer(smua.nvbuffer1, "csv","," "/usb1/mybuffer.csv") ","Save smua dedicated reading buffer 1 to an installed USB flash drive as a .CSV file named mybuffer.csv.","Also see","smuX.savebuffer()","savebuffer()","12959.html");
+Page[253]=new Array("This is a reference to the anonymous script.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","No","See Details","See Details","Not applicable","Usage","scriptVar = script.anonymous","scriptVar","The name of the variable that references the script","Details","You can use the script.anonymous script like any other script. Also, you can save the anonymous script as a user script by giving it a name.","This script is replaced by loading a script with the loadscript or loadandrunscript commands when they are used without a name. ","Example 1","script.anonymous.list()","Displays the content of the anonymous script.","Example 2","print(script.anonymous.source)","Retrieves the source of the anonymous script.","Also see","Anonymous scripts","scriptVar.autorun","scriptVar.list()","scriptVar.name","scriptVar.run()","scriptVar.save()","scriptVar.source","script.anonymous","17040.html");
+Page[254]=new Array("This function deletes a script from nonvolatile memory.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","script.delete(scriptName)","scriptName","The string that represents the name of the script","Example","script.delete("test8")","Deletes a user script named "test8" from nonvolatile memory.","Also see","Delete user scripts","Delete user scripts from the instrument","scriptVar.save()","script.delete()","16853.html");
+Page[255]=new Array("This function returns an iterator that can be used in a for loop to iterate over all the factory scripts.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","for name in script.factory.catalog() do body end","name","String representing the name of the script","body","Code that implements the body of the for loop to process the names in the catalog","Details","Accessing this catalog of scripts allows you to process the factory scripts. The entries will be enumerated in no particular order.","Each time the body of the function executes, name takes on the name of one of the factory scripts. The for loop repeats until all scripts have been iterated.","Example","for name in script.factory.catalog() do"," print(name)","end","Retrieve the catalog listing for factory scripts.","Also see","None","script.factory.catalog()","19931.html");
+Page[256]=new Array("This function creates a script from a specified file.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","scriptVar = script.load(file)","scriptVar = script.load(file, name)","scriptVar","The created script. This is nil if an error is encountered","file","The path and file name of the script file to load","name","The name of the script to be created","Details","The file path may be absolute or relative to the current working directory. The root folder of the USB flash drive has the absolute path "/usb1/". Both the forward slash (/) and backslash (\\) are supported as directory separators.","The file to be loaded must start with the loadscript or loadandrunscript keywords, contain the body of the script, and end with the endscript keyword.","Script naming:","If the name parameter is an empty string, or name is absent (or nil) and the script name cannot be extracted from the file, scriptVar is the only handle to the created script.","If name is given (and not nil), any script name embedded in the file is ignored.","If name conflicts with the name of an existing script in the script.user.scripts table, the existing script’s name attribute is set to an empty string before it is replaced in the script.user.scripts table by the new script.","If name is absent or nil, the command attempts to extract the name of the script from the file. Any conflict between the extracted name and that of an existing script in the scripts table generates an error. If the script name cannot be extracted, the created script's name attribute is initialized to the empty string, and must be set to a valid nonempty string before saving the script to nonvolatile memory.","Example","myTest8 = script.load("/usb1/filename.tsp", "myTest8")","Loads the script myTest8 from the USB flash drive.","Also see","script.new()","script.load()","15063.html");
+Page[257]=new Array("This function creates a script.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","scriptVar = script.new(code)","scriptVar = script.new(code, name)","scriptVar","The name of the variable that will reference the script","code","A string containing the body of the script","name","The name of the script","Details","The name parameter is the name that is added to the script.user.scripts table. If name is not given, an empty string will be used, and the script will be unnamed. If the name already exists in script.user.scripts, the existing script's name attribute is set to an empty string before it is replaced by the new script.","Note that name is the value that is used for the instrument front panel display. If this value is not defined, the script will not be available from the instrument front panel. ","You must save the new script into nonvolatile memory to keep it when the instrument is turned off.","Example 1","myTest8 = script.new("," "display.clear() display.settext('Hello from myTest8')", "myTest8")","myTest8()","Creates a new script referenced by the variable myTest8 with the name "myTest8".","Runs the script. The instrument displays "Hello from myTest8".","Example 2","autoexec = script.new("," "display.clear() display.settext('Hello from autoexec')", 'autoexec')","Creates a new autoexec script that clears the display when the instrument is turned on and displays "Hello from autoexec".","Also see","Create a script using the script.new() command","Global variables and the script.user.scripts table","Named scripts","scriptVar.save()","script.newautorun()","script.new()","15064.html");
+Page[258]=new Array("This function is identical to the script.new() function, but it creates a script with the autorun attribute set to "yes".","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","scriptVar = script.newautorun(code)","scriptVar = script.newautorun(code, name)","scriptVar","The name of the variable that will reference the script","code","A string containing the body of the script","name","The name of the script","Details","The script.newautorun() function is identical to the script.new()function, except that the autorun attribute of the script is set to yes. The script is also automatically run immediately after it is created.","Example","NewAuto = script.newautorun("print('Hello from new auto run command')", 'NewAuto')","print(NewAuto.autorun)","print(NewAuto.name)","Creates a new script called NewAuto that automatically has the autorun attribute set to yes after it is created. The name attribute's value is set to "NewAuto".","Output:","Hello from new auto run command","yes","NewAuto","Also see","Create a script using the script.new() command","Global variables and the script.user.scripts table","Named scripts","scriptVar.save()","script.new()","script.newautorun()","18832.html");
+Page[259]=new Array("This function restores a script that was removed from the run-time environment.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","script.restore(name)","name","The name of the script to be restored","Details","This command copies the script from nonvolatile memory back into the run-time environment, and it creates a global variable with the same name as the name of the script.","Example","script.restore("test9")","Restores a script named "test9" from nonvolatile memory.","Also see","script.delete()","script.restore()","16851.html");
+Page[260]=new Array("This function runs the anonymous script.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","script.run()","run()","Details","Each time the script.run() command is given, the anonymous script is executed. This script can be run using this command many times without having to re-send it. ","Example","run()","Runs the anonymous script.","Also see","script.anonymous","script.run()","18833.html");
+Page[261]=new Array("This function returns an iterator that can be used in a for loop to iterate over all the scripts stored in nonvolatile memory.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","for name in script.user.catalog() do body end","name","String representing the name of the script","body","Code that implements the body of the for loop to process the names in the catalog","Details","Accessing the catalog of scripts stored in nonvolatile memory allows you to process all scripts in nonvolatile memory. The entries will be enumerated in no particular order.","Each time the body of the function executes, name takes on the name of one of the scripts stored in nonvolatile memory. The for loop repeats until all scripts have been iterated.","Example","for name in script.user.catalog() do"," print(name)","end","Retrieve the catalog listing for user scripts.","Also see","None","script.user.catalog()","16862.html");
+Page[262]=new Array("This attribute controls the autorun state of a script.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","No","Not applicable","See Details","See Details","Usage","scriptVar.autorun = state","state = scriptVar.autorun","scriptVar","The name of the variable that references the script","state","Whether or not the script runs automatically when powered on:",""yes" (script runs automatically)",""no" (script does not run automatically)","Details","Autorun scripts run automatically when the instrument is turned on. You can set any number of scripts to autorun.","The run order for autorun scripts is arbitrary, so make sure the run order is not important.","The default value for scriptVar.autorun depends on how the script was loaded. The default is "no" if the script was loaded with loadscript or script.new(). It is "yes" for scripts loaded with loadandrunscript or script.newautorun().","@ Make sure to save the script in nonvolatile memory after setting the autorun attribute so that the instrument will retain the setting.","Example","test5.autorun = "yes"","test5.save()","Assume a script named "test5" is in the run-time environment.","The next time the instrument is turned on, "test5" script automatically loads and runs.","Also see","None","scriptVar.autorun","16852.html");
+Page[263]=new Array("This function generates a script listing.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","scriptVar.list()","scriptVar","The name of variable that references the script","Details","This function generates output in the form of a sequence of response messages (one message for each line of the script). It also generates output of the script control messages (loadscript or loadandrunscript, and endscript).","Example","test7 = script.new("display.clear() display.settext('Hello from my test')", "test7")","test7()","test7.save()","test7.list()","The above example code creates a script named "test7" that displays text on the front panel, lists the script with the following output:","loadscript test7","display.clear() display.settext("Hello from my test")","endscript","Also see","Load a script by sending commands over the remote interface","Retrieve source code one line at a time","scriptVar.list()","17785.html");
+Page[264]=new Array("This attribute contains the name of a script in the run-time environment.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","No","Not applicable","Not applicable","Not applicable","Usage","scriptVar.name = scriptName","scriptName = scriptVar.name","scriptVar","Name of the variable that references the script","scriptName","A string that represents the name of the script","Details","When setting the script name, this attribute renames the script that the variable scriptVar references.","This attribute must be either a valid Lua identifier or the empty string. Changing the name of a script changes the index used to access the script in the script.user.scripts table. Setting the attribute to an empty string removes the script from the table completely, and the script becomes an unnamed script.","As long as there are variables referencing an unnamed script, the script can be accessed through those variables. When all variables that reference an unnamed script are removed, the script will be removed from the run‑time environment.","If the new name is the same as a name that is already used for another script, the name of the other script is set to an empty string, and that script becomes unnamed. ","@ Changing the name of a script does not change the name of any variables that reference that script. The variables will still reference the script, but the names of the script and variables may not match.","Example","test7 = script.new("display.clear() display.settext('Hello from my test')", "")","test7()","print(test7.name)","test7.name = "test7"","print(test7.name) ","test7.save()","The above example calls the script.new() function to create a script with no name, runs the script, names the script "test7", and then saves the script in nonvolatile memory.","Also see","script.new()","scriptVar.save()","Rename a script","scriptVar.name","2589.html");
+Page[265]=new Array("This function runs a script.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","scriptVar.run()","scriptVar()","scriptVar","The name of variable that references the script","Details","The scriptVar.run() function runs the script; you can also run the script by using scriptVar().","To run a factory script, use script.factory.scripts.scriptName(), replacing scriptName with the name of the desired factory script.","Example","test8.run()","Runs the script referenced by the variable test8.","Also see","None","scriptVar.run()","16856.html");
+Page[266]=new Array("This function saves the script to nonvolatile memory or to a USB flash drive.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","scriptVar.save()","scriptVar.save(filename)","scriptVar","The name of variable that references the script","filename","The file name to use when saving the script to a USB flash drive","Details","The scriptVar.save() function only saves a script to nonvolatile memory or a USB flash drive.","If no filename is given, the script will be saved to internal nonvolatile memory. Only a named script (the script's name attribute is not an empty string) can be saved to internal nonvolatile memory. If a filename is given, the script will be saved to the USB flash drive. ","You are not required to add the file extension, but if you would like to, the only allowed extension is .tsp (see Example 2). ","Example 1","test8.save()","Saves the script referenced by the variable test8 to nonvolatile memory.","Example 2","test8.save("/usb1/myScript.tsp")","Saves the script referenced by the variable test8 to a file named myScript.tsp on your flash drive.","Also see","Save a user script","scriptVar.save()","16863.html");
+Page[267]=new Array("This attribute holds the source code of a script.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","(see Details)","No","Not applicable","Not saved","Not applicable","Usage","code = scriptVar.source","scriptVar.source = nil","scriptVar","The name of the variable that references the script that contains the source code","code","The body of the script","Details","The loadscript or loadandrunscript and endscript keywords are not included in the source code. ","The body of the script is a single string with lines separated by the new line character.","The instrument automatically keeps the source for all scripts loaded on the instrument. To free up memory or to obfuscate the code, assign nil to the source attribute of the script. Although this attribute is writable, it can only be set to the nil value.","Example","test7 = script.new("display.clear() display.settext('Hello from my test')", "")","print(test7.source)","The above example creates a script called "test7" that displays a message on the front panel.","Retrieve the source code.","Output:","display.clear() display.settext('Hello from my test')","Also see","scriptVar.list()","scriptVar.source","16867.html");
+Page[268]=new Array("This attribute configures the baud rate for the RS-232 port.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Not applicable","Nonvolatile memory","9600","Usage","baud = serial.baud","serial.baud = baud","baud","The baud rate (300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600 or 115200)","Details","A new baud rate setting takes effect when the command to change it is processed.","@ Allow ample time for the command to be processed before attempting to communicate with the instrument again. If possible, set the baud rate from one of the other command interfaces or from the front panel.","The reset function has no effect on data bits.","Example","serial.baud = 1200","Sets the baud rate to 1200.","Also see","RS-232 interface operation","serial.databits","serial.flowcontrol","serial.parity","serial.baud","15068.html");
+Page[269]=new Array("This attribute configures character width (data bits) for the RS-232 port.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Not applicable","Nonvolatile memory","8","Usage","bits = serial.databits","serial.databits = bits","bits","An integer representing the character width (7 or 8)","Details","A new data width setting takes effect when the command to change it is processed.","@ Allow ample time for the command to be processed before attempting to communicate with the instrument again. If possible, set the character width from one of the other command interfaces or from the front panel.","The reset function has no effect on data bits.","Example","serial.databits = 8","Sets data width to 8.","Also see","RS-232 interface operation","serial.baud","serial.flowcontrol","serial.parity","serial.databits","15069.html");
+Page[270]=new Array("This attribute configures flow control for the RS-232 port.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Not applicable","Nonvolatile memory",""none" (serial.FLOW_NONE)","Usage","flow = serial.flowcontrol","serial.flowcontrol = flow","flow","A string representing flow control configuration; set to:",""none" or serial.FLOW_NONE (selects no flow control)",""hardware" or serial.FLOW_HARDWARE (selects hardware flow control)","Details","A new flow control setting takes effect when the command to change it is processed.","@ Allow ample time for the command to be processed before attempting to communicate with the instrument again. If possible, set the flow control from one of the other command interfaces or from the front panel.","The reset function has no effect on flow control.","Example","serial.flowcontrol = serial.FLOW_NONE","Sets flow control to none.","Also see","serial.baud","serial.databits","serial.parity","serial.flowcontrol","15070.html");
+Page[271]=new Array("This attribute configures parity for the RS-232 port.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Not applicable","Nonvolatile memory",""none" (serial.PARITY_NONE)","Usage","parity = serial.parity","serial.parity = parity","parity","Set parity to one of the following values:","Select no parity ("none" or serial.PARITY_NONE)","Select even parity ("even" or serial.PARITY_EVEN)","Select odd parity ("odd" or serial.PARITY_ODD)","Details","A new parity setting takes effect when the command to change it is processed.","@ Allow ample time for the command to be processed before attempting to communicate with the instrument again. If possible, set parity from one of the other command interfaces or from the front panel.","The reset function has no effect on parity.","Example","serial.parity = serial.PARITY_NONE","Sets parity to none.","Also see","RS-232 interface operation","serial.baud","serial.databits","serial.flowcontrol","serial.parity","15071.html");
+Page[272]=new Array("This function reads available characters (data) from the serial port.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","data = serial.read(maxchars)","maxchars","An integer that specifies the maximum number of characters to read","data","A string consisting of all data read from the serial port","Details","This function will read available characters from the serial port. It will not wait for new characters to arrive. As long as maxchars is less than 200 characters, all characters received by the serial port (before the serial.read() command is executed) are returned. If too many characters are received between calls to this function, the RS-232 buffers will overflow and some characters may be lost.","Call this function as many times as necessary to receive the required number of characters. For optimal performance, use a small delay between repeated calls to this function.","The data returned is the raw data stream read from the port. No characters, such as control characters or terminator characters, are interpreted nor will the data stream be altered.","This function cannot be used if the serial port is enabled as a command interface; a settings conflict error will be generated.","Example","data = serial.read(200)","print(data)","Read data from the serial port.","Output:","John Doe","The above output indicates that the string "John Doe" was read from the serial port.","Also see","serial.write()","serial.read()","15072.html");
+Page[273]=new Array("This function writes data to the serial port.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","serial.write(data)","data","A string representing the data to write","Details","This function writes the specified string to the serial port, where it can be read by connected equipment (for example, a component handler). ","No terminator characters are added to the data, and data is written exactly as specified by the data parameter.","Example","serial.write("1 2 3 4")","Write data string "1 2 3 4" to the serial port.","Also see","serial.read()","serial.write()","15073.html");
+Page[274]=new Array("This function sets the real-time clock (sets current time of the system).","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","settime(time)","time","The time in seconds since January 1, 1970 UTC","Details","This function sets the date and time of the instrument based on the time parameter (specified in UTC time). UTC time is specified as the number of seconds since Jan 1, 1970, UTC. You can use UTC time from a local time specification, or you can use UTC time from another source (for example, your computer). ","To use the Lua os.time() function to generate a time value in UTC time, use the following format: ","os.time({year = year, month = month, day = day, hour = hour, min = min, sec = sec})","Where:","year","= A full year (2006 or later)","month","= The desired month (1 to 12)","day","= The desired day (1 to 31)","hour","= The desired hour (00 to 23)","min","= The desired minute (00 to 59)","sec","= The desired second (00 to 59)","When you are using the os.time() function, make sure that you include the year, month, and day parameters, which are mandatory (the rest are optional). If the other parameters are not used, they default to noon for that day. ","Set the time zone before calling the os.time() function.","Example","systemTime = os.time({year = 2010,"," month = 3,"," day = 31,"," hour = 14,"," min = 25})","settime(systemTime)","Sets the date and time to Mar 31, 2010 at 2:25 pm.","Also see","gettimezone()","settimezone()","settime()","13943.html");
+Page[275]=new Array("This function sets the local time zone.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","settimezone(offset)","settimezone(offset, dstOffset, dstStart, dstEnd)","offset","String representing offset from UTC","dstOffset","String representing daylight savings offset from UTC","dstStart","String representing when daylight savings time starts","dstEnd","String representing when daylight savings time ends","Details","The time zone is only used when converting between local time and UTC time when using the os.time() and os.date() functions.","If only one parameter is given, the same time offset is used throughout the year. If four parameters are given, time is adjusted twice during the year for daylight savings time.","offset and dstOffset are strings of the form "[+|-]hh[:mm[:ss]]" that indicate how much time must be added to the local time to get UTC time: hh is a number between 0 and 23 that represents hours; mm is a number between 0 and 59 that represents minutes; ss is a number between 0 and 59 that represents seconds. The minutes and seconds fields are optional.","The UTC-5 time zone would be specified with the string "5" because UTC-5 is 5 hours behind UTC and one must add 5 hours to the local time to get UTC time. The time zone UTC4 would be specified as "-4" because UTC4 is 4 hours ahead of UTC and 4 hours must be subtracted from the local time to get UTC.","dstStart and dstEnd are strings of the form "MM.w.dw/hh[:mm[:ss]]" that indicate when daylight savings time begins and ends respectively: MM is a number between 1 and 12 that represents the month; w is a number between 1 and 5 that represents the week within the month; dw is a number between 0 and 6 that represents the day of the week (where 0 is Sunday). The rest of the fields represent the time of day that the change takes effect: hh represents hours; mm represents minutes; ss represents seconds. The minutes and seconds fields are optional. The week of the month and day of the week fields are not specific dates.","Example","settimezone("8", "1", "3.3.0/02", "11.2.0/02")
","settimezone(offset)","Sets offset to equal +8 hours, +1 hour for DST, starts on Mar 14 at 2:00 a.m, ends on Nov 7 at 2:00 a.m.","Sets local time zone to offset.","Also see","gettimezone()","settime()","settimezone()","15021.html");
+Page[276]=new Array("This attribute specifies which saved setup to recall when the instrument is turned on.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Not applicable","Nonvolatile memory","0","Usage","N = setup.poweron","setup.poweron = N","N","An integer that specifies the setup to recall when the instrument power is turned on (0 to 5)","Details","When N = 0, the instrument uses the factory default setup when it is turned on. When N is set to 1 to 5, it uses the setup saved with setup.save().","Only setups stored in nonvolatile memory are available (you cannot recall a script from a USB flash drive with this command) . To save a script to be used when the instrument is powered on, you can create a configuration script and name it autoexec.","Example","setup.poweron = 0","Set the instrument to use the factory default setup when power is turned on.","Also see","Start-up (power-on) configuration","setup.save() ","setup.poweron","15081.html");
+Page[277]=new Array("This function recalls settings from a saved setup.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","setup.recall(id)","id","An integer or string specifying the location of the setup to recall:","Factory default setup (0)","User-saved setup in nonvolatile memory (1 to 5 )","User-saved setup on a USB flash drive ("/path/filename")","Details","When the id parameter is an integer (n), it is interpreted as the setup number to restore from the instrument's nonvolatile memory. When n = 0, the instrument recalls the factory default setup; when n = 1 to 5, the instrument recalls a user-saved setup from nonvolatile memory. ","When the id parameter is a string, it is interpreted as the path and file name of the setup to restore from a file on a USB flash drive. The path may be absolute or relative to the current working directory.","Before a setup is recalled, an instrument reset is performed.","Example 1","setup.recall(1)","Recall the user-saved setup at location 1 .","Example 2","setup.recall("/usb1/KEITHLEY_30730.set")","Recall a user-saved setup stored in a file named KEITHLEY_30730 on a USB flash drive.","Also see","setup.save()","User setup","setup.recall()","15082.html");
+Page[278]=new Array("This function saves the present setup as a user-saved setup.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","setup.save(id)","id","An integer or string specifying where to save the user setup:","Save in nonvolatile memory (1 to 5)","Save as user-saved setup on a USB flash drive ("/path/filename")","When the id parameter is an integer (n), it is interpreted as the setup number to save to the instrument's nonvolatile memory.","@ When you save to a specified integer (1 to 5) in nonvolatile memory, the previous setup at that same location is overwritten.","When the id parameter is a string, it is interpreted as the path and file name of the location to save the present setup on a USB flash drive. The path may be absolute or relative to the current working directory.","Example","setup.save(5)","Saves the present setup to the internal memory of the instrument at location 5.","Also see","setup.recall()","User setup","setup.save()","15083.html");
+Page[279]=new Array("This function terminates all overlapped operations on the specified source‑measure unit (SMU).","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.abort()","X","SMU channel (for example, smua.abort() specifies SMU channel A).","Details","The smuX.abort() function will not turn the output off or change any settings.","If used to abort a sweep, when executed, the SMU will exit its trigger model immediately and return to the trigger model's idle state.","Example","smua.abort()","Terminates all overlapped operations on SMU channel A.","Also see","smuX.measure.overlappedY()","smuX.trigger.initiate()","smuX.abort()","15088.html");
+Page[280]=new Array("This function returns a specified reading buffer's statistics.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","statistics = smuX.buffer.getstats(bufferVar)","statistics","The reading buffer's statistics","X","Source‑measure unit (SMU) channel (for example, smua.buffer.getstats() specifies SMU channel A)","bufferVar","The reading buffer to process","Details","This function returns a table with statistical data about the data placed in the buffer.","The SMU will automatically update reading buffer statistics as data is added to the reading buffer. When the reading buffer is configured to wrap around and overwrite older data with new data, the buffer statistics will include the data that was overwritten.","The table returned from this function is a snapshot. Although the SMU continues to update the statistics, the table returned will not be updated. To get fresh statistics, call this function again.","The statistics parameter has the following attributes:","Attribute","When returned","Description","n","Always","The number of data points on which the statistics are based","mean","When n > 0","The average of all readings added to the buffer","stddev","When n > 1","The standard deviation of all readings (samples) added to the buffer","min","When n > 0","A table containing data about the minimum reading value added to the buffer","max","When n > 0","A table containing data about the maximum reading value added to the buffer","If n equals zero (0), all other attributes will be nil because there is no data to base any statistics on. If n equals 1, the stddev attribute will be nil because the standard deviation of a sample size of 1 is undefined.","The min and max entries each have the following attributes:","Attribute","Description","measurefunction","String indicating the function measured for the reading (current, voltage, ohms or watts)","measurerange","The full-scale range value for the measure range used when the measurement was made","reading","The reading value","sourcefunction","String indicating the source function at the time of the measurement (current or voltage)","sourceoutputstate","String indicating the state of the source (off or on)","sourcerange","Full-scale range value for the source range used when the measurement was made","sourcevalue","If bufferVar.collectsourcevalues is enabled, the sourced value in effect at the time of the reading","status","Status value for the reading; the status value is a floating-point number that encodes the status value into a floating-point value","timestamp","If bufferVar.collecttimestamps is enabled, the timestamp, in seconds, between when the reading was acquired and when the first reading in the buffer was acquired; adding this value to the base timestamp will give the actual time the measurement was acquired","Also see","smuX.buffer.recalculatestats()","smuX.buffer.getstats()","18554.html");
+Page[281]=new Array("This function recalculates the specified reading buffer's statistics.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.buffer.recalculatestats(bufferVar)","X","Source‑measure unit (SMU) channel (for example, smua.buffer.recalculatestats() specifies SMU channel A)","bufferVar","The reading buffer to process","Details","This function will cause the SMU to regenerate the reading buffer statistics on the specified reading buffer. As the SMU automatically updates reading buffer statistics as data is added to the reading buffer, this function is generally not needed. When the reading buffer is configured to wrap around and overwrite older data with new data, the buffer statistics will include the data that was overwritten. Use this function to recalculate the statistics including only the data that is currently stored in the buffer.","Also see","bufferVar.fillmode","smuX.buffer.getstats()","smuX.buffer.recalculatestats()","18556.html");
+Page[282]=new Array("This attribute stores the date of the last calibration adjustment.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU cal. restore","SMU nonvolatile memory","Initially set to factory calibration date","Usage","adjustDate = smuX.cal.adjustdate","smuX.cal.adjustdate = adjustDate","adjustDate","Date of the last calibration adjustment","X","Source‑measure unit (SMU) channel (for example, smua.cal.adjustdate applies to SMU channel A)","Details","This attribute stores the adjustment date associated with the active calibration set. The adjustment date can be read at any time, but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function.","You cannot change the adjust date without first making a change to the calibration constants.","Once you change any calibration constants, you must set the adjustment date before being allowed to save the calibration data to the SMU's nonvolatile memory.","This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute will reflect the date stored with that set.","smuX.cal.adjustdate must be set to the date the adjustment was done using the UTC time and date. The date is stored as the number of seconds since UTC, 12:00 am Jan 1, 1970.","Due to the internal storage format, smuX.cal.adjustdate is only accurate to within a few minutes of the value set.","Example","smua.cal.adjustdate = os.time()","Sets the adjustment date for SMU channel A to the current time set on the instrument.","Also see","Adjustment","smuX.cal.date","smuX.cal.due","smuX.cal.lock()","smuX.cal.restore()","smuX.cal.save()","smuX.cal.state","smuX.cal.unlock()","smuX.cal.adjustdate","15093.html");
+Page[283]=new Array("This attribute stores the calibration date of the active calibration set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU cal. restore","SMU nonvolatile memory","Initially set to factory calibration date","Usage","calDate = smuX.cal.date","smuX.cal.date = calDate","calDate","The active calibration set's calibration date","X","Source‑measure unit (SMU) channel (for example, smua.cal.date applies to SMU channel A)","Details","This attribute stores the calibration date associated with the active calibration set. The calibration date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function.","This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute will reflect the date stored with that set.","smuX.cal.date must be set to the date the calibration was done using the UTC time and date. The date is stored as the number of seconds since UTC 12:00 am Jan 1, 1970.","Due to the internal storage format, smuX.cal.date is accurate to within a few minutes of the value set.","Example","smua.cal.date = os.time()","Sets calibration date for SMU channel A to the current time set on the instrument.","Also see","Adjustment","smuX.cal.adjustdate","smuX.cal.due","smuX.cal.lock()","smuX.cal.restore()","smuX.cal.save()","smuX.cal.state","smuX.cal.unlock()","smuX.cal.date","15094.html");
+Page[284]=new Array("This attribute stores the calibration due date for the next calibration.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU cal. restore","SMU nonvolatile memory","0","Usage","calDue = smuX.cal.due","smuX.cal.due = calDue","calDue","Due date of next calibration","X","Source‑measure unit (SMU) channel (for example, smua.cal.due applies to SMU channel A)","Details","This attribute stores the calibration due date associated with the active calibration set. The calibration due date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function.","This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute will reflect the due date stored with that set.","smuX.cal.due must be set to the date the next calibration is required using the UTC time and date. The date is stored as the number of seconds since UTC 12:00 am Jan 1, 1970.","Due to the internal storage format, smuX.cal.due is only accurate to within a few minutes of the value set.","Example","smua.cal.due = os.time() + 365 * 24 * 60 * 60","Sets the SMU channel A calibration due date equal to one year from the current time set on the instrument.","Also see","Adjustment","smuX.cal.adjustdate","smuX.cal.date","smuX.cal.lock()","smuX.cal.restore()","smuX.cal.state","smuX.cal.unlock()","smuX.cal.due","15095.html");
+Page[285]=new Array("This function performs calibration of the fast analog-to-digital converter (fast ADC).","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.cal.fastadc()","X","Source‑measure unit (SMU) channel (for example, smua.cal.fastadc() specifies SMU channel A).","Details","This function automatically performs all the steps required to calibrate the fast ADC. This function uses the readings obtained when calibrating the measure ranges (make sure both voltage and current calibration has been completed before calling this function).","Example","smua.cal.fastadc()","Performs fast ADC calibration for SMU Channel A.","Also see","Adjustment","smuX.measure.calibrateY()","smuX.cal.fastadc()","19478.html");
+Page[286]=new Array("This function disables commands that change calibration settings.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.cal.lock()","X","Source‑measure unit (SMU) channel (for example, smua.cal.lock() specifies SMU channel A)","Details","This function disables calibration functions that can change calibration settings. The calibration constants must be written to nonvolatile memory, or a previous calibration set must be restored prior to locking calibration. Error code 5012, "Cal data not saved - save or restore before lock," will result if this function is called when the calibration state is smuX.CALSTATE_CALIBRATING. ","Example","smua.cal.lock()","Disables calibration functions for SMU channel A.","Also see","Adjustment","smuX.cal.restore()","smuX.cal.save()","smuX.cal.state","smuX.cal.lock()","15089.html");
+Page[287]=new Array("This attribute stores the password required to enable calibration.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (W)","Yes","Not applicable","SMU nonvolatile memory",""KI0026XX"","Usage","smuX.cal.password = newPassword","X","SMU channel (for example, smua.cal.password applies to SMU channel A)","newPassword","The new password (string)","Details","A new password can only be assigned when calibration has been unlocked.","The calibration password is write-only and cannot be read.","Example","smua.cal.password = "LetMeIn"","Assigns a new calibration password for SMU channel A.","Also see","Adjustment","smuX.cal.unlock()","smuX.cal.password","15096.html");
+Page[288]=new Array("This attribute controls which calibration constants are used for all subsequent measurements.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset SMU reset SMU cal. lock Recall setup","Not saved","0 (smuX.CAL_AUTO)","Usage","calPolarity = smuX.cal.polarity","smuX.cal.polarity = calPolarity","calPolarity","The polarity to use for measurements. Set to one of the following values:","0 or smuX.CAL_AUTO: Automatic polarity detection","1 or smuX.CAL_POSITIVE: Measure with positive polarity calibration constants","2 or smuX.CAL_NEGATIVE: Measure with negative polarity calibration constants","X","SMU channel (for example, smua.cal.polarity applies to SMU channel A)","Details","This attribute controls which polarity calibration constants are used to make all subsequent measurements. This attribute does not affect the smuX.measure.calibrateY() or smuX.source.calibrateY() commands. The polarity for those commands are dictated by the range parameter given to the command. The measurement calibration commands require the measurements provided to have been made using the polarity being calibrated. ","When making those measurements with calibration points far away from zero, the desired polarity constants are inherently used. When measuring near zero, it is possible for the measurement to be made using the calibration constants from either polarity without knowing which was used. Setting this attribute to positive or negative forces measurements to be made using the calibration constants for a given polarity rather than basing the choice on the raw measurement data.","This attribute can only be set to positive or negative when calibration is unlocked. This attribute will automatically be set to smuX.CAL_AUTO when calibration is locked.","Example","smua.cal.polarity = smua.CAL_POSITIVE","Selects positive calibration constants for all subsequent measurements on SMU channel A.","Also see","Adjustment","reset()","smuX.cal.lock()","smuX.cal.unlock()","smuX.measure.calibrateY()","smuX.reset()","smuX.source.calibrateY()","smuX.cal.polarity","15097.html");
+Page[289]=new Array("This function loads a stored set of calibration constants.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.cal.restore()","smuX.cal.restore(calset)","X","Source‑measure unit (SMU) channel (for example, smua.cal.restore() applies to SMU channel A)","calset","The calibration set to be loaded. Set calset to one of the following values:","0 or smuX.CALSET_NOMINAL: A set of calibration constants that are uncalibrated, but set to nominal values to allow rudimentary functioning of the instrument","1 or smuX.CALSET_FACTORY: The calibration constants when the instrument left the factory","2 or smuX.CALSET_DEFAULT: The normal calibration set","3 or smuX.CALSET_PREVIOUS: The calibration set that was used before the last default set was overwritten","Details","This function will overwrite the current set of calibration constants with constants read from nonvolatile memory.","This function will be disabled until a successful call to smuX.cal.unlock() is made.","If calset is not specified, smuX.CALSET_DEFAULT will be used.","Example","smua.cal.restore()","Restores factory calibration constants for SMU channel A.","Also see","Adjustment","smuX.cal.lock()","smuX.cal.unlock()","smuX.cal.restore()","15090.html");
+Page[290]=new Array("This function stores the active calibration constants to nonvolatile memory.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.cal.save()","X","Source‑measure unit (SMU) channel (for example, smua.cal.save() applies to SMU channel A)","Details","This function will store the active set of calibration constants to nonvolatile memory. The previous calibration constants (from the default calibration set) will be copied to the previous calibration set (smuX.CALSET_PREVIOUS) prior to overwriting the default calibration set.","This function will be disabled until a successful call to smuX.cal.unlock() is made. If any of the calibration constants have been changed, this function will be disabled unless the calibration date, the calibration due date, and the calibration adjust date have been assigned new values.","Example","smua.cal.save()","Stores calibration constants for SMU channel A in nonvolatile memory.","Also see","Adjustment","smuX.cal.adjustdate","smuX.cal.date","smuX.cal.due","smuX.cal.lock()","smuX.cal.restore()","smuX.cal.unlock()","smuX.cal.save()","15091.html");
+Page[291]=new Array("This attribute stores the present calibration state.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not saved","Not applicable","Usage","calState = smuX.cal.state","calState","The present calibration state. When reading this read-only attribute, calState will have one of the following values:","0 or smuX.CALSTATE_LOCKED: Calibration is locked","1 or smuX.CALSTATE_CALIBRATING: The calibration constants or dates have been changed but not yet saved to nonvolatile memory","2 or smuX.CALSTATE_UNLOCKED: Calibration is unlocked but none of the calibration constants or dates have changed since the last save/restore","X","SMU channel (for example, smua.cal.state applies to SMU Channel A)","Details","This read-only attribute indicates the calibration state of the instrument: locked, unlocked, or calibrating.","Example","calstate = smua.cal.state","print(calstate)"," ","Reads calibration state for SMU Channel A.","Output: 0.000000e+00","The above output indicates that calibration is locked.","Also see","Adjustment","smuX.cal.lock()","smuX.cal.restore()","smuX.cal.save()","smuX.cal.unlock()","smuX.cal.state","15098.html");
+Page[292]=new Array("This function enables the commands that change calibration settings.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.cal.unlock(password)","X","Source‑measure unit (SMU) channel (for example, smua.cal.unlock() applies to SMU channel A)","password","Calibration password","Details","This function enables the calibration functions to change the calibration settings.","The password when the unit is shipped from the factory is "KI0026XX".","Example","smua.cal.unlock("KI0026XX")","Unlocks calibration for SMU channel A.","Also see","Adjustment","smuX.cal.lock()","smuX.cal.password","smuX.cal.state","smuX.cal.unlock()","15092.html");
+Page[293]=new Array("This function calibrates the high/sense high contact check measurement.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.contact.calibratehi(cp1Measured, cp1Reference, cp2Measured, cp2Reference)","X","Source‑measure unit (SMU) channel (for example, smua.contact.calibratehi() applies to SMU channel A)","cp1Measured","The value measured by this SMU for calibration point 1","cp1Reference","The reference measurement for calibration point 1 as measured externally","cp2Measured","The value measured by this SMU for calibration point 2","cp2Reference","The reference measurement for calibration point 2 as measured externally","Details","Contact check measurement calibration does not require range information.","Typically, calibration points one and two will be near 0 W and 50 W, respectively.","All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the active calibration set. If not, corruption of the calibration constants may result.","The new calibration constants will be activated immediately but are not written to nonvolatile storage. Use smuX.cal.save() to save the new constants to nonvolatile storage. The active calibration constants will stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile storage with the smuX.cal.restore() function.","This function will be disabled until a successful call to smuX.cal.unlock() is made.","Example","-- Short sense LO and output LO terminals","-- Short sense HI and output HI terminals","-- Allow readings to settle, then get measurements","r0_hi, r0_lo = smua.contact.r()","-- Connect 50 OHM resistor between sense LO and output LO","-- Connect 50 OHM resistor between sense HI and output HI","-- Allow readings to settle, then get measurements","r50_hi, r50_lo = smua.contact.r()","smua.contact.calibratelo(r0_lo, Z_actual_lo, r50_lo,"," 50_ohm_actual_lo)","smua.contact.calibratehi(r0_hi, Z_actual_hi, r50_hi,"," 50_ohm_actual_hi)","Performs contact","check on SMU","channel A.","Install and measure","two resisters.","Sends contact check LO calibration","command."," ","Send contact check HI calibration command.","Also see","Adjustment","smuX.cal.restore()","smuX.cal.save()","smuX.cal.unlock()","smuX.contact.calibratelo()","smuX.contact.calibratehi()","15099.html");
+Page[294]=new Array("This function calibrates the low/sense low contact check measurement.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.contact.calibratelo(cp1Measured, cp1Reference, cp2Measured, cp2Reference)","X","Source‑measure unit (SMU) channel (for example, smua.contact.calibratelo() applies to SMU channel A)","cp1Measured","The value measured by this SMU for calibration point 1","cp1Reference","The reference measurement for calibration point 1 as measured externally","cp2Measured","The value measured by this SMU for calibration point 2","cp2Reference","The reference measurement for calibration point 2 as measured externally","Details","Contact check measurement calibration does not require range information.","Typically, calibration points one and two will be near 0 W and 50 W, respectively.","All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the active calibration set. If not, corruption of the calibration constants may result.","The new calibration constants will be activated immediately but are not written to nonvolatile storage. Use smuX.cal.save() to save the new constants to nonvolatile storage. The active calibration constants will stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile storage with the smuX.cal.restore() function.","This function will be disabled until a successful call to smuX.cal.unlock() is made.","Example","-- Short sense LO and output LO terminals","-- Short sense HI and output HI terminals","-- Allow readings to settle, then get measurements","r0_hi, r0_lo = smua.contact.r()","-- Connect 50 OHM resistor between sense LO and output LO","-- Connect 50 OHM resistor between sense HI and output HI","-- Allow readings to settle, then get measurements","r50_hi, r50_lo = smua.contact.r()","smua.contact.calibratelo(r0_lo, Z_actual_lo, r50_lo,"," 50_ohm_actual_lo)","smua.contact.calibratehi(r0_hi, Z_actual_hi, r50_hi,"," 50_ohm_actual_hi)","Performs contact","check on SMU","channel A.","Install and measure","two resisters.","Sends contact check LO calibration","command.","Send contact check HI calibration command.","Also see","Adjustment","smuX.cal.restore()","smuX.cal.save()","smuX.cal.unlock()","smuX.contact.calibratehi()","smuX.contact.calibratelo()","15100.html");
+Page[295]=new Array("This function determines if contact resistance is lower than the threshold.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.contact.check()","X","Source‑measure unit (SMU) channel (for example, smua.contact.check() applies to SMU channel A)","Details","This function returns true if the contact resistance is below the threshold; this function returns false if it is above the threshold. The threshold value is set by the smuX.contact.threshold attribute.","Attempting to perform a contact check measurement when any of the following conditions exist will generate errors:","When output is on and any of the following:","SMU is a current source with current range set to less than 1 mA (error code 5065, "I range too low for contact check")","SMU is a voltage source with current limit set to less than 1 mA (error code 5050, "I limit too low for contact check")","When output is off and any of the following:","The output off mode is High-Z (error code 5048, "Contact check not valid with HIGH-Z OUTPUT off")","The output off mode is Normal with the smuX.source.offfunc attribute set to smuX.OUTPUT_DCVOLTS and the off current limit set to less than 1 mA (error code 5066, "source.offlimiti too low for contact check")","The output off mode is Normal with the smuX.source.offfunc attribute set to smuX.OUTPUT_DCAMPS and the source range is less than 1 mA (error code 5065, "I range too low for contact check")","Example","if not smua.contact.check() then"," -- take action","end","Takes action if contact check on SMU channel A fails.","Also see","Contact check connections","Contact check measurements","smuX.contact.speed","smuX.contact.threshold","smuX.source.offfunc","smuX.contact.check()","15101.html");
+Page[296]=new Array("This function measures contact resistance.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","rhi, rlo = smuX.contact.r()","rhi","The measured contact resistance on the high/sense high side","rlo","The measured contact resistance on the low/sense low side","X","Source‑measure unit (SMU) channel (for example, smua.contact.r() applies to SMU channel A)","Details","Attempting to perform a contact resistance measurement when any of the following conditions exist will generate an error:","When output is on and any of the following:","SMU is a current source with current range set to less than 1 mA (error code 5065, "I range too low for contact check")","SMU is a voltage source with current limit set to less than 1 mA (error code 5050, "I limit too low for contact check")","When output is off and any of the following:","The output off mode is High-Z (error code 5048, "Contact check not valid with HIGH-Z OUTPUT off")","The output off mode is Normal with the smuX.source.offfunc attribute set to smuX.OUTPUT_DCVOLTS and the off current limit set to less than 1 mA (error code 5066, "source.offlimiti too low for contact check")","The output off mode is Normal with the smuX.source.offfunc attribute set to smuX.OUTPUT_DCAMPS and the source range is less than 1 mA (error code 5065, "I range too low for contact check")","Example","if not smua.contact.check() then"," smua.contact.speed = smua.CONTACT_SLOW"," rhi, rlo = smua.contact.r()"," print(rhi, rlo)"," exit()","end","Check contacts against threshold.","Set speed for SMU channel A to slow.","Get resistance readings.","Output contact resistances to the host.","Terminate execution.","Also see","Contact check connections","Contact check measurements","smuX.contact.check()","smuX.contact.speed","smuX.contact.r()","15102.html");
+Page[297]=new Array("This attribute stores the speed setting for contact check measurements.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset SMU reset Recall setup","Not saved","0 (smuX.CONTACT_FAST)","Usage","speedSetting = smuX.contact.speed","smuX.contact.speed = speedSetting","speedSetting","The speed setting. Set to one of the following:","0 or smuX.CONTACT_FAST","1 or smuX.CONTACT_MEDIUM","2 or smuX.CONTACT_SLOW","X","SMU channel (for example, smua.contact.speed applies to SMU channel A)","Details","This setting controls the aperture of measurements made for contact check. It does not affect the smuX.measure.nplc aperture setting.","The speed setting can have a dramatic effect on the accuracy of the measurement (see specifications).","Example","smua.contact.speed = smua.CONTACT_SLOW","Configure contact check for higher accuracy on SMU channel A.","Also see","Contact check connections","Contact check measurements","reset()","smuX.contact.check()","smuX.contact.r()","smuX.reset()","smuX.contact.speed","15103.html");
+Page[298]=new Array("This attribute stores the resistance threshold for the smuX.contact.check() function.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset SMU reset Recall setup","Not saved","50 (50 W)","Usage","rValue = smuX.contact.threshold","smuX.contact.threshold = rValue","rValue","The resistance above which contact check should fail (measured in ohms)","X","SMU channel (for example, smua.contact.threshold applies to SMU channel A)","Details","The threshold should be set to less than 1 kW.","Example","smua.contact.threshold = 5","Set the contact check threshold for SMU channel A to 5 W.","Also see","Contact check connections","Contact check measurements","reset()","smuX.contact.check()","smuX.reset()","smuX.contact.threshold","15104.html");
+Page[299]=new Array("This function creates a reading buffer.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","bufferVar = smuX.makebuffer(bufferSize)","bufferVar","The created reading buffer","X","Source‑measure unit (SMU) channel (for example, smua.makebuffer() applies to SMU channel A)","bufferSize","Maximum number of readings that can be stored","Details","Reading buffers can be created and allocated dynamically using this function. Use bufferSize to designate the number of readings the buffer can store.","Dynamically allocated reading buffers can be used interchangeably with the smuX.nvbufferY buffers.","A reading buffer can be deleted by setting all references to the reading buffer equal to nil, then running the garbage collector (see the collectgarbage() function in Standard libraries).","Example","mybuffer2 = smua.makebuffer(200)","Creates a 200 element reading buffer (mybuffer2)for SMU channel A .","Also see","collectgarbage() in Base library functions","Remote reading buffer programming","savebuffer()","smuX.nvbufferY","smuX.makebuffer()","15105.html");
+Page[300]=new Array("This attribute contains the analog-to-digital converter selection.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset SMU reset Recall setup","Saved setup","0 (smuX.ADC_INTEGRATE)","Usage","adc = smuX.measure.adc","smuX.measure.adc = adc","adc","The analog-to-digital (A/D) converter used for measurements. Set to one of the following:","0 or smuX.ADC_INTEGRATE: Integrating A/D converter","1 or smuX.ADC_FAST: Fast A/D converter","X","Source‑measure unit (SMU) channel (for example, smua.measure.adc applies to SMU channel A).","Details","When making measurements, the SMU uses one of two types of analog-to-digital converters. This attribute controls which analog to converter is used.","Example","smua.measure.adc = smua.ADC_FAST","Selects the fast A/D converter for SMU channel A.","Also see","Analog-to-digital converter","smuX.measure.nplc","smuX.measure.adc","17114.html");
+Page[301]=new Array("This attribute stores the measurement autorange setting.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset SMU reset Recall setup","Saved setup","1 (smuX.AUTORANGE_ON)","Usage","autoRange = smuX.measure.autorangeY","smuX.measure.autorangeY = autoRange","autoRange","The state of the measurement autorange setting; set to one of the following values:","0 or smuX.AUTORANGE_OFF: Disabled","1 or smuX.AUTORANGE_ON: Enabled","2 or smuX.AUTORANGE_FOLLOW_LIMIT: Measure range automatically set to the limit range","X","Source‑measure unit (SMU) channel (for example, smua.measure.autorangev applies to SMU channel A)","Y","SMU measure function (v = voltage, i = current)","Details","This attribute indicates the measurement autorange state. Its value will be smuX.AUTORANGE_OFF when the SMU measure circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.","Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed range. The fixed range will be the present SMU measure range.","Setting this attribute to smuX.AUTORANGE_ON puts the SMU measure circuit into autorange mode. It will remain on its present measure range until the next measurement is requested.","If source highC mode is enabled, current autorange will be set to smuX.AUTORANGE_FOLLOW_LIMIT and cannot be changed.","Example","smua.measure.autorangev = 1","Enables voltage measurement autoranging for SMU channel A. Alternatively, the value 1 may be replaced with smua.AUTORANGE_ON.","Also see","Range","reset()","setup.recall()","smuX.measure.rangeY","smuX.reset()","smuX.measure.autorangeY","15107.html");
+Page[302]=new Array("This attribute sets the behavior of the source-measure unit's (SMU's) A/D internal reference measurements (autozero).","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset SMU reset Recall setup","Saved setup","2 (smuX.AUTOZERO_AUTO)","Usage","azMode = smuX.measure.autozero","smuX.measure.autozero = azMode","azMode","Indicates status of autozero; set to one of the following values:","0 or smuX.AUTOZERO_OFF: Autozero disabled","1 or smuX.AUTOZERO_ONCE: Performs autozero once, then disables autozero","2 or smuX.AUTOZERO_AUTO: Automatic checking of reference and zero measurements; an autozero is performed when needed","X","SMU channel (for example, smua.measure.autozero applies to SMU channel A)","Details","The integrating analog-to-digital converter (ADC) uses a ratio metric A/D conversion technique. To ensure the accuracy of readings, the instrument must periodically obtain fresh measurements of its internal ground and voltage reference. The time interval between updates to these reference measurements is determined by the integration aperture being used for measurements. Separate reference and zero measurements are used for each aperture.","By default, the instrument automatically checks these reference measurements whenever a signal measurement is made. If the reference measurements have expired when a signal measurement is made, the instrument will automatically take two more A/D conversions, one for the reference and one for the zero, before returning the result. Thus, occasionally, a measurement takes longer than normal.","This additional time can cause problems in sweeps and other test sequences in which measurement timing is critical. To avoid the extra time for the reference measurements in these situations, the smuX.measure.autozero attribute can be used to disable the automatic reference measurements. Keep in mind that disabling automatic reference measurements may allow the instrument to gradually drift out of specification.","To minimize the drift, a reference and zero measurement should be made just prior to the critical test sequence. The smuX.AUTOZERO_ONCE setting can be used to force a refresh of the reference and zero measurements used for the current aperture setting.","Autozero reference measurements for the last 10 used NPLC settings are stored in a reference cache. If an NPLC setting is selected and an entry for it is not in the cache, the oldest (least recently used) entry will be discarded to make room for the new entry.","The fast ADC (analog-to-digital converter) does not need or use the reference measurements associated with this attribute (only the integrating ADC). When this attribute is set to smuX.AUTOZERO_AUTO, the fast ADC will not require these reference measurements. However, if the fast ADC is selected, setting this attribute to smuX.AUTOZERO_ONCE will cause the integrating ADC to acquire a new set of reference measurements.","Example","smua.measure.autozero = 1","Performs autozero once for SMU channel A. Alternatively, the value 1 may be replaced with smua.AUTOZERO_ONCE.","Also see","Autozero","reset()","smuX.measure.nplc","setup.recall()","smuX.reset()","smuX.measure.autozero","15108.html");
+Page[303]=new Array("This function generates and activates new measurement calibration constants.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.measure.calibrateY(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)","X","Source‑measure unit (SMU) channel (for example, smua.measure.calibratev() applies to SMU channel A)","Y","SMU measurement function (v = voltage, i = current)","range","The measurement range to calibrate","cp1Measured","The value measured by this SMU for calibration point 1","cp1Reference","The reference measurement for calibration point 1 as measured externally","cp2Measured ","The value measured by this SMU for calibration point 2","cp2Reference ","The reference measurement for calibration point 2 as measured externally","Details","This function generates and activates new calibration constants for the given range. The positive and negative polarities of the instrument must be calibrated separately. Use a positive value for range to calibrate the positive polarity and a negative value for range to calibrate the negative polarity.","Typically the two calibration points used will be near zero for calibration point 1 and 90% of full scale for calibration point 2.","All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the active calibration set. Corruption of the calibration constants may result if this is not heeded.","The new calibration constants will be activated immediately but they will not be written to nonvolatile storage. Use smuX.cal.save() to commit the new constants to nonvolatile storage. The active calibration constants will stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile storage with the smuX.cal.restore() function.","This function will be disabled until a successful call to smuX.cal.unlock() is made.","Example","smua.measure.calibratev(1, 1e-4, 1e-5, 0.92, 0.903)","SMU channel A calibrates voltage measurement using following values: 1 V calibration range, 1e-4 for +zero measurement reading, 1e-5 for +zero DMM measurement reading, 0.92 for +FS measurement reading, and 0.903 for the +FS DMM measurement reading.","Also see","Adjustment","smuX.cal.lock()","smuX.cal.restore()","smuX.cal.save()","smuX.cal.unlock()","smuX.source.calibrateY()","smuX.measure.calibrateY()","15109.html");
+Page[304]=new Array("This attribute sets the number of measurements performed when a measurement is requested.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset SMU reset Recall setup","Saved setup","1","Usage","count = smuX.measure.count","smuX.measure.count = count","count","Number of measurements","X","Source‑measure unit (SMU) channel (for example, smua.measure.count applies to SMU channel A)","Details","This attribute controls the number of measurements taken any time a measurement is requested. When using a reading buffer with a measure command, this attribute also controls the number of readings to be stored.","If smuX.measure.count is set to a value greater than 1, any measurement delay set by smuX.measure.delay will only occur before the first measurement, while the smuX.measure.interval controls the interval between successive measurements.","Example","smua.measure.count = 10","Sets the SMU channel A measure count to 10.","Also see","reset()","setup.recall()","smuX.measure.delay","smuX.measure.interval","smuX.measure.overlappedY()","smuX.measure.Y()","smuX.reset()","smuX.measure.count","15110.html");
+Page[305]=new Array("This attribute controls the measurement delay.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset SMU reset Recall setup","Saved setup","smuX.DELAY_OFF ","Usage","mDelay = smuX.measure.delay","smuX.measure.delay = mDelay","mDelay","Set to your desired measurement delay value (for example, to specify an additional 10 ms measurement delay, set the value to 0.010)","You can also set it one of the following values:","0 or smuX.DELAY_OFF: No delay","-1 or smuX.DELAY_AUTO: Automatic delay value","X","Source‑measure unit (SMU) channel (for example, smua.measure.delay applies to SMU channel A)","Details","This attribute allows for additional delay (settling time) before taking a measurement. You can set mDelay to smuX.DELAY_OFF, smuX.DELAY_AUTO, or to a user-defined value (in seconds). A user‑defined value will set the delay used, regardless of range.","The smuX.DELAY_AUTO setting also causes a current range-dependent delay to be inserted when a current measurement is requested. This happens when a current measurement command is executed, when the measure action is being performed in a sweep, or after changing ranges during an autoranged measurement.","If smuX.measure.count is greater than 1, the measurement delay is only inserted before the first measurement.","Example","smua.measure.delay = 0.010","Sets a 10 ms measurement delay for SMU channel A.","Also see","Measure auto delay","reset()","smuX.measure.count","smuX.measure.delayfactor","smuX.source.delay","smuX.reset()","smuX.measure.delay","15111.html");
+Page[306]=new Array("This attribute stores a multiplier to the delays used when smuX.measure.delay is set to smuX.DELAY_AUTO.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset SMU reset Recall setup","Not saved","1","Usage","delayFactor = smuX.measure.delayfactor","smuX.measure.delayfactor = delayFactor","delayFactor","The delay factor multiplier","X","Source‑measure unit (SMU) channel (for example, smua.measure.delayfactor applies to SMU channel A)","Details","The delay factor is only applied when smuX.measure.delay = smuX.DELAY_AUTO.","This attribute can be set to a value less than 1 (for example, 0.5) to decrease the automatic delay.","This attribute can be set to a value greater than 1 (for example, 1.5 or 2.0) to increase the automatic delay.","Setting this attribute to zero disables delays when smuX.measure.delay = smuX.DELAY_AUTO.","Example","smua.measure.delayfactor = 2.0","Doubles the measure delay for SMU channel A.","Also see","Measure auto delay","reset()","smuX.measure.delay","smuX.reset()","smuX.measure.delayfactor","15112.html");
+Page[307]=new Array("This attribute sets the number of measured readings required to yield one filtered measurement.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset SMU reset Recall setup","Saved setup","1","Usage","filterCount = smuX.measure.filter.count","smuX.measure.filter.count = filterCount","filterCount","The number of readings required for each filtered measurement (1 to 100)","X","Source‑measure unit (SMU) channel (for example, smua.measure.filter.count applies to SMU channel A)","Details","This attribute sets the size of the stack used for filtered measurements.","Example","smua.measure.filter.count = 10","Sets the filter count for SMU channel A to 10.","Also see","reset()","setup.recall()","smuX.measure.filter.enable","smuX.measure.filter.type","smuX.reset()","Filters","smuX.measure.filter.count","15113.html");
+Page[308]=new Array("This attribute enables or disables filtered measurements.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset SMU reset Recall setup","Saved setup","0 (smuX.FILTER_OFF)","Usage","filterState = smuX.measure.filter.enable","smuX.measure.filter.enable = filterState","filterState","The filter status. Set to one of the following values:","0 or smuX.FILTER_OFF: Disables the filter","1 or smuX.FILTER_ON: Enables the filter","X","SMU channel (for example, smua.measure.filter.enable applies to SMU channel A)","Details","This attribute enables or disables the filter.","Example","smua.measure.filter.enable = 1","Enables the filter for SMU channel A. Alternatively, the value 1 may be replaced with smua.FILTER_ON.","Also see","reset()","setup.recall()","smuX.measure.filter.count","smuX.measure.filter.type","smuX.reset()","Filters","smuX.measure.filter.enable","15114.html");
+Page[309]=new Array("This attribute sets the type of filter used for measurements when smuX.measure.filter.enable is enabled.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset SMU reset Recall setup","Saved setup","1 (smuX.FILTER_REPEAT_AVG)","Usage","filterType = smuX.measure.filter.type","smuX.measure.filter.type = filterType","filterType","The filter type to use when filtering is enabled. Set to one of the following values:","0 or smuX.FILTER_MOVING_AVG: Selects the moving average filter","1 or smuX.FILTER_REPEAT_AVG: Selects the repeat filter","2 or smuX.FILTER_MEDIAN: Selects the median filter","X","SMU channel (for example, smua.measure.filter.type applies to SMU Channel A)","Details","There are two averaging filter types and one median filter type available. Both repeating and moving types of averaging filters are available.","For the repeating filter (which is the power-on default), the stack (filter count) is filled, and the conversions are averaged to yield a reading. The stack is then cleared, and the process starts over. ","The moving average filter uses a first-in, first-out stack. When the stack (filter count) becomes full, the measurement conversions are averaged, yielding a reading. For each subsequent conversion placed into the stack, the oldest conversion is discarded. The stack is re-averaged, yielding a new reading.","The median filter uses a first-in, first-out stack. When the stack (filter count) becomes full, the “middle-most” reading is returned. For each subsequent conversion placed into the stack, the oldest reading is discarded. The stack is then re-sorted, yielding a new reading. If the filter count is an even number, the reading returned is the average of the two middle readings.","Example","smua.measure.filter.type = 2","Selects the median filter for SMU channel A. Alternatively, the value 2 may be replaced with smua.FILTER_MEDIAN.","Also see","reset()","setup.recall()","smuX.measure.filter.count","smuX.measure.filter.enable","smuX.reset()","Filters","smuX.measure.filter.type","15115.html");
+Page[310]=new Array("This attribute contains a delay multiplier that is used during range changes when High-C mode is active.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset SMU reset Recall setup","Saved setup","10","Usage","delayFactor = smuX.measure.highcrangedelayfactor","smuX.measure.highcrangedelayfactor = delayFactor","delayFactor","The delay factor. Set to a value between 1 and 99","X","SMU channel (for example, smua.measure.highcrangedelayfactor applies to SMU Channel A)","Details","This delay multiplier is only active when High-C mode is active.","Example","smua.measure.highcrangedelayfactor = 5","Increases the delay for SMU channel A by a factor if 5.","Also see","reset()","setup.recall()","smuX.reset()","smuX.source.highc","High-capacitance mode","smuX.measure.highcrangedelayfactor","15116.html");
+Page[311]=new Array("This attribute sets the interval between multiple measurements.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset SMU reset Recall setup","Saved setup","0 (0 s)","Usage","interval = smuX.measure.interval","smuX.measure.interval = interval","interval","The interval value (in seconds). Set to a value between 0 and 1","X","Source‑measure unit (SMU) channel (for example, smua.measure.interval applies to SMU channel A)","Details","This attribute sets the time interval between measurements when smuX.measure.count is set to a value greater than 1. The SMU will do its best to start each measurement when scheduled. If the SMU cannot keep up with the interval setting, measurements will be made as fast as possible.","If filtered measurements are being made, this interval is from the start of the first measurement for the filtered reading to the first measurement for a subsequent filtered reading. Extra measurements made to satisfy a filtered reading are not paced by this interval.","Example","smua.measure.interval = 0.5","Sets the measure interval for SMU channel A to 0.5.","Also see","reset()","smuX.measure.count","setup.recall()","smuX.reset()","smuX.measure.interval","15117.html");
+Page[312]=new Array("This attribute sets the lowest measure range that will be used during autoranging.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset SMU reset Recall setup","Saved setup","Current: 100e‑9 (100 nA)","Voltage: 100e‑3 (100 mV) ","Usage","lowRange = smuX.measure.lowrangeY","smuX.measure.lowrangeY = lowRange","lowRange","The lowest voltage or current measure range used during autoranging","X","Source‑measure unit (SMU) channel (for example, smua.measure.lowrangev applies to SMU channel A)","Y","SMU measure function (v = voltage, i = current)","Details","This attribute is used with autoranging to put a lower bound on the range used. Since lower ranges generally require greater settling times, setting a lowest range limit might make measurements require less settling time.","If the instrument is set to autorange and it is on a range lower than the one specified, the range will be changed to the lowRange range value.","Example","smua.measure.lowrangev = 1","Sets voltage low range for SMU channel A to 1 V.","Also see","reset()","smuX.measure.autorangeY","smuX.reset()","setup.recall()","Range","smuX.measure.lowrangeY","15118.html");
+Page[313]=new Array("This attribute sets the integration aperture for measurements.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset SMU reset Recall setup","Saved setup","1.0","Usage","nplc = smuX.measure.nplc","smuX.measure.nplc = nplc","nplc","The integration aperture; set from 0.001 to 25","X","Source‑measure unit (SMU) channel (for example, smua.measure.nplc applies to SMU channel A)","Details","When making measurements, the SMU uses one of two types of analog‑to‑digital converters. This attribute controls the integration aperture for the integrating analog‑to‑digital converter (ADC). This attribute is not used when the fast ADC is selected.","The integration aperture is based on the number of power line cycles (NPLC), where 1 PLC for 60 Hz is 16.67 ms (1/60) and 1 PLC for 50 Hz is 20 ms (1/50).","Example","smua.measure.nplc = 0.5","Sets the integration time for SMU channel A to 0.5/60 seconds.","Also see","reset()","setup.recall()","smuX.measure.adc","smuX.reset()","Speed","smuX.measure.nplc","15119.html");
+Page[314]=new Array("This function starts an asynchronous (background) measurement.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","smuX.measure.overlappedY(rbuffer)","smuX.measure.overlappediv(ibuffer, vbuffer)","X","Source‑measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)","Y","SMU measurement type (v = voltage, i = current, r = resistance, p = power)","rbuffer","A reading buffer object where the reading(s) will be stored","ibuffer","A reading buffer object where current reading(s) will be stored","vbuffer","A reading buffer object where voltage reading(s) will be stored","Details","This function will start a measurement and return immediately. The measurements, as they are performed, are stored in a reading buffer (along with any ancillary information also being acquired). If the instrument is configured to return multiple readings where one is requested, the readings will be available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.","The smuX.measure.overlappediv() function stores current readings in ibuffer and voltage readings in vbuffer.","This function is an overlapped command. Script execution will continue while the measurement(s) is made in the background. Attempts to access result values that have not yet been generated will cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurement(s) to complete before continuing.","If a given reading buffer contains any data, it will be cleared prior to taking any measurements, unless the reading buffer has been configured to append data.","Example","smua.measure.overlappedv(smua.nvbuffer1)","Starts background voltage measurements for SMU channel A.","Also see","smuX.measure.Y()","smuX.nvbufferY","waitcomplete()","Reading buffers","smuX.measure.overlappedY()","15120.html");
+Page[315]=new Array("This attribute contains the positive full‑scale value of the measure range for voltage or current.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset SMU reset Recall setup","Saved setup","Current: 100e-9 (100 nA)","Voltage: 100e-3 (100 mV)","Usage","rangeValue = smuX.measure.rangeY","smuX.measure.rangeY = rangeValue","rangeValue","Set to the maximum expected voltage or current to be measured","X","Source‑measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)","Y","SMU measurement function (v = voltage, i = current)","Details","Reading this attribute returns the positive full-scale value of the measure range the SMU is currently using. Assigning a value to this attribute sets the SMU on a fixed range large enough to measure the assigned value. The instrument will select the best range for measuring a value of rangeValue.","This attribute is primarily intended to eliminate the time required by the automatic range selection performed by a measuring instrument. Because selecting a fixed range will prevent autoranging, an over-range condition can occur. For example, measuring 3.0 V on the Model 2651A 1 V range will cause an overrange. The value 9.91000E+37 is returned when this occurs.","If the source function is the same as the measurement function (for example, sourcing voltage and measuring voltage), the measurement range is locked to be the same as the source range. However, the setting for the measure range is retained. If the source function is changed (for example, from sourcing voltage to sourcing current), the retained measurement range will be used.","Model 2651A example: Assume the source function is voltage. The source range is 1 V and you set the measure range for 10 V. Since the source range is 1 V, the SMU will perform voltage measurements on the 1 V range. If you now change the source function to current, voltage measurements will be performed on the 10 V range.","Explicitly setting a measure range will disable measure autoranging for that function. Autoranging is controlled separately for each source and measurement function: source voltage, source current, measure voltage and measure current. Autoranging is enabled for all four by default.","Changing the range while the output is off will not update the hardware settings, but querying will return the range setting that will be used once the output is turned on. Setting a range while the output is on will take effect immediately.","With measure autoranging enabled, the range will be changed only when a measurement is taken. Querying the range after a measurement will return the range selected for that measurement.","Example","smua.measure.rangev = 0.5","Selects the 1 V measurement range for SMU channel A.","Also see","reset()","smuX.measure.autorangeY","smuX.source.rangeY","smuX.reset()","setup.recall()","Range","smuX.measure.rangeY","15121.html");
+Page[316]=new Array("This attribute turns relative measurements on or off. ","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset SMU reset Recall setup","Not saved","0 (smuX.REL_OFF)","Usage","relEnable = smuX.measure.rel.enableY","smuX.measure.rel.enableY = relEnable","relEnable","Relative measurement control. Set relEnable to one of the following values:","0 or smuX.REL_OFF: Disables relative measurements","1 or smuX.REL_ON: Enables relative measurements","X","Source‑measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)","Y","SMU measurement function (v = voltage, i = current, r = resistance, p = power)","Details","This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings will be offset by the relative offset value specified by smuX.measure.rel.levelY. Specifically, each returned measured relative reading will be the result of the following calculation:","Relative reading = Actual measured reading - Relative offset value","Example","smua.measure.rel.enablev = smua.REL_ON","Enables relative voltage measurements for SMU channel A.","Also see","reset()","smuX.measure.rel.levelY","smuX.reset()","setup.recall()","Relative offset","smuX.measure.rel.enableY","15123.html");
+Page[317]=new Array("This attribute sets the offset value for relative measurements.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset SMU reset Recall setup","Not saved","0","Usage","relValue = smuX.measure.rel.levelY","smuX.measure.rel.levelY = relValue","relValue","Relative measurement offset value","X","Source‑measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)","Y","SMU measurement function (v = voltage, i = current, r = resistance, p = power)","Details","This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings will be offset by the value of this attribute. Specifically, each returned measured relative reading will be the result of the following calculation: ","Relative reading = Actual measured reading - Relative offset value","Example","smua.measure.rel.levelv = smua.measure.v()","Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.","Also see","reset()","smuX.measure.rel.enableY","smuX.reset()","Relative offset","smuX.measure.rel.levelY","15124.html");
+Page[318]=new Array("This function performs one or more measurements.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","reading = smuX.measure.Y()","reading = smuX.measure.Y(readingBuffer)","iReading, vReading = smuX.measure.iv()","iReading, vReading = smuX.measure.iv(iReadingBuffer)","iReading, vReading = smuX.measure.iv(iReadingBuffer, vReadingBuffer)","reading","Returned value of the last (or only) reading of the measurement process","X","Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)","Y","SMU measurement function (v = voltage, i = current, r = resistance, p = power)","readingBuffer","A reading buffer object where all readings will be stored","iReading","The last reading of the current measurement process","vReading","The last reading of the voltage measurement process","iReadingBuffer","A reading buffer object where current readings will be stored","vReadingBuffer","A reading buffer object where voltage readings will be stored","Details","This function (without specifying a reading buffer) will only make one measurement and return that measurement as reading. To use the additional information acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings will be available in readingBuffer, but only the last measurement will be returned as reading.","Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.","The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).","The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU will ignore the smuX.measure.count attribute and only make one measurement.","The readingBuffer will be cleared before taking any measurements unless the buffer is configured to append data.","Example","smua.measure.count = 10","smua.measure.v(smua.nvbuffer1)","Performs ten voltage measurements using SMU channel A and stores them in a buffer.","Also see","smuX.measure.count","smuX.measure.overlappedY()","smuX.nvbufferY","Reading buffers","smuX.measure.Y()","15122.html");
+Page[319]=new Array("This function performs one or two measurements and then steps the source.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","reading = smuX.measureYandstep(sourceValue)","iReading, vReading = smuX.measureivandstep(sourceValue)","reading","The measured reading before stepping the source","X","Source‑measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)","Y","SMU measurement function (v = voltage, i = current, r = resistance, p = power)","sourceValue","Source value to be set after the measurement is made","iReading","The current reading before stepping the source","vReading","The voltage reading before stepping the source","Details","The smuX.measureYandstep() function performs a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but performs two measurements simultaneously; one for current (i) and one for voltage (v).","Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.","The specified source value should be appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.","Both source and measure autorange must be disabled before using this function. This function cannot be used if source highC mode is enabled (highC mode requires autoranging to be enabled).","This function is provided for very fast execution of source-measure loops. The measurement will be made prior to stepping the source. Prior to using this function, and before any loop this function may be used in, set the source value to its initial level.","Example","local ivalues = {}","smua.source.rangev = 1","smua.source.levelv = 0","smua.measure.rangei = 0.01","smua.source.output = smua.OUTPUT_ON","for index = 1, 10 do"," ivalues[index] = smua.measureiandstep(index / 10)","end","ivalues[11] = smua.measure.i()","This use of the SMU channel A measure and step function measures current starting at a source value of 0 V. After each current measurement, the source is stepped 100 mV for the next current measurement. The final source level is 1 V, where current is again measured. ","Also see","smuX.measure.Y()","smuX.trigger.source.limitY","smuX.trigger.source.linearY()","smuX.trigger.source.listY()","smuX.trigger.source.logY()","Sweep Operation","smuX.measureYandstep()","15125.html");
+Page[320]=new Array("This attribute contains the dedicated reading buffer.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","See Details","Not applicable","Usage","bufferVar = smuX.nvbufferY","bufferVar","The dedicated reading buffer","X","Source‑measure unit (SMU) channel (for example, smua.nvbuffer1 applies to SMU channel A)","Y","SMU nonvolatile buffer (1 or 2)","Details","Each SMU channel contains two dedicated reading buffers: smuX.nvbuffer1 and smuX.nvbuffer2.","All routines that return measurements can also store them in either reading buffer. Overlapped measurements are always stored in a reading buffer. Synchronous measurements return either a single-point measurement or can be stored in a reading buffer if passed to the measurement command.","The dedicated reading buffers can be saved to internal nonvolatile memory (to retain data between power cycles) using the smuX.savebuffer() function.","Example","smua.measure.overlappedv(smua.nvbuffer1)","Store voltage readings from SMU channel A into SMU channel A dedicated reading buffer 1.","Also see","savebuffer()","smuX.makebuffer()","smuX.measure.overlappedY()","smuX.savebuffer()","smuX.trigger.measure.action","smuX.trigger.measure.set()","smuX.trigger.measure.stimulus","smuX.trigger.measure.Y()","Configuring and running sweeps","Reading buffers","smuX.nvbufferY","15126.html");
+Page[321]=new Array("This function turns off the output and resets the SMU to the default settings.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.reset()","X","Source‑measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)","Details","This function turns off the output and returns the specified SMU to its default settings.","Example","smua.reset()","Turns off the output and resets SMU channel A to its default settings.","Also see","reset()","smuX.reset()","15136.html");
+Page[322]=new Array("This function saves one source‑measure unit (SMU) dedicated reading buffer to internal memory (there are two dedicated reading buffers per SMU).","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.savebuffer(smuX.nvbufferY)","X","SMU channel (for example, smua.savebuffer(smua.nvbuffer1) applies to SMU channel A)","Y","SMU dedicated reading buffer (1 or 2)","Details","When the unit is turned off and back on, the dedicated reading buffers will be restored (from internal memory) to their last saved values.","Example","smua.savebuffer(smua.nvbuffer1)","Saves buffer 1 (SMU channel A) to internal memory.","Also see","savebuffer()","smuX.nvbufferY","Reading buffers","smuX.savebuffer()","15137.html");
+Page[323]=new Array("This attribute contains the state of the remote/local sense mode.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Saved setup","0 (smuX.SENSE_LOCAL)","Usage","senseMode = smuX.sense","smuX.sense = senseMode","senseMode","The sense mode; set to one of the following:","0 or smuX.SENSE_LOCAL: Selects local sense (2-wire)","1 or smuX.SENSE_REMOTE: Selects remote sense (4-wire)","3 or smuX.SENSE_CALA: Selects calibration sense mode","X","Source‑measure unit (SMU) channel (for example, smua.sense applies to SMU channel A)","Details","Source-measure operations are performed using either 2-wire local sense connections or 4-wire remote sense connections. Writing to this attribute selects the sense mode.","The smuX.SENSE_CALA mode is only used for calibration and may only be selected when calibration is enabled.","The sense mode can be changed between local and remote while the output is on.","The calibration sense mode cannot be selected while the output is on.","Resetting the instrument selects the local sense mode.","Example","smua.sense = smua.SENSE_REMOTE","Selects remote sensing for SMU channel A.","Also see","2-wire local sensing connections","4-wire remote sensing connections","Sense mode selection","smuX.sense","15138.html");
+Page[324]=new Array("This attribute contains the state of the source autorange control (on/off). ","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Saved setup","1 (smuX.AUTORANGE_ON)","Usage","sourceAutorange = smuX.source.autorangeY","smuX.source.autorangeY = sourceAutorange","sourceAutorange","The state of the source autorange control. Set to one of the following:","0 or smuX.AUTORANGE_OFF: Disables source autorange","1 or smuX.AUTORANGE_ON: Enables source autorange","X","Source‑measure unit (SMU) channel (for example, smua.source.autorangev applies to SMU channel A)","Y","SMU source function (v = voltage, i = current)","Details","This attribute indicates the source autorange state. Its value will be smuX.AUTORANGE_OFF when the SMU source circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.","Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed source range. The fixed range used will be the present SMU source circuit range.","Setting this attribute to smuX.AUTORANGE_ON puts the SMU source circuit into autorange mode. If the source output is on, the SMU will immediately change range to the range most appropriate for the value being sourced if that range is different from the present SMU range.","Autorange will disable if the source level is edited from the front panel. Setting the source range turns off autorange when set by using the smuX.source.rangeY attribute as well.","Resetting the instrument selects the smuX.AUTORANGE_ON.","Example","smua.source.autorangev = smua.AUTORANGE_ON","Enables volts source autorange for SMU channel A.","Also see","smuX.measure.autorangeY","smuX.source.rangeY","smuX.source.autorangeY","15139.html");
+Page[325]=new Array("This function generates and activates new source calibration constants.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.source.calibrateY(range, cp1expected, cp1reference, cp2expected, cp2reference)","X","Source‑measure unit (SMU) channel (for example, smua.source.calibratev() applies to SMU channel A)","Y","SMU source function (v = voltage, i = current)","range","The measurement range to calibrate","cp1expected","The source value programmed for calibration point 1","cp1reference","The reference measurement for calibration point 1 as measured externally","cp2expected","The source value programmed for calibration point 2","cp2reference","The reference measurement for calibration point 2 as measured externally","Details","This function generates and activates new calibration constants for the given range. ","The positive and negative polarities of the source must be calibrated separately. Use a positive value for range to calibrate the positive polarity and a negative value for range to calibrate the negative polarity. Do not use 0.0 for a negative calibration point as 0.0 is considered a positive number.","Typically the two calibration points used will be near zero for calibration point 1 and 90% of full scale for calibration point 2. Full scale for calibration point 2 should be avoided if the SMU's source is substantially out of calibration.","The two reference measurements must be made with the source using the active calibration set. For example, source a value, measure it, and do not change the active calibration set before issuing this command.","The new calibration constants will be activated immediately but they will not be written to nonvolatile storage. Use smuX.cal.save() to commit the new constants to nonvolatile storage.","The active calibration constants will stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile storage with the smuX.cal.restore() function.","This function will be disabled until a successful call to smuX.cal.unlock() is made.","Example","smua.source.calibratev(1, 1e-10, 1e-5, 0.9, 0.903)","SMU channel A calibrates voltage source using the following values: calibrate the 1 V range, 1e-10 for +zero source output value, 1e-5 for +zero DMM measurement reading, 0.9 for +FS source output value, and 0.903 for the +FS DMM measurement reading.","Also see","smuX.cal.restore()","smuX.cal.save()","smuX.cal.unlock()","smuX.measure.calibrateY()","Calibration","smuX.source.calibrateY()","15143.html");
+Page[326]=new Array("This attribute contains the state of source compliance. ","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not saved","Not applicable","Usage","compliance = smuX.source.compliance","compliance","The state of source compliance","X","Source‑measure unit (SMU) channel (for example, smua.source.compliance applies to SMU channel A)","Details","This read-only attribute contains the source compliance state (true or false). ","true indicates that the limit function is in control of the source (source in compliance).","false indicates that the source function is in control of the output (source not in compliance).","Writing to this attribute will generate an error.","Reading this attribute also updates the status model and the front panel with generated compliance information. See Current Limit (ILMT) shown in the status model diagram for the Measurement event registers. The Voltage Limit (VLMT) is not shown in the status model diagram for the Measurement event registers, but is similar to the Current Limit (ILMT).","Example","compliance = smua.source.compliance","print(compliance) ","Reads the source compliance state for SMU channel A.","Output: true","This output indicates that a configured limit has been reached (voltage, current, or power limit).","Also see","smuX.source.limitY","smuX.source.compliance","15141.html");
+Page[327]=new Array("This attribute contains the source delay.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Not saved","0 (smuX.DELAY_OFF)","Usage","sDelay = smuX.source.delay","smuX.source.delay = sDelay","sDelay","Set to your desired source delay value (for example, to specify an additional 10 ms source delay, set the value to 0.010)","Alternatively, you can set it one of the following values:","0 or smuX.DELAY_OFF: No delay","-1 or smuX.DELAY_AUTO: Automatic delay value","X","Source‑measure unit (SMU) channel (for example, smua.source.delay applies to SMU channel A)","Details","This attribute allows for additional delay (settling time) after an output step. Set sDelay to a user-defined value (in seconds). Alternatively, set sDelay to smuX.DELAY_OFF or smuX.DELAY_AUTO.","The smuX.DELAY_AUTO setting causes a range-dependent delay to be inserted when the source is changed. Range dependent delays are based on the output settling time values in the instrument's specifications. ","Example","smua.source.delay = smua.DELAY_AUTO","Sets the delay for SMU channel A to automatic (a range-dependent delay is inserted when ever the source is changed).","Also see","reset()","smuX.measure.count","smuX.measure.delay","smuX.reset()","smuX.source.delay","15142.html");
+Page[328]=new Array("This attribute sets the source function (V source or I source).","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Saved setup","1 (smuX.OUTPUT_DCVOLTS)","Usage","sFunction = smuX.source.func","smuX.source.func = sFunction","sFunction","The source function. Set to one of the following values:","0 or smuX.OUTPUT_DCAMPS: Selects current source function","1 or smuX.OUTPUT_DCVOLTS: Selects voltage source function","X","Source‑measure unit (SMU) channel (for example, smua.source.func applies to SMU channel A)","Details","Reading this attribute gives the output function of the source for the specified SMU channel. Setting this attribute configures the specified SMU channel as either a voltage source or a current source.","Example","smua.source.func = smua.OUTPUT_DCAMPS","Selects the source current function for SMU channel A.","Also see","smuX.source.levelY","smuX.source.output","smuX.source.func","15144.html");
+Page[329]=new Array("This attribute sets high capacitance mode.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Saved setup","0 (smuX.DISABLE)","Usage","highC = smuX.source.highc","smuX.source.highc = highC","highC ","The state of the high capacitance mode; set to one of the following values:","0 or smuX.DISABLE: Disables high capacitance mode","1 or smuX.ENABLE: Enables high capacitance mode","X","Source‑measure unit (SMU) channel (for example, smua.source.highc applies to SMU channel A)","Details","Turning on High-C mode has the following effects on the SMU settings:","smuX.measure.autorangei is set to smuX.AUTORANGE_FOLLOW_LIMIT and cannot be changed","Current ranges below 1 mA are not accessible","If smuX.source.limiti is less than 1 mA, it is raised to 1 mA","If smuX.source.rangei is less than 1 mA, it is raised to 1 mA","If smuX.source.lowrangei is less than 1 mA, it is raised to 1 mA","If smuX.measure.lowrangei is less than 1 mA, it is raised to 1 mA","Example","smua.source.highc = smua.ENABLE ","Activates high capacitance mode for SMU channel A.","Also see","High-capacitance mode","smuX.source.highc","15145.html");
+Page[330]=new Array("This attribute sets the source level.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Saved setup","0","Usage","sourceLevel = smuX.source.levelY","smuX.source.levelY = sourceLevel","sourceLevel","The source value; set to one of the following values:Voltage: 0 V to ±40 V","Current: 0 A to ±20 A","X","Source‑measure unit (SMU) channel (for example, smua.source.levelv applies to SMU channel A)","Y","SMU source function (v = voltage, i = current)","Details","This attribute configures the output level of the voltage or current source.","If the source is configured as a voltage source and the output is on, the new smuX.source.levelv setting will be sourced immediately. If the output is off or the source is configured as a current source, the voltage level will be sourced when the source is configured as a voltage source and the output is turned on.","If the source is configured as a current source and the output is on, the new smuX.source.leveli setting will be sourced immediately. If the output is off or the source is configured as a voltage source, the current level will be sourced when the source is configured as a current source and the output is turned on.","The sign of sourceLevel dictates the polarity of the source. Positive values generate positive voltage or current from the high terminal of the source relative to the low terminal. Negative values generate negative voltage or current from the high terminal of the source relative to the low terminal.","The reset() function sets the source levels to 0 V and 0 A.","Example","smua.source.levelv = 1","Sets voltage source of SMU channel A to 1 V.","Also see","smuX.source.compliance","smuX.source.func","smuX.source.output","Source-measure concepts","smuX.source.levelY","15146.html");
+Page[331]=new Array("This attribute sets compliance limits.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Saved setup","Limit voltage: 20 (20V)","Limit current: 100e‑3 (100 mA)","Limit power: 0 (disabled)","Usage","limit = smuX.source.limitY","smuX.source.limitY = limit","limit","The compliance limit value; set to one of the following values:","Voltage compliance: 0 V to 40 V","Current compliance: 0 A to 20 A","Set power compliance in watts","X","Source‑measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)","Y","SMU function (v = voltage, i = current, p = power)","Details","Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU will always choose (autorange) the source range for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.","This attribute should be set in the test sequence before the turning the source on.","Using a limit value of 0 will result in an error code 1102, "Parameter too small," for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU will adjust the source limit where appropriate to limit the output to the specified power. The SMU will use the lower of the programmed compliance value (the compliance level that would be used if power compliance were disabled) or the limit calculated from the power compliance setting.","Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.","Example","smua.source.limitv = 30","Sets voltage source compliance of SMU channel A to 30 V.","Also see","DUT test connections","smuX.source.compliance","smuX.source.func","smuX.source.output","smuX.source.limitY","17115.html");
+Page[332]=new Array("This attribute sets the lowest source range that will be used during autoranging.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Saved setup","Voltage: 100e‑3 (100 mV)","Current: 100e‑9 (100 nA)","Usage","sourceRangeLow = smuX.source.lowrangeY","smuX.source.lowrangeY = sourceRangeLow","sourceRangeLow","Set to the lowest voltage (in volts) or current (in amperes) range to be used","X","Source‑measure unit (SMU) channel (for example, smua.source.lowrangev applies to SMU channel A)","Y","SMU source function (v = voltage, i = current)","Details","This attribute is used with source autoranging to put a lower bound on the range used. Lower ranges generally require greater settling times. By setting a low-range value, sourcing small values might be able to be made with less settling time.","If the instrument is set to autorange and it is on a range lower than the one specified by sourceRangeLow, the source range will be changed to the range specified by sourceRangeLow.","Example","smua.source.lowrangev = 1","Sets volts low range for Model 2651A SMU channel A to 1 V. This prevents the source from using the 100 mV range when sourcing voltage.","Also see","smuX.source.autorangeY","smuX.source.lowrangeY","15148.html");
+Page[333]=new Array("This attribute sets the source function used (source 0 A or 0 V) when the output is turned off and the source‑measure unit (SMU) is in normal output-off mode.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Saved setup","1 (smuX.OUTPUT_DCVOLTS)","Usage","offfunc = smuX.source.offfunc","smuX.source.offfunc = offfunc","offfunc","Set to the source function to be used when the output is off and the SMU is in normal output-off mode. Set to one of the following values:","0 or smuX.OUTPUT_DCAMPS: Source 0 A","1 or smuX.OUTPUT_DCVOLTS: Source 0 V","X","SMU channel (for example, smua.source.offfunc applies to SMU channel A)","Details","This attribute controls the source function used when the output is turned off and the smuX.source.offmode is set to smuX.OUTPUT_NORMAL. Set this attribute to smuX.OUTPUT_DCVOLTS for the source to be a 0 V source when the output is off (smuX.source.offlimiti is used). Set it to smuX.OUTPUT_DCAMPS for the source to be a 0 A source when the output is off (smuX.source.offlimitv is used). ","This attribute is only used when the smuX.source.offmode attribute is set to smuX.OUTPUT_NORMAL.","Example","smua.source.offfunc = smua.OUTPUT_DCVOLTS","Sets the normal output-off mode to source 0 V when the output is turned off for SMU channel A.","Also see","Output-off states","smuX.source.offlimitY","smuX.source.offmode","smuX.source.output","smuX.source.offfunc","19504.html");
+Page[334]=new Array("This attribute sets the limit (current or voltage) used when the source‑measure unit (SMU) is in normal output-off mode.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Saved setup","Current: 1e-3 (1 mA) Voltage: 40 (40 V)","Usage","sourceLimit = smuX.source.offlimitY","smuX.source.offlimitY = sourceLimit","sourceLimit","Set to the limit to be used when the SMU is in normal output-off mode","X","SMU channel (for example, smua.source.offlimiti applies to SMU channel A)","Y","SMU source function (v = voltage, i = current)","Details","Setting the current limit to lower than 1 mA may interfere with operation of the contact check function. See smuX.contact.check() and smuX.contact.r() for details.","Example","smua.source.offlimiti = 10e-3","Changes the normal output-off mode limit to 10 mA for SMU channel A.","Also see","smuX.source.offfunc","smuX.source.offmode","smuX.source.offlimitY","15149.html");
+Page[335]=new Array("This attribute sets the source output-off mode.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Saved setup","0 (smuX.OUTPUT_NORMAL)","Usage","sourceOffMode = smuX.source.offmode","smuX.source.offmode = sourceOffMode","sourceOffMode","The output-off setting; set to one of the following values:","0 or smuX.OUTPUT_NORMAL: Configures the source function according to smuX.source.offfunc attribute","1 or smuX.OUTPUT_ZERO: Configures source to output 0 V as smuX.OUTPUT_NORMAL but has different compliance handling (see the Details below)","2 or smuX.OUTPUT_HIGH_Z: Opens the output relay when the output is turned off","X","Source‑measure unit (SMU) channel (for example, smua.source.offmode applies to SMU channel A)","Details","Reading this attribute gives the output-off mode of the source. Setting this attribute configures the SMU output-off mode.","The default sourceOffMode is smuX.OUTPUT_NORMAL. In this mode, the source function will be configured according to the smuX.source.offfunc attribute. The smuX.source.offfunc attribute controls whether the SMU is configured as a 0 V voltage source or a 0 A current source. When the SMU is operating as a 0 A current source, the smuX.source.offlimitv attribute sets the voltage limit, just as the smuX.source.offlimiti attribute sets the current limit when the SMU is operating as a 0 V voltage source.","When the offmode is set to smuX.OUTPUT_ZERO, the source will be configured to output 0 V just as smuX.OUTPUT_NORMAL mode with smuX.source.offfunc = smuX.OUTPUT_DCVOLTS. If the source function is voltage, the current limit will not be changed. If the source function is current, the current limit will be set to the current source level or 10 percent of the current source range, whichever is greater.","When offmode is set to smuX.OUTPUT_HIGH_Z, the SMU will open the output relay when the output is turned off.","Example","smua.source.offmode = smua.OUTPUT_HIGH_Z","Sets the output‑off operation for SMU channel A to open the output relay when the output is turned off.","Also see","Output-off states","smuX.source.offfunc","smuX.source.offlimitY","smuX.source.output","smuX.source.offmode","15150.html");
+Page[336]=new Array("This attribute sets source output state (on or off).","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Not saved","0 (smuX.OUTPUT_OFF)","Usage","sourceOutput = smuX.source.output","smuX.source.output = sourceOutput","sourceOutput","The source's output state setting; set to one of the following values:","0 or smuX.OUTPUT_OFF: Turns off the source output","1 or smuX.OUTPUT_ON: Turns on the source output","2 or smuX.OUTPUT_HIGH_Z: Turns off the output in high Z mode (allows you to go to high Z mode without first setting the smuX.source.offmode attribute to smuX.OUTPUT_HIGH_Z)","X","Source‑measure unit (SMU) channel (for example, smua.source.output applies to SMU channel A)","Details","Reading this attribute gives the output state of the source. Setting this attribute will turn the output of the source on or off. The default for the source is off. When the output is turned on, the SMU will source either voltage or current as dictated by the smuX.source.func setting.","Setting this attribute equal to smuX.OUTPUT_HIGH_Z will cause the output to turn off and go to the High Z mode. If the smuX.source.output is then read it will return 0.","Example","smua.source.output = smua.OUTPUT_ON","Turns on SMU channel A source output.","Also see","smuX.source.func","smuX.source.offmode","DUT test connections","smuX.source.output","15151.html");
+Page[337]=new Array("This attribute controls output enable action of the source.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Saved setup","0 (smuX.OE_NONE)","Usage","outputAction = smuX.source.outputenableaction","smuX.source.outputenableaction = outputAction","outputAction","The source's output enable action. Set to one of the following values:","0 or smuX.OE_NONE: No action","1 or smuX.OE_OUTPUT_OFF: Turns the source output off","X","Source‑measure unit (SMU) channel (for example, smua.source.outputenableaction applies to SMU channel A)","Details","This attribute controls the SMU action taken when the output enable line is deasserted.","When set to smuX.OE_NONE, the SMU will take no action when the output enable line goes low (deasserted).","When set to smuX.OE_OUTPUT_OFF and the output enable line is de-asserted, the SMU will turn its output off as if the smuX.source.output = smuX.OUTPUT_OFF command had been received.","The SMU will not automatically turn its output on when the output enable line returns to the high state.","If the output enable line is not asserted when this attribute is set to smuX.OE_OUTPUT_OFF and the output is on, the output will turn off immediately.","Detection of the output enable line going low will not abort any running scripts. This may cause execution errors.","Example","smua.source.outputenableaction = smua.OE_OUTPUT_OFF","Sets SMU channel A to turn off the output if the output enable line goes low (deasserted).","Also see","smuX.source.offmode","smuX.source.output","smuX.source.outputenableaction","15152.html");
+Page[338]=new Array("This attribute contains the source range.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Saved setup","Voltage: 100e‑3 (100 mV)","Current: 100e‑9 (100 nA)","Usage","rangeValue = smuX.source.rangeY","smuX.source.rangeY = rangeValue","rangeValue","Set to the maximum expected voltage or current to be sourced","X","Source‑measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)","Y","SMU source function (v = voltage, i = current)","Details","This attribute contains a value that sets the source‑measure unit (SMU) to a fixed range large enough to source the value. When read, the attribute contains the range the instrument is presently on when in autorange.","Assigning a value to this attribute sets the SMU to a fixed range large enough to source the assigned value. The instrument will select the best range for sourcing a value of rangeValue.","Reading this attribute returns the positive full-scale value of the source range the SMU is currently using. With source autoranging enabled, the output level controls the range. Querying the range after the level is set will return the range the unit chose as appropriate for that source level.","This attribute is primarily intended to eliminate the time required by the automatic range selection performed by a sourcing instrument. Because selecting a fixed range will prevent autoranging, an overrange condition can occur. For example, sourcing 3.0 V on the Model 2651A 1 V range will cause an overrange condition.","Example","smua.source.rangev = 1 ","Selects the 1 V source range for SMU channel A.","Also see","Range","reset()","setup.recall()","smuX.measure.rangeY","smuX.reset()","smuX.source.autorangeY","smuX.source.rangeY","15153.html");
+Page[339]=new Array("This attribute contains the source settling mode.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Not saved","0 (smuX.SETTLE_SMOOTH)","Usage","settleOption = smuX.source.settling","smuX.source.settling = settleOption","settleOption","Set to the source settling mode. Set to one of the following values:","0 or smuX.SETTLE_SMOOTH: Turns off additional settling operations (default)","1 or smuX.SETTLE_FAST_RANGE: Instructs the source‑measure unit (SMU) to use a faster procedure when changing ranges","2 or smuX.SETTLE_FAST_POLARITY: Instructs the SMU to change polarity without going to zero","3 or smuX.SETTLE_DIRECT_IRANGE: Instructs the SMU to change the current range directly","128 or smuX.SETTLE_FAST_ALL: Enables all smuX.SETTLE_FAST_* operations","X","SMU channel (for example, smua.source.settling applies to SMU channel A)","Details","Using smuX.SETTLE_FAST_RANGE may cause the SMU to exceed the range change overshoot specification.","smuX.SETTLE_FAST_POLARITY does not go to zero when changing polarity and may create inconsistencies at the zero crossing.","smuX.SETTLE_DIRECT_IRANGE switches the SMU directly to the target range instead of the default “range-by-range” method. This option is mutually exclusive of any other smuX.SETTLE_FAST_* commands.","Example","smua.source.settling = smua.SETTLE_FAST_POLARITY","Selects fast polarity changing for SMU channel A.","Also see","Range","smuX.source.settling","15154.html");
+Page[340]=new Array("This attribute turns sink mode on or off.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Saved setup","0 (smuX.DISABLE)","Usage","sinkMode = smuX.source.sink","smuX.source.sink = sinkMode","sinkMode","Set to the source settling mode. Set to one of the following values:","0 or smuX.DISABLE: Turns off sink mode","1 or smuX.ENABLE: Turns on sink mode","X","Source‑measure unit (SMU) channel (for example, smua.source.sink applies to SMU channel A)","Details","This attribute enables or disables sink mode. When enabled, sink mode reduces the source limit inaccuracy seen when operating in quadrants II and IV (quadrants I and III will show this source limit inaccuracy).","Example","smua.source.sink = smua.ENABLE","Enables sink mode for SMU channel A.","Also see","Source or sink","smuX.source.sink","15155.html");
+Page[341]=new Array("This attribute sets the arm count in the trigger model.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Not saved","1","Usage","triggerArmCount = smuX.trigger.arm.count","smuX.trigger.arm.count = triggerArmCount","triggerArmCount","The arm count in the trigger model","X","Source‑measure unit (SMU) channel (for example, smua.trigger.arm.count applies to SMU channel A)","Details","During a sweep, the SMU iterates through the arm layer of the trigger model this many times. After performing this many iterations, the SMU returns to an idle state.","If this count is set to zero, the SMU stays in the trigger model indefinitely until aborted.","Example","smua.trigger.arm.count = 5","Sets the SMU channel A to iterate through the arm layer of the trigger model five times and then return to the idle state.","Also see","smuX.trigger.count","smuX.trigger.arm.count","15156.html");
+Page[342]=new Array("This function sets the arm event detector to the detected state.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.trigger.arm.set()","X","Source‑measure unit (SMU) channel (for example, smua.trigger.arm.set() applies to SMU channel A)","Details","The SMU will automatically clear all the event detectors when the smuX.trigger.initiate() function is executed. This function should be called after the sweep is initiated.","A common example of when this function can be used is when you want the SMU to immediately perform an action the first time through the trigger model even if a programmed trigger event does not occur. ","This function can also be used to start actions on the SMU in case of a missed trigger event.","Example","smua.trigger.arm.set()","Sets the arm event detector to the detected state for SMU channel A.","Also see","smuX.trigger.initiate()","smuX.trigger.measure.set()","smuX.trigger.source.set()","smuX.trigger.arm.set()","15157.html");
+Page[343]=new Array("This attribute selects the event that will cause the arm event detector to enter the detected state.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Not saved","0","Usage","eventID = smuX.trigger.arm.stimulus","smuX.trigger.arm.stimulus = eventID","eventID","Event that triggers the arm detector","X","Source‑measure unit (SMU) channel (for example, smua.trigger.arm.stimulus applies to SMU channel A)","Details","Set this attribute to the event ID of any trigger event generator to wait for that event.","Set this attribute to zero to bypass waiting for events at the arm event detector (the SMU continues uninterrupted through the remote trigger model). Set eventID to one of the existing trigger event IDs shown in the following table.","Trigger event IDs*","Event ID","Event description","smua.trigger.SWEEPING_EVENT_ID","Occurs when the source‑measure unit (SMU) transitions from the idle state to the arm layer of the trigger model","smua.trigger.ARMED_EVENT_ID","Occurs when the SMU moves from the arm layer to the trigger layer of the trigger model","smua.trigger.SOURCE_COMPLETE_EVENT_ID","Occurs when the SMU completes a source action","smua.trigger.MEASURE_COMPLETE_EVENT_ID","Occurs when the SMU completes a measure action","smua.trigger.PULSE_COMPLETE_EVENT_ID","Occurs when the SMU completes a pulse","smua.trigger.SWEEP_COMPLETE_EVENT_ID","Occurs when the SMU completes a sweep","smua.trigger.IDLE_EVENT_ID","Occurs when the SMU returns to the idle state","digio.trigger[N].EVENT_ID","Occurs when an edge is detected on a digital I/O line","tsplink.trigger[N].EVENT_ID","Occurs when an edge is detected on a TSP‑Link line","lan.trigger[N].EVENT_ID","Occurs when the appropriate LXI trigger packet is received on LAN trigger object N","display.trigger.EVENT_ID","Occurs when the TRIG key on the front panel is pressed","trigger.EVENT_ID","Occurs when a *TRG command is received on the remote interface","(GPIB only) Occurs when a GET bus command is received","(VXI-11 only) Occurs with the VXI-11 command device_trigger; reference the VXI-11 standard for additional details on the device trigger operation","trigger.blender[N].EVENT_ID","Occurs after a collection of events is detected","trigger.timer[N].EVENT_ID","Occurs when a delay expires","* Use the name of the trigger event ID to set the stimulus value rather than the numeric value. Using the name makes the code compatible for future upgrades (for example, if the numeric values must change when enhancements are added to the instrument).","Example","smua.trigger.arm.stimulus = "," trigger.timer[1].EVENT_ID","An event on trigger timer 1 causes the arm event detector to enter the detected state.","Also see","Triggering","smuX.trigger.arm.stimulus","15158.html");
+Page[344]=new Array("This constant contains the armed event number.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Constant","Yes","Usage","eventID = smuX.trigger.ARMED_EVENT_ID","eventID","The armed event number","X","Source‑measure unit (SMU) channel (for example, smua.trigger.ARMED_EVENT_ID applies to SMU channel A)","Details","Set the stimulus of any trigger event detector to the value of this constant to have it respond to armed events from this SMU.","Example","trigger.timer[1].stimulus = smua.trigger.ARMED_EVENT_ID","Trigger timer when the SMU passes through the ARM layer.","Also see","Triggering","smuX.trigger.ARMED_EVENT_ID","15159.html");
+Page[345]=new Array("This attribute turns automatic clearing of the event detectors on or off.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Not saved","0 (smuX.DISABLE)","Usage","autoClear = smuX.trigger.autoclear","smuX.trigger.autoclear = autoClear","autoClear","Auto clear setting; set to one of the following values:","0 or smuX.DISABLE: Turns off automatic clearing of the event detectors","1 or smuX.ENABLE: Turns on automatic clearing of the event detectors","X","Source‑measure unit (SMU) channel (for example, smua.trigger.autoclear applies to SMU channel A)","Details","This attribute is used to enable or disable automatic clearing of the trigger model state machine event detectors when the SMU transitions from the arm layer to the trigger layer.","Only the detected state of the event detectors will be cleared.","The overrun status of the event detectors are not automatically cleared when the SMU transitions from the arm layer to the trigger layer.","The event detectors are always cleared when a sweep is initiated.","Also see","Triggering","smuX.trigger.autoclear","15160.html");
+Page[346]=new Array("This attribute sets the trigger count in the trigger model.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Not saved","1","Usage","triggerCount = smuX.trigger.count","smuX.trigger.count = triggerCount","triggerCount","The trigger count is the number of times the source‑measure unit (SMU) will iterate in the trigger layer for any given sweep","X","SMU channel (for example, smua.trigger.count applies to SMU channel A)","Details","During a sweep, the SMU iterates through the trigger layer of the trigger model this many times. After performing this many iterations, the SMU returns to the arm layer.","If this count is set to zero (0), the SMU stays in the trigger model indefinitely until aborted.","Also see","Triggering","smuX.trigger.count","15161.html");
+Page[347]=new Array("This attribute enables or disables pulse mode sweeps.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Not saved","1 (smuX.SOURCE_HOLD)","Usage","pulseAction = smuX.trigger.endpulse.action","smuX.trigger.endpulse.action = pulseAction","pulseAction","The pulse mode setting; set to one of the following values (see details for definition):","1 or smuX.SOURCE_HOLD","0 or smuX.SOURCE_IDLE","X","Source‑measure unit (SMU) channel (for example, smua.trigger.endpulse.action applies to SMU channel A)","Details","When set to smuX.SOURCE_HOLD, this attribute disables pulse mode sweep, holding the source level for remainder of step. When set to smuX.SOURCE_IDLE, this attribute enables pulse mode sweep, setting the source level to the programmed (idle) level at the end of the pulse.","Example","smua.trigger.endpulse.action = smua.SOURCE_IDLE","smua.trigger.endpulse.stimulus = "," trigger.timer[1].EVENT_ID","Configure end pulse action to achieve a pulse and configures trigger timer 1 to control the end of pulse.","Also see","Triggering","smuX.trigger.endpulse.action","15162.html");
+Page[348]=new Array("This function sets the end pulse event detector to the detected state.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.trigger.endpulse.set()","X","Source‑measure unit (SMU) channel (for example, smua.trigger.endpulse.set() applies to SMU channel A)","Details","This function sets the end pulse event detector to the detected state.","The SMU automatically clears all the event detectors when the smuX.trigger.initiate() function is executed. This function should be called after the sweep is initiated. Make sure that if the event detectors are configured to clear automatically (because the smuX.trigger.autoclear attribute is set to smuX.ENABLE) that this command is issued after the SMU has entered the trigger layer.","Also see","smuX.trigger.autoclear","smuX.trigger.initiate()","Triggering","smuX.trigger.endpulse.set()","15163.html");
+Page[349]=new Array("This attribute defines which event will cause the end pulse event detector to enter the detected state.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Not saved","0","Usage","eventID = smuX.trigger.endpulse.stimulus","smuX.trigger.endpulse.stimulus = eventID","eventID","Set to the event that triggers the end pulse source off action","X","Source‑measure unit (SMU) channel (for example, smua.trigger.endpulse.stimulus applies to SMU channel A)","Details","Set this attribute to the event ID of any trigger event generator to wait for that event. To bypass waiting for an event, set this attribute's value to 0. Set eventID to one of the existing trigger event IDs shown in the following table.","Trigger event IDs*","Event ID","Event description","smua.trigger.SWEEPING_EVENT_ID","Occurs when the source‑measure unit (SMU) transitions from the idle state to the arm layer of the trigger model","smua.trigger.ARMED_EVENT_ID","Occurs when the SMU moves from the arm layer to the trigger layer of the trigger model","smua.trigger.SOURCE_COMPLETE_EVENT_ID","Occurs when the SMU completes a source action","smua.trigger.MEASURE_COMPLETE_EVENT_ID","Occurs when the SMU completes a measure action","smua.trigger.PULSE_COMPLETE_EVENT_ID","Occurs when the SMU completes a pulse","smua.trigger.SWEEP_COMPLETE_EVENT_ID","Occurs when the SMU completes a sweep","smua.trigger.IDLE_EVENT_ID","Occurs when the SMU returns to the idle state","digio.trigger[N].EVENT_ID","Occurs when an edge is detected on a digital I/O line","tsplink.trigger[N].EVENT_ID","Occurs when an edge is detected on a TSP‑Link line","lan.trigger[N].EVENT_ID","Occurs when the appropriate LXI trigger packet is received on LAN trigger object N","display.trigger.EVENT_ID","Occurs when the TRIG key on the front panel is pressed","trigger.EVENT_ID","Occurs when a *TRG command is received on the remote interface","(GPIB only) Occurs when a GET bus command is received","(VXI-11 only) Occurs with the VXI-11 command device_trigger; reference the VXI-11 standard for additional details on the device trigger operation","trigger.blender[N].EVENT_ID","Occurs after a collection of events is detected","trigger.timer[N].EVENT_ID","Occurs when a delay expires","* Use the name of the trigger event ID to set the stimulus value rather than the numeric value. Using the name makes the code compatible for future upgrades (for example, if the numeric values must change when enhancements are added to the instrument).","Example","smua.trigger.endpulse.action = smua.SOURCE_IDLE","smua.trigger.endpulse.stimulus = "," trigger.timer[1].EVENT_ID","Configure end pulse action to achieve a pulse and selects the event trigger.timer[1].EVENT_ID that will cause the arm event detector to enter the detected state.","Also see","Triggering","smuX.trigger.endpulse.stimulus","15165.html");
+Page[350]=new Array("This attribute sets the action of the source at the end of a sweep.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Not saved","0 (smuX.SOURCE_IDLE)","Usage","action = smuX.trigger.endsweep.action","smuX.trigger.endsweep.action = action","action","The source action at the end of a sweep; set to one of the following values:","0 or smuX.SOURCE_IDLE: Sets the source level to the programmed (idle) level at the end of the sweep","1 or smuX.SOURCE_HOLD: Sets the source level to stay at the level of the last step","X","Source‑measure unit (SMU) channel (for example, smua.trigger.endsweep.action applies to SMU channel A)","Details","Use this attribute to configure the source action at the end of the sweep. The SMU can be programmed to return to the idle source level or hold the last value of the sweep.","Example","smua.trigger.endsweep.action = smua.SOURCE_IDLE","Sets SMU channel A to return the source back to the idle source level at the end of a sweep.","Also see","Triggering","smuX.trigger.endsweep.action","15166.html");
+Page[351]=new Array("This constant contains the idle event number.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Constant","Yes","Usage","eventID = smuX.trigger.IDLE_EVENT_ID","eventID","The idle event number","X","Source-measure unit (SMU) channel (for example, smua.trigger.IDLE_EVENT_ID applies to SMU channel A)","Details","Set the stimulus of any trigger event detector to the value of this constant to have it respond to idle events from this SMU.","Example","trigger.timer[1].stimulus = smua.trigger.IDLE_EVENT_ID","Trigger timer when the SMU returns to the idle layer.","Also see","Triggering","smuX.trigger.IDLE_EVENT_ID","15167.html");
+Page[352]=new Array("This function initiates a sweep operation.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.trigger.initiate()","X","Source‑measure unit (SMU) channel (for example, smua.trigger.initiate() applies to SMU channel A)","Details","This function causes the SMU to clear the four trigger model event detectors and enter its trigger model state machine (moves the SMU from the idle state into the arm layer).","To perform source actions during the sweep, it is necessary to configure and enable one of the sweep source actions, smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY(), and measure actions (smuX.trigger.measure.Y(), before calling this function.","If you run this function more than once without reconfiguring the sweep measurements, the caches on the configured measurement reading buffers will hold stale data. If you do run this function repeatedly without reconfiguring the sweep measurement, use the bufferVar.clearcache() function to remove stale values from the reading buffer cache.","This function initiates an overlapped operation.","Example","smua.trigger.initiate()","Starts a preconfigured sweep and clears the event detectors for SMU channel A).","Also see","bufferVar.clearcache()","Configuring and running sweeps","smuX.trigger.measure.action","smuX.trigger.measure.Y()","smuX.trigger.source.action","smuX.trigger.source.linearY()","smuX.trigger.source.listY()","smuX.trigger.source.logY()","Triggering","smuX.trigger.initiate()","15168.html");
+Page[353]=new Array("This attribute controls measurement actions during a sweep.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Not saved","0 (smuX.DISABLE)","Usage","action = smuX.trigger.measure.action","smuX.trigger.measure.action = action","action","The sweep measure action; set to one of the following values:","0 or smuX.DISABLE: Do not make measurements during the sweep","1 or smuX.ENABLE: Make measurements during the sweep","2 or smuX.ASYNC: Make measurements during the sweep, but asynchronously","with the source area of the trigger model","X","Source‑measure unit (SMU) channel (for example, smua.trigger.measure.action applies to SMU channel A)","Details","With this attribute enabled (setting action to smuX.ENABLE or smuX.ASYNC), configure the measurement with one of the smuX.trigger.measure.Y() functions.","If this attribute is set to smuX.ASYNC:","Asynchronous sweep measurements can only be used with measure autoranging turned off. To turn measure autoranging off for all measurements during the sweep, set the smuX.measure.autorangeY attribute to smuX.AUTORANGE_OFF.","If the integrating ADC is selected (smuX.measure.adc attribute is set to smuX.ADC_INTEGRATE), autozero must also be turned off. To turn off autozero, set the smuX.measure.autozero attribute to smuX.AUTOZERO_OFF or smuX.AUTOZERO_ONCE.","If either of the above items are incorrectly configured, the smuX.trigger.initiate() function will generate an error.","Also see","smuX.measure.adc","smuX.trigger.autoclear","smuX.trigger.measure.Y()","Triggering","smuX.trigger.measure.action","15169.html");
+Page[354]=new Array("This function sets the measure event detector to the detected state.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.trigger.measure.set()","X","Source‑measure unit (SMU) channel (for example, smua.trigger.measure.set() applies to SMU channel A)","Details","This function is useful whenever you want the SMU to continue operation without waiting for a programmed trigger event. When called, this function immediately satisfies the event detector, allowing the SMU to continue through the trigger model.","A common example of when this function can be used is when you want the SMU to immediately perform an action the first time through the trigger model even if a programmed trigger event does not occur. Make sure that if the event detectors are configured to clear automatically (because the smuX.trigger.autoclear attribute is set to smuX.ENABLE) that this command is issued after the SMU has entered the trigger layer. This function can also be used to start actions on the SMU in case of a missed trigger event.","The SMU will automatically clear all event detectors when the smuX.trigger.initiate() function is executed. This function should be called after the sweep is initiated.","Example","smua.trigger.measure.set()","Sets the measure event detector of SMU channel A.","Also see","smuX.trigger.arm.set()","smuX.trigger.autoclear","smuX.trigger.endpulse.set()","smuX.trigger.source.set()","smuX.trigger.measure.set()","15170.html");
+Page[355]=new Array("This attribute selects which event will cause the measure event detector to enter the detected state.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Not saved","0","Usage","eventID = smuX.trigger.measure.stimulus","smuX.trigger.measure.stimulus = eventID","eventID","Event that triggers the measure detector","X","Source‑measure unit (SMU) channel (for example, smua.trigger.measure.stimulus applies to SMU channel A)","Details","Set this attribute to the event ID of any trigger event generator to wait for that event. When set, the SMU waits for the event at the measure event detector portion of the trigger model.","Set this attribute to zero to bypass waiting for an event (the SMU continues uninterrupted through the remote trigger model). Set eventID to one of the existing trigger event IDs shown in the following table.","Trigger event IDs*","Event ID","Event description","smua.trigger.SWEEPING_EVENT_ID","Occurs when the source‑measure unit (SMU) transitions from the idle state to the arm layer of the trigger model","smua.trigger.ARMED_EVENT_ID","Occurs when the SMU moves from the arm layer to the trigger layer of the trigger model","smua.trigger.SOURCE_COMPLETE_EVENT_ID","Occurs when the SMU completes a source action","smua.trigger.MEASURE_COMPLETE_EVENT_ID","Occurs when the SMU completes a measure action","smua.trigger.PULSE_COMPLETE_EVENT_ID","Occurs when the SMU completes a pulse","smua.trigger.SWEEP_COMPLETE_EVENT_ID","Occurs when the SMU completes a sweep","smua.trigger.IDLE_EVENT_ID","Occurs when the SMU returns to the idle state","digio.trigger[N].EVENT_ID","Occurs when an edge is detected on a digital I/O line","tsplink.trigger[N].EVENT_ID","Occurs when an edge is detected on a TSP‑Link line","lan.trigger[N].EVENT_ID","Occurs when the appropriate LXI trigger packet is received on LAN trigger object N","display.trigger.EVENT_ID","Occurs when the TRIG key on the front panel is pressed","trigger.EVENT_ID","Occurs when a *TRG command is received on the remote interface","(GPIB only) Occurs when a GET bus command is received","(VXI-11 only) Occurs with the VXI-11 command device_trigger; reference the VXI-11 standard for additional details on the device trigger operation","trigger.blender[N].EVENT_ID","Occurs after a collection of events is detected","trigger.timer[N].EVENT_ID","Occurs when a delay expires","* Use the name of the trigger event ID to set the stimulus value rather than the numeric value. Using the name makes the code compatible for future upgrades (for example, if the numeric values must change when enhancements are added to the instrument).","Example","smua.trigger.measure.stimulus = trigger.timer[1].EVENT_ID","Sets delay before measurement begins on SMU channel A.","Also see","Triggering","smuX.trigger.measure.stimulus","15171.html");
+Page[356]=new Array("This function configures the measurements to be made in a subsequent sweep.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.trigger.measure.Y(rbuffer)","smuX.trigger.measure.iv(ibuffer, vbuffer)","X","Source‑measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)","Y","SMU measurement type (v = voltage, i = current, r = resistance, p = power)","rbuffer","A reading buffer object where the readings will be stored","ibuffer","A reading buffer object where current readings will be stored","vbuffer","A reading buffer object where voltage readings will be stored","Details","The measurements, as they are performed, are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings will be available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.","The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.","If a given reading buffer contains any data, it will be cleared prior to taking any measurements, unless the reading buffer has been configured to append data.","The SMU only retains the last call to any one of these functions and only that measure action will be performed.","After configuring the measurements to make with this function, remember to enable the measure action by setting smuX.trigger.measure.action = smuX.ENABLE.","Example","smua.trigger.measure.v(vbuffername)","smua.trigger.measure.action = smua.ENABLE","Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.","Also see","smuX.measure.Y()","smuX.nvbufferY","smuX.trigger.measure.action","waitcomplete()","Reading buffers","Sweep Operation","Triggering","smuX.trigger.measure.Y()","15172.html");
+Page[357]=new Array("This constant contains the measure complete event number.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Constant","Yes","Usage","eventID = smuX.trigger.MEASURE_COMPLETE_EVENT_ID","eventID","The measure complete event number","X","Source‑measure unit (SMU) channel (for example, smua.trigger.MEASURE_COMPLETE_EVENT_ID applies to SMU channel A)","Details","Set the stimulus of any trigger event detector to the value of this constant to have it respond to measure complete events from this SMU.","Also see","Triggering","smuX.trigger.MEASURE_COMPLETE_EVENT_ID","15173.html");
+Page[358]=new Array("This constant contains the pulse complete event number.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Constant","Yes","Usage","eventID = smuX.trigger.PULSE_COMPLETE_EVENT_ID","eventID","The pulse complete event number","X","Source‑measure unit (SMU) channel (for example, smua.trigger.PULSE_COMPLETE_EVENT_ID applies to SMU channel A)","Details","Set the stimulus of any trigger event detector to the value of this constant to have it respond to pulse complete events from this SMU.","Also see","Triggering","smuX.trigger.PULSE_COMPLETE_EVENT_ID","15174.html");
+Page[359]=new Array("This attribute enables or disables sweeping the source (on or off).","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Not saved","0 (smuX.DISABLE)","Usage","action = smuX.trigger.source.action","smuX.trigger.source.action = action","action","Sweep source action. Set to one of the following values:","0 or smuX.DISABLE: Do not sweep the source","1 or smuX.ENABLE: Sweep the source","X","Source‑measure unit (SMU) channel (for example, smua.trigger.source.action applies to SMU channel A)","Details","This attribute is used to enable or disable source level changes during a sweep. In addition to enabling the action before initiating the sweep, make sure to configure it using smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY().","Example","smua.trigger.source.listv({3, 1, 4, 5, 2})","smua.trigger.source.action = smua.ENABLE","Configure list sweep for SMU channel A (sweep through","3 V, 1 V, 4 V, 5 V, and 2 V).","Enable the source action.","Also see","smuX.trigger.source.linearY()","smuX.trigger.source.listY()","smuX.trigger.source.logY()","Triggering","smuX.trigger.source.action","15178.html");
+Page[360]=new Array("This attribute sets the sweep source limit.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Not saved","0 (smuX.LIMIT_AUTO)","Usage","sweepSourceLimit = smuX.trigger.source.limitY","smuX.trigger.source.limitY = sweepSourceLimit","sweepSourceLimit","Source limit during triggered operation; set to the desired source limit during triggered operation, smuX.LIMIT_AUTO, or smuX.LIMIT_OFF (for smuX.trigger.source.limiti)","X","Source‑measure unit (SMU) channel (for example, smua.trigger.source.limitv applies to SMU channel A)","Y","SMU output function (v = voltage, i = current)","Details","Use this attribute to perform extended operating area (EOA) pulse mode sweeps.","If this attribute is set to smuX.LIMIT_AUTO (or 0), the SMU will use the normal limit setting during sweeping. If this attribute is set to any other numeric value, the SMU will switch in this limit at the start of the source action and will switch back to the normal limit setting at the end of the end pulse action.","Normally, the limit range is automatically adjusted in accordance with the desired limit value. During sweeping, however, the limit range is fixed in order to avoid the delays associated with changing range. This fixed limit range is determined by the maximum limit value needed during the sweep; that is, the greater of either the normal limit value (as specified by smuX.source.limitY) or the sweep limit value (as specified by smuX.trigger.source.limitY). Note that the minimum limit value that can be enforced during the sweep is equal to 10 percent of the full scale value of the fixed limit range. If the smaller limit value (normal or sweep) falls below this 10% threshold, the 10 percent value will be enforced instead. Likewise, if the limit value were to fall below the 10 percent threshold as a result of power compliance, the 10 percent value will be enforced instead.","To disable the source current limit during triggered operation, set the smuX.trigger.source.limiti attribute equal to smuX.LIMIT_OFF (or "off").","When using the EOA, the SMU will automatically start the end pulse action if the SMU is not triggered before its maximum pulse width. It will also delay the source action if necessary to limit the pulse duty cycle to stay within the capabilities of the SMU.","Example","smua.trigger.source.limitv = 10","Sets the voltage sweep limit of SMU channel A to 10 V.","Also see","smuX.source.limitY","Configuring and running sweeps","Triggering","smuX.trigger.source.limitY","15179.html");
+Page[361]=new Array("This function configures a linear source sweep.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.trigger.source.linearY(startValue, endValue, points)","X","Source‑measure unit (SMU) channel (for example, smua.trigger.source.linearv(0, 10, 11) applies to SMU channel A)","Y","SMU source function (v = voltage, i = current)","startValue","Source value of the first point","endValue","Source value of the last point","points","The number of points used to calculate the step size","Details","This function configures the source action to be a linear source sweep in a subsequent sweep. During the sweep, the source will generate a uniform series of ascending or descending voltage or current changes called steps. The number of source steps is one less than the number of sourced points.","The points parameter does not set the number of steps in a sweep, but rather is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source will restart at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU will satisfy the trigger count by restarting the sweep values from the beginning. ","If the subsequent sweep has fewer points than specified in points, endValue will not be reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU will satisfy the trigger count and ignore the remaining source values.","In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep will return a stable value for the first measured point without penalizing remaining points in the sweep.","With linear sweeps it is acceptable to maintain a fixed source resolution over the entire sweep. To prevent source range changes during the sweep (especially when sweeping through 0.0), set the source range to a fixed range appropriate for the larger of either startValue or endValue. ","The SMU will only store the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.","Source functions cannot be changed within a sweep.","After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.","Example","smua.trigger.source.linearv(0, 10, 11)","Sweeps SMU channel A from 0 V to 10 V in 1 V steps.","Also see","smuX.trigger.source.action","smuX.trigger.source.listY()","smuX.trigger.source.logY()","Sweep Operation","smuX.trigger.source.linearY()","15180.html");
+Page[362]=new Array("This function configures an array-based source sweep.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.trigger.source.listY(sweepList)","X","Source‑measure unit (SMU) channel (for example, smua.trigger.source.listv({5}) applies to SMU channel A)","Y","SMU source function (v = voltage, i = current)","sweepList","An array of source values","Details","This function configures the source action to be a list sweep in a subsequent sweep. During the sweep, the source will output the sequence of source values given in the sweepList array.","If the subsequent sweep has more points than specified in sweepList, the source will restart at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU will satisfy the trigger count by restarting the sweep values from the beginning. ","If the subsequent sweep has fewer points than specified in sweepList, the extra values will be ignored. This means that if the trigger count is less than the number of source values configured, the SMU will satisfy the trigger count and ignore the remaining source values.","In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep will return a stable value for the first measured point without penalizing remaining points in the sweep.","The SMU will only store the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.","Source functions cannot be changed within a sweep.","After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.","Example","smua.trigger.source.listv({3, 1, 4, 5, 2})","Sweeps SMU channel A through 3 V, 1 V, 4 V, 5 V, and 2 V.","Also see","smuX.trigger.source.action","smuX.trigger.source.linearY()","smuX.trigger.source.logY()","Sweep Operation","smuX.trigger.source.listY()","15181.html");
+Page[363]=new Array("This function configures an exponential (geometric) source sweep.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.trigger.source.logY(startValue, endValue, points, asymptote)","X","Source-measure unit (SMU) channel (for example, smua.trigger.source.logv(1, 10, 11, 0) applies to SMU channel A)","Y","SMU source function (v = voltage, i = current)","startValue","Source value of the first point","endValue","Source value of the last point","points","The number of points used to calculate the step size","asymptote","The asymptotic offset value","Details","This function configures the source action to be a geometric source sweep in a subsequent sweep. During the sweep, the source generates a geometric series of ascending or descending voltage or current changes called steps. Each step is larger or smaller than the previous step by a fixed proportion. The constant of proportionality is determined by the starting value, the ending value, the asymptote, and the number of steps in the sweep. The number of source steps is one less than the number of sourced points.","The points parameter does not set the number of steps in a sweep, but rather is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. ","If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.","In cases where the first sweep point is nonzero, it may be necessary to precharge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.","With logarithmic sweeps, it is usually necessary to allow the source to autorange to maintain good source accuracy when sweeping over more than one decade or across range boundaries.","The asymptote parameter can be used to customize the inflection and offset of the source value curve. This allows log sweeps to cross zero. Setting this parameter to zero provides a conventional logarithmic sweep. The asymptote value is the value that the curve has at either positive or negative infinity, depending on the direction of the sweep.","The asymptote value must not be equal to or between the starting and ending values. It must be outside the range defined by the starting and ending values.","The SMU stores only the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.","Source functions cannot be changed within a sweep.","After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.","Example","smua.trigger.source.logv(1, 10, 11, 0)","Sweeps SMU channel A from 1 V to 10 V in 10 steps with an asymptote of 0 V.","Also see","smuX.trigger.source.action","smuX.trigger.source.linearY()","smuX.trigger.source.listY()","Sweep operation","smuX.trigger.source.logY()","15182.html");
+Page[364]=new Array("This function sets the source event detector to the detected state.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.trigger.source.set()","X","Source‑measure unit (SMU) channel (for example, smua.trigger.source.set() applies to SMU channel A)","Details","This function sets the source event detector to the detected state.","The SMU automatically clears all event detectors when the smuX.trigger.initiate() function is executed. This function should be called after the sweep is initiated. Make sure that if the event detectors are configured to clear automatically (because the smuX.trigger.autoclear attribute is set to smuX.ENABLE) that this command is issued after the SMU has entered the trigger layer.","Also see","smuX.trigger.arm.set()","smuX.trigger.autoclear","smuX.trigger.endpulse.set()","smuX.trigger.initiate()","smuX.trigger.measure.set()","Triggering","smuX.trigger.source.set()","15183.html");
+Page[365]=new Array("This attribute defines which event causes the source event detector to enter the detected state.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Not saved","0","Usage","eventID = smuX.trigger.source.stimulus","smuX.trigger.source.stimulus = eventID","eventID","Set to the event that triggers the end pulse source off action","X","Source‑measure (SMU) channel (for example, smua.trigger.source.stimulus applies to SMU channel A)","Details","Set this attribute to the event ID of any trigger event generator to wait for that event. When set, the SMU waits for the event at the source event detector portion of the trigger model. To bypass waiting for an event, set this attribute's value to zero (0). Set eventID to one of the existing trigger event IDs shown in the following table.","Trigger event IDs*","Event ID","Event description","smua.trigger.SWEEPING_EVENT_ID","Occurs when the source‑measure unit (SMU) transitions from the idle state to the arm layer of the trigger model","smua.trigger.ARMED_EVENT_ID","Occurs when the SMU moves from the arm layer to the trigger layer of the trigger model","smua.trigger.SOURCE_COMPLETE_EVENT_ID","Occurs when the SMU completes a source action","smua.trigger.MEASURE_COMPLETE_EVENT_ID","Occurs when the SMU completes a measure action","smua.trigger.PULSE_COMPLETE_EVENT_ID","Occurs when the SMU completes a pulse","smua.trigger.SWEEP_COMPLETE_EVENT_ID","Occurs when the SMU completes a sweep","smua.trigger.IDLE_EVENT_ID","Occurs when the SMU returns to the idle state","digio.trigger[N].EVENT_ID","Occurs when an edge is detected on a digital I/O line","tsplink.trigger[N].EVENT_ID","Occurs when an edge is detected on a TSP‑Link line","lan.trigger[N].EVENT_ID","Occurs when the appropriate LXI trigger packet is received on LAN trigger object N","display.trigger.EVENT_ID","Occurs when the TRIG key on the front panel is pressed","trigger.EVENT_ID","Occurs when a *TRG command is received on the remote interface","(GPIB only) Occurs when a GET bus command is received","(VXI-11 only) Occurs with the VXI-11 command device_trigger; reference the VXI-11 standard for additional details on the device trigger operation","trigger.blender[N].EVENT_ID","Occurs after a collection of events is detected","trigger.timer[N].EVENT_ID","Occurs when a delay expires","* Use the name of the trigger event ID to set the stimulus value rather than the numeric value. Using the name makes the code compatible for future upgrades (for example, if the numeric values must change when enhancements are added to the instrument).","Example","smua.trigger.source.stimulus = digio.trigger[2].EVENT_ID","Configure SMU channel A to start its source action when a trigger event occurs on digital I/O line 2.","Also see","Triggering","smuX.trigger.source.stimulus","15184.html");
+Page[366]=new Array("This constant contains the source complete event number.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Constant","Yes","Usage","eventID = smuX.trigger.SOURCE_COMPLETE_EVENT_ID","eventID","The source action complete event number","X","Source‑measure unit (SMU) channel (for example, smua.trigger.SOURCE_COMPLETE_EVENT_ID applies to SMU channel A)","Details","Set the stimulus of any trigger event detector to the value of this constant to have it respond to source complete events from this source‑measure unit (SMU).","Also see","Triggering","smuX.trigger.SOURCE_COMPLETE_EVENT_ID","15175.html");
+Page[367]=new Array("This constant contains the sweep complete event number.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Constant","Yes","Usage","eventID = smuX.trigger.SWEEP_COMPLETE_EVENT_ID","eventID","The sweep complete event number","X","Source‑measure unit (SMU) channel (for example, smua.trigger.SWEEP_COMPLETE_EVENT_ID applies to SMU channel A)","Details","Set the stimulus of any trigger event detector to the value of this constant to have it respond to sweep complete events from this SMU.","Also see","Triggering","smuX.trigger.SWEEP_COMPLETE_EVENT_ID","15176.html");
+Page[368]=new Array("This constant contains the sweeping event number.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Constant","Yes","Usage","eventID = smuX.trigger.SWEEPING_EVENT_ID","eventID","The sweeping event number","X","Source‑measure unit (SMU) channel (for example, smua.trigger.SWEEPING_EVENT_ID applies to SMU channel A)","Details","Set the stimulus of any trigger event detector to the value of this constant to have it respond to sweeping events from this SMU.","Also see","Triggering","smuX.trigger.SWEEPING_EVENT_ID","15177.html");
+Page[369]=new Array("This attribute stores the status byte condition register.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not saved","Not applicable","Usage","statusByte = status.condition","statusByte","The status byte; a zero (0) indicates no bits set; other values indicate various bit settings","Details","This attribute is used to read the status byte, which is returned as a numeric value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000 0001. This value indicates that bit B0 and bit B7 are set.","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">","*","1","0","0","0","0","0","0","1","* Least significant bit ** Most significant bit ","The returned value can indicate one or more status events occurred. When an enabled status event occurs, a summary bit is set in this register to indicate the event occurrence."," The individual bits of this register have the following meanings:","Bit","Value","Description","B0","status.MEASUREMENT_SUMMARY_BIT","status.MSB","Set summary bit indicates that an enabled measurement event has occurred. ","Bit B0 decimal value: 1","B1","status.SYSTEM_SUMMARY_BIT","status.SSB","Set summary bit indicates that an enabled system event has occurred.","Bit B1 decimal value: 2","B2","status.ERROR_AVAILABLE","status.EAV","Set summary bit indicates that an error or status message is present in the Error Queue. ","Bit B2 decimal value: 4","B3","status.QUESTIONABLE_SUMMARY_BIT","status.QSB","Set summary bit indicates that an enabled questionable event has occurred. ","Bit B3 decimal value: 8","B4","status.MESSAGE_AVAILABLE","status.MAV","Set summary bit indicates that a response message is present in the Output Queue. ","Bit B4 decimal value: 16","B5","status.EVENT_SUMMARY_BIT","status.ESB","Set summary bit indicates that an enabled standard event has occurred. ","Bit B5 decimal value: 32","B6","status.MASTER_SUMMARY_STATUS","status.MSS","Request Service (RQS)/Master Summary Status (MSS). Depending on how it is used, bit B6 of the status byte register is either the Request for Service (RQS) bit or the Master Summary Status (MSS) bit:","When using the GPIB or VXI-11 serial poll sequence of the Model 2651A to obtain the status byte (serial poll byte), B6 is the RQS bit. The set bit indicates that the Request Service (RQS) bit of the status byte (serial poll byte) is set and a serial poll (SRQ) has occurred. ","When using the status.condition register command or the *STB? common command to read the status byte, B6 is the MSS bit. Set bit indicates that an enabled summary bit of the status byte register is set.","Bit B6 decimal value: 64","B7","status.OPERATION_SUMMARY_BIT","status.OSB","Set summary bit indicates that an enabled operation event has occurred.","Bit B7 decimal value: 128","In addition to the above constants, when more than one bit of the register is set, statusByte equals the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Example","statusByte = status.condition","print(statusByte)","Returns statusByte.","Sample output:","1.29000e+02","Converting this output (129) to its binary equivalent yields 1000 0001 ","Therefore, this output indicates that the set bits of the status byte condition register are presently B0 (MSS) and B7 (OSB).","Also see","Status model overview","Status byte and service request (SRQ)","status.condition","15822.html");
+Page[370]=new Array("This attribute contains the measurement event register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","10,627 (All bits set)","Usage","measurementRegister = status.measurement.condition","measurementRegister = status.measurement.enable","measurementRegister = status.measurement.event","measurementRegister = status.measurement.ntr","measurementRegister = status.measurement.ptr","status.measurement.enable = measurementRegister","status.measurement.ntr = measurementRegister","status.measurement.ptr = measurementRegister","measurementRegister","The measurement event register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","Details","These attributes read or write the measurement event registers.","Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. ","For example, assume value 257 is returned for the enable register. The binary equivalent is 0000 0001 0000 0001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","0","0","0","0","0","1","0","0","0","0","0","0","0","1","* Least significant bit ** Most significant bit","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","status.measurement.VOLTAGE_LIMIT status.measurement.VLMT","Set bit is a summary of the status.measurement.voltage_limit register.","Bit B0 decimal value: 1","B1","status.measurement.CURRENT_LIMIT","status.measurement.ILMT","Set bit is a summary of the status.measurement.current_limit register.","Bit B1 decimal value: 2","B2-B6","Not used","Not applicable","B7","status.measurement.READING_OVERFLOW status.measurement.ROF","Set bit is a summary of the status.measurement.reading_overflow register.","Bit B7 decimal value: 128","B8","status.measurement.BUFFER_AVAILABLE status.measurement.BAV","Set bit is a summary of the status.measurement.buffer_available register.","Bit B8 decimal value: 256","B9-B10","Not used","Not applicable","B11","status.measurement.OUTPUT_ENABLE status.measurement.OE","Set bit indicates that output enable has been asserted.","Bit B11 decimal value: 2048","B12","Not used","Not applicable","B13","status.measurement.INSTRUMENT_SUMMARY status.measurement.INST","Set bit indicates that a bit in the measurement instrument summary register is set.","Bit B13 decimal value: 8192","B14-B15","Not used","Not applicable","As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV.","In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8,192","4,096","2,048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Example","status.measurement.enable = status.measurement.BAV","Sets the BAV bit of the measurement event enable register.","Also see","Measurement event registers","status.measurement.*","15823.html");
+Page[371]=new Array("This attribute contains the measurement event buffer available summary register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","2 (All bits set)","Usage","measurementRegister = status.measurement.buffer_available.condition","measurementRegister = status.measurement.buffer_available.enable","measurementRegister = status.measurement.buffer_available.event","measurementRegister = status.measurement.buffer_available.ntr","measurementRegister = status.measurement.buffer_available.ptr","status.measurement.buffer_available.enable = measurementRegister","status.measurement.buffer_available.ntr = measurementRegister","status.measurement.buffer_available.ptr = measurementRegister","measurementRegister","The measurement event register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 2","Details","These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000 0000 0000 0010. This value indicates that bit B1 (SMUA) is set.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable.","B1","status.measurement.buffer_available.SMUA","Set bit indicates that there is at least one reading stored in either or both of the dedicated reading buffers.","Bit B1 decimal value: 2","Binary value: 0000 0010","B2-B15","Not used","Not applicable.","As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.","In addition to the above constant, measurementRegister can be set to the decimal equivalent of the bit to set.","Example","status.measurement.buffer_available.enable ="," status.measurement.buffer_available.SMUA","Sets the SMUA bit of the measurement event buffer available summary enable register.","Also see","Measurement event registers","status.measurement.buffer_available.*","15824.html");
+Page[372]=new Array("This attribute contains the measurement event current limit summary registers.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","2 (All bits set)","Usage","measurementRegister = status.measurement.current_limit.condition","measurementRegister = status.measurement.current_limit.enable","measurementRegister = status.measurement.current_limit.event","measurementRegister = status.measurement.current_limit.ntr","measurementRegister = status.measurement.current_limit.ptr","status.measurement.current_limit.enable = measurementRegister","status.measurement.current_limit.ntr = measurementRegister","status.measurement.current_limit.ptr = measurementRegister","measurementRegister","The measurement event current limit summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 2","Details","These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000 0000 0000 0010. This value indicates that bit B1 (SMUA) is set.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable.","B1","status.measurement.current_limit.SMUA","Set bit indicates that the current limit was exceeded.","Bit B1 decimal value: 2","Binary value: 0000 0010","B2-B15","Not used","Not applicable.","As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.","In addition to the above constant, measurementRegister can be set to the decimal equivalent of the bit to set.","Example","status.measurement.current_limit.enable ="," status.measurement.current_limit.SMUA","Sets the SMUA bit of the measurement event current limit summary enable register.","Also see","Measurement event registers","status.measurement.instrument.smuX.*","status.measurement.current_limit.*","15825.html");
+Page[373]=new Array("This attribute contains the registers of the measurement event instrument summary register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","2 (All bits set)","Usage","measurementRegister = status.measurement.instrument.condition","measurementRegister = status.measurement.instrument.enable","measurementRegister = status.measurement.instrument.event","measurementRegister = status.measurement.instrument.ntr","measurementRegister = status.measurement.instrument.ptr","status.measurement.instrument.enable = measurementRegister","status.measurement.instrument.ntr = measurementRegister","status.measurement.instrument.ptr = measurementRegister","measurementRegister","The measurement event instrument summary register status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","Details","These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000 0000 0000 0010. This value indicates that bit B1 (SMUA) is set.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable.","B1","status.measurement.instrument.SMUA","Set bit indicates one or more enabled bits of the measurement event SMU A summary register is set.","Bit B1 decimal value: 2","Binary value: 0000 0010","B2-B15","Not used","Not applicable.","As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.","In addition to the above constant, measurementRegister can be set to the decimal equivalent of the bit to set.","Example","status.measurement.instrument.enable ="," status.measurement.instrument.SMUA","Sets the SMU A bit of the measurement event instrument summary enable register using a constant.","Also see","Measurement event registers","status.measurement.instrument.*","15826.html");
+Page[374]=new Array("This attribute contains the registers of the measurement event SMU X summary register set. ","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","387 (All bits set) ","Usage","measurementRegister = status.measurement.instrument.smuX.condition","measurementRegister = status.measurement.instrument.smuX.enable","measurementRegister = status.measurement.instrument.smuX.event","measurementRegister = status.measurement.instrument.smuX.ntr","measurementRegister = status.measurement.instrument.smuX.ptr","status.measurement.instrument.smuX.enable = measurementRegister","status.measurement.instrument.smuX.ntr = measurementRegister","status.measurement.instrument.smuX.ptr = measurementRegister ","measurementRegister","The instrument measurement status SMU X summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","X","Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)","Details","These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000 0001 0000 0001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","0","0","0","0","0","1","0","0","0","0","0","0","0","1","* Least significant bit ** Most significant bit ","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0*","status.measurement.instrument.smuX.VOLTAGE_LIMIT","status.measurement.instrument.smuX.VLMT","Set bit indicates that the voltage limit was exceeded.","Bit B0 decimal value: 1","B1*","status.measurement.instrument.smuX.CURRENT_LIMIT","status.measurement.instrument.smuX.ILMT","Set bit indicates that the current limit was exceeded.","Bit B1 decimal value: 2","B2-B6","Not used","Not applicable.","B7","status.measurement.instrument.smuX.READING_OVERFLOW","status.measurement.instrument.smuX.ROF","Set bit indicates that an overflow reading has been detected.","Bit B7 decimal value: 128","B8","status.measurement.instrument.smuX.BUFFER_AVAILABLE","status.measurement.instrument.smuX.BAV","Set bit indicates that there is at least one reading stored in either or both of the dedicated reading buffers.","Bit B8 decimal value: 256","B9-B15","Not used","Not applicable.","* This bit will be updated only when a measurement is taken or smuX.source.compliance is invoked.","As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.","In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8,192","4,096","2,048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Example","status.measurement.instrument.smua.enable ="," status.measurement.instrument.smua.VLMT","Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.","Also see","Measurement event registers","status.measurement.instrument.smuX.*","15827.html");
+Page[375]=new Array("This attribute contains the measurement event reading overflow summary register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","2 (All bits set)","Usage","measurementRegister = status.measurement.reading_overflow.condition","measurementRegister = status.measurement.reading_overflow.enable","measurementRegister = status.measurement.reading_overflow.event","measurementRegister = status.measurement.reading_overflow.ntr","measurementRegister = status.measurement.reading_overflow.ptr","status.measurement.reading_overflow.enable = measurementRegister","status.measurement.reading_overflow.ntr = measurementRegister","status.measurement.reading_overflow.ptr = measurementRegister","measurementRegister","The measurement reading overflow summary register status. A zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 2","Details","These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000 0000 0000 0010. This value indicates that bit B1 (SMUA) is set.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable.","B1","status.measurement.reading_overflow.SMUA","Set bit indicates that an overflow reading has been detected.","Bit B1 decimal value: 2","Binary value: 0000 0010","B2-B15","Not used","Not applicable.","As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.","In addition to the above constant, measurementRegister can be set to the numeric equivalent of the bit to set.","Example","status.measurement.reading_overflow.enable ="," status.measurement.reading_overflow.SMUA","Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.","Also see","Measurement event registers","status.measurement.reading_overflow.*","15828.html");
+Page[376]=new Array("This attribute contains the measurement event voltage limit summary register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","2 (All bits set)","Usage","measurementRegister = status.measurement.voltage_limit.condition","measurementRegister = status.measurement.voltage_limit.enable","measurementRegister = status.measurement.voltage_limit.event","measurementRegister = status.measurement.voltage_limit.ntr","measurementRegister = status.measurement.voltage_limit.ptr","status.measurement.voltage_limit.enable = measurementRegister","status.measurement.voltage_limit.ntr = measurementRegister","status.measurement.voltage_limit.ptr = measurementRegister","measurementRegister","The measurement voltage limit summary register status. A zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 2","Details","These attributes are used to read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable.","B1","status.measurement.voltage_limit.SMUA","Set bit indicates that the voltage limit was exceeded.","Bit B1 decimal value: 2","Binary value: 0000 0010","B2-B15","Not used","Not applicable.","As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.","In addition to the above constant, measurementRegister can be set to the numeric equivalent of the bit to set.","Example","status.measurement.voltage_limit.enable ="," status.measurement.voltage_limit.SMUA","Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.","Also see","Measurement event registers","status.measurement.voltage_limit.*","15829.html");
+Page[377]=new Array("This attribute stores the system node enable register.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Status reset","Not saved","0","Usage","nodeEnableRegister = status.node_enable","status.node_enable = nodeEnableRegister","nodeEnableRegister","The system node enable register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","Details","This attribute is used to read or write to the system node enable register. Reading the system node enable register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, assume the value of 1.29000e+02 (which is 129) is returned for the system node enable register, the binary equivalent is 1000 0001. This value indicates that bit B0 and bit B7 are set.","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">","**","1","0","0","0","0","0","0","1","* Least significant bit ** Most significant bit"," Assigning a value to this attribute enables one or more status events. When an enabled status event occurs, a summary bit is set in the appropriate system summary register. The register and bit that is set depends on the TSP-Link node number assigned to this instrument.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","status.MEASUREMENT_SUMMARY_BIT status.MSB","Set summary bit indicates that an enabled measurement event has occurred. ","Bit B0 decimal value: 1","B1","Not used","Not applicable.","B2","status.ERROR_AVAILABLE status.EAV","Set summary bit indicates that an error or status message is present in the Error Queue. ","Bit B2 decimal value: 4","B3","status.QUESTIONABLE_SUMMARY_BIT status.QSB","Set summary bit indicates that an enabled questionable event has occurred. ","Bit B3 decimal value: 8","B4","status.MESSAGE_AVAILABLE status.MAV","Set summary bit indicates that a response message is present in the Output Queue. ","Bit B4 decimal value: 16","B5","status.EVENT_SUMMARY_BIT status.ESB","Set summary bit indicates that an enabled standard event has occurred. ","Bit B5 decimal value: 32","B6","status.MASTER_SUMMARY_STATUS status.MSS","Set bit indicates that an enabled Master Summary Status (MSS) bit of the Status Byte Register is set.","Bit B6 decimal value: 64","B7","status.OPERATION_SUMMARY_BIT status.OSB","Set summary bit indicates that an enabled operation event has occurred. ","Bit B7 decimal value: 128","As an example, to set the B0 bit of the system node enable register, set status.node_enable = status.MSB.","In addition to the above values, nodeEnableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set nodeEnableRegister to the sum of their decimal weights. For example, to set bits B0 and B7, set nodeEnableRegister to 129 (1 + 128).","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Example 1","nodeEnableRegister = status.MSB + status.OSB","status.node_enable = nodeEnableRegister","Sets the MSB and OSB bits of the system node enable register using constants.","Example 2","-- decimal 129 = binary 10000001","nodeEnableRegister = 129","status.node_enable = nodeEnableRegister","Sets the MSB and OSB bits of the system node enable register using a decimal value.","Also see","status.condition","status.system.*","Status model overview","Status byte and service request (SRQ)","status.node_enable","15830.html");
+Page[378]=new Array("This attribute stores the status node event register.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not saved","0","Usage","nodeEventRegister = status.node_event","nodeEventRegister","The node event register's status; a zero (0) indicates no bits set; other values indicate various bit settings","Details","This attribute is used to read the status node event register, which is returned as a numeric value (reading this register returns a value). The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000 0001. This value indicates that bit B0 and bit B7 are set.","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">","*","1","0","0","0","0","0","0","1","* Least significant bit ** Most significant bit ","The returned value can indicate one or more status events occurred.","Bit","Value","Description","B0","status.MEASUREMENT_SUMMARY_BIT status.MSB","Set summary bit indicates that an enabled measurement event has occurred. ","Bit B0 decimal value: 1","B1","Not used","Not applicable","B2","status.ERROR_AVAILABLE status.EAV","Set summary bit indicates that an error or status message is present in the Error Queue. ","Bit B2 decimal value: 4","B3","status.QUESTIONABLE_SUMMARY_BIT status.QSB","Set summary bit indicates that an enabled questionable event has occurred. ","Bit B3 decimal value: 8","B4","status.MESSAGE_AVAILABLE status.MAV","Set summary bit indicates that a response message is present in the Output Queue. ","Bit B4 decimal value: 16","B5","status.EVENT_SUMMARY_BIT status.ESB","Set summary bit indicates that an enabled standard event has occurred. ","Bit B5 decimal value: 32","B6","status.MASTER_SUMMARY_STATUS status.MSS","Set bit indicates that an enabled Master Summary Status (MSS) bit of the Status Byte register is set.","Bit B6 decimal value: 64","B7","status.OPERATION_SUMMARY_BIT status.OSB","Set summary bit indicates that an enabled operation event has occurred. ","Bit B7 decimal value: 128","In addition to the above constants, nodeEventRegister can be set to the decimal equivalent of the bit(s) set. When more than one bit of the register is set, nodeEventRegister contains the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Example","nodeEventRegister = status.node_event","print(nodeEventRegister)","Reads the status node event register.","Sample output:","1.29000e+02","Converting this output (129) to its binary equivalent yields 1000 0001 ","Therefore, this output indicates that the set bits of the status byte condition register are presently B0 (MSB) and B7 (OSB).","Also see","status.condition","status.system.*","Status model overview","Status byte and service request (SRQ)","status.node_event","15831.html");
+Page[379]=new Array("These attributes manage the status model's operation status register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","31,769 (All bits set)","Usage","operationRegister = status.operation.condition","operationRegister = status.operation.enable","operationRegister = status.operation.event","operationRegister = status.operation.ntr","operationRegister = status.operation.ptr","status.operation.enable = operationRegister","status.operation.ntr = operationRegister","status.operation.ptr = operationRegister","operationRegister","The operation status register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","Details","These attributes read or write the operation status registers.","Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101 0000 0000 0000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","1","0","1","0","0","0","0","0","0","0","0","0","0","0","0","* Least significant bit ** Most significant bit","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","status.operation.CALIBRATING","status.operation.CAL","Set bit indicates that the summary bit of the status.operation.calibrating register has been set.","Bit B0 decimal value: 1","B1-B2","Not used","Not applicable","B3","status.operation.SWEEPING","status.operation.SWE","Set bit indicates that the summary bit from the status.operation.sweeping register is set.","Bit B3 decimal value: 8","B4","status.operation.MEASURING","status.operation.MEAS","Set bit indicates that the summary bit of the status.operation.measuring register is set.","Bit B4 decimal value: 16","B5-B9","Not used","Not applicable","B10","status.operation.TRIGGER_OVERRUN","status.operation.TRGOVR","Set bit indicates that the summary bit from the","status.operation.trigger_overrun register is set.","Bit B10 decimal value: 1024","B11","status.operation.REMOTE_SUMMARY","status.operation.REM","Set bit indicates that the summary bit of the status.operation.remote register is set. ","Bit B11 decimal value: 2048","B12","status.operation.USER","Set bit indicates that the summary bit from the status.operation.user register is set.","Bit B12 decimal value: 4096","B13","status.operation.INSTRUMENT_SUMMARY","status.operation.INST","Set bit indicates that the summary bit from the status.operation.instrument register is set.","Bit B13 decimal value: 8192","B14","status.operation.ROGRAM_RUNNING","status.operation.PROG","Set bit indicates that a command or program is running.","Bit B14 decimal value: 16,384","B15","Not used","Not applicable","As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.","In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4096 + 16,384). ","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8,192","4,096","2,048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Example 1","operationRegister = status.operation.USER +"," status.operation.PROG","status.operation.enable = operationRegister","Sets the USER and PROG bits of the operation status enable register using constants.","Example 2","-- decimal 20480 = binary 0101 0000 0000 0000","operationRegister = 20480","status.operation.enable = operationRegister","Sets the USER and PROG bits of the operation status enable register using a decimal value.","Also see","Operation Status Registers","status.operation.*","15833.html");
+Page[380]=new Array("This attribute contains the operation status calibration summary register set. ","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","2 (All bits set)","Usage","operationRegister = status.operation.calibrating.condition","operationRegister = status.operation.calibrating.enable","operationRegister = status.operation.calibrating.event","operationRegister = status.operation.calibrating.ntr","operationRegister = status.operation.calibrating.ptr","status.operation.calibrating.enable = operationRegister","status.operation.calibrating.ntr = operationRegister","status.operation.calibrating.ptr = operationRegister ","operationRegister","The operation calibrating event register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 2","Details","These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable.","B1","status.operation.calibrating.SMUA","Set bit indicates that SMU A is unlocked for calibration.","Bit B1 decimal value: 2","Binary value: 0000 0010","B2-B15","Not used","Not applicable.","As an example, to set bit B1 of the operation status calibration summary enable register, set status.operation.calibrating.enable = status.operation.calibrating.SMUA.","In addition to the above constant, operationRegister can be set to the decimal equivalent of the bit to set.","Example","status.operation.calibrating.enable ="," status.operation.calibrating.SMUA","Sets the SMUA bit of the operation status calibration summary enable register using a constant.","Also see","Operation Status Registers","status.operation.*","status.operation.calibrating.*","15834.html");
+Page[381]=new Array("This attribute contains the operation status instrument summary register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","31,746 (All bits set)","Usage","operationRegister = status.operation.instrument.condition","operationRegister = status.operation.instrument.enable","operationRegister = status.operation.instrument.event","operationRegister = status.operation.instrument.ntr","operationRegister = status.operation.instrument.ptr","status.operation.instrument.enable = operationRegister","status.operation.instrument.ntr = operationRegister","status.operation.instrument.ptr = operationRegister ","operationRegister","The operation event register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","Details","These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000 0100 0000 0010. This value indicates that bit B1 and bit B10 are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","0","0","0","1","0","0","0","0","0","0","0","0","1","0","* Least significant bit ** Most significant bit ","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable.","B1","status.operation.instrument.SMUA","Set bit indicates one or more enabled bits for the operation status SMU A summary register is set.","Bit B1 decimal value: 2","B2-B9","Not used","Not applicable.","B10","status.operation.instrument.TRIGGER_BLENDER","status.operation.instrument.TRGBLND","Set bit indicates one or more enabled bits for the operation status trigger blender summary register is set.","Bit B10 decimal value: 1024.","B11","status.operation.instrument.TRIGGER_TIMER","status.operation.instrument.TRGTMR","Set bit indicates one or more enabled bits for the operation status trigger timer summary register is set.","Bit B11 decimal value: 2048","B12","status.operation.instrument.DIGITAL_IO","status.operation.instrument.DIGIO","Set bit indicates one or more enabled bits for the operation status digital I/O summary register is set.","Bit B12 decimal value: 4096","B13","status.operation.instrument.TSPLINK","Set bit indicates one or more enabled bits for the operation status TSP-Link summary register is set.","Bit B13 decimal value: 8192","B14","status.operation.instrument.LAN","Set bit indicates one or more enabled bits for the operation status LAN summary register is set.","Bit B14 decimal value: 16,384","B15","Not used","Not applicable.","As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.","In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8,192","4,096","2,048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Example 1","operationRegister = status.operation.instrument.SMUA +"," status.operation.instrument.TRGBLND","status.operation.instrument.enable = operationRegister","Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.","Example 2","-- 1026 = binary 0000 0100 0000 0010","operationRegister = 1026","status.operation.instrument.enable = operationRegister","Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.","Also see","status.operation.*","Condition register sets of:","• status.operation.instrument.trigger_blender.*","• status.operation.instrument.trigger_timer.*","• status.operation.instrument.digio.*","• status.operation.instrument.tsplink.*","• status.operation.instrument.lan.*","Operation Status Registers","status.operation.instrument.*","15835.html");
+Page[382]=new Array("This attribute contains the operation status digital I/O summary register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","1024 (All bits set)","Usage","operationRegister = status.operation.instrument.digio.condition","operationRegister = status.operation.instrument.digio.enable","operationRegister = status.operation.instrument.digio.event","operationRegister = status.operation.instrument.digio.ntr","operationRegister = status.operation.instrument.digio.ptr","status.operation.instrument.digio.enable = operationRegister","status.operation.instrument.digio.ntr = operationRegister","status.operation.instrument.digio.ptr = operationRegister ","operationRegister","The operation status digital I/O summary register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024","Details","These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0-B9","Not used","Not applicable","B10","status.operation.instrument.digio.TRIGGER_OVERRUN","status.operation.instrument.digio.TRGOVR","Set bit indicates an enabled bit in the Operation Status Digital I/O Overrun Register is set.","Bit B10 decimal value: 1024","Binary value: 0100 0000 0010","B11-B15","Not used","Not applicable","In addition to the above constant, operationRegister can be set to the decimal equivalent of the bit to set.","Example","status.operation.instrument.digio.enable ="," status.operation.instrument.digio.TRGOVR","Sets the TRGOVR bit of the operation status digital I/O summary enable register using a constant.","Also see","Operation Status Registers","status.operation.instrument.digio.trigger_overrun.*","status.operation.instrument.digio.*","15836.html");
+Page[383]=new Array("This attribute contains the operation status digital I/O overrun register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","32,766 (All bits set)","Usage","operationRegister = status.operation.instrument.digio.trigger_overrun.condition","operationRegister = status.operation.instrument.digio.trigger_overrun.enable","operationRegister = status.operation.instrument.digio.trigger_overrun.event","operationRegister = status.operation.instrument.digio.trigger_overrun.ntr","operationRegister = status.operation.instrument.digio.trigger_overrun.ptr","status.operation.instrument.digio.trigger_overrun.enable = operationRegister","status.operation.instrument.digio.trigger_overrun.ntr = operationRegister","status.operation.instrument.digio.trigger_overrun.ptr = operationRegister ","operationRegister","The operation status digio I/O overrun register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","Details","These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000 0100 0000 0010. This value indicates that bit b1 and bit B10 are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","0","0","0","1","0","0","0","0","0","0","0","0","1","0","* Least significant bit ** Most significant bit ","A set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable","B1","status.operation.instrument.digio.trigger_overrun.LINE1","Bit B1 decimal value: 2","B2","status.operation.instrument.digio.trigger_overrun.LINE2","Bit B2 decimal value: 4","B3","status.operation.instrument.digio.trigger_overrun.LINE3","Bit B3 decimal value: 8","B4","status.operation.instrument.digio.trigger_overrun.LINE4","Bit B4 decimal value: 16","B5","status.operation.instrument.digio.trigger_overrun.LINE5","Bit B5 decimal value: 32","B6","status.operation.instrument.digio.trigger_overrun.LINE6","Bit B6 decimal value: 64","B7","status.operation.instrument.digio.trigger_overrun.LINE7","Bit B7 decimal value: 128","B8","status.operation.instrument.digio.trigger_overrun.LINE8","Bit B8 decimal value: 256","B9","status.operation.instrument.digio.trigger_overrun.LINE9","Bit B9 decimal value: 512","B10","status.operation.instrument.digio.trigger_overrun.LINE10","Bit B10 decimal value: 1024","B11","status.operation.instrument.digio.trigger_overrun.LINE11","Bit B11 decimal value: 2048","B12","status.operation.instrument.digio.trigger_overrun.LINE12","Bit B12 decimal value: 4096","B13","status.operation.instrument.digio.trigger_overrun.LINE13","Bit B13 decimal value: 8192","B14","status.operation.instrument.digio.trigger_overrun.LINE14","Bit B14 decimal value: 16,384","B15","Not used","Not applicable","As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.","In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8,192","4,096","2,048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Example 1","operationRegister ="," status.operation.instrument.digio.trigger_overrun.LINE1 +"," status.operation.instrument.digio.trigger_overrun.LINE10","status.operation.instrument.digio.trigger_overrun.enable ="," operationRegister","Sets bit B1 and bit B10 of the operation status digital I/O overrun enable register using constants.","Also see","Operation Status Registers","status.operation.instrument.digio.*","status.operation.instrument.digio.trigger_overrun.*","15837.html");
+Page[384]=new Array("This attribute contains the operation status LAN summary register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","1027 (All bits set)","Usage","operationRegister = status.operation.instrument.lan.condition","operationRegister = status.operation.instrument.lan.enable","operationRegister = status.operation.instrument.lan.event","operationRegister = status.operation.instrument.lan.ntr","operationRegister = status.operation.instrument.lan.ptr","status.operation.instrument.lan.enable = operationRegister","status.operation.instrument.lan.ntr = operationRegister","status.operation.instrument.lan.ptr = operationRegister ","operationRegister","The operation status lan summary register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","Details","These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000 0100 0000 0010. This value indicates that bit B1 and bit B10 are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","0","0","0","1","0","0","0","0","0","0","0","0","1","0","* Least significant bit ** Most significant bit ","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","status.operation.instrument.lan.CONNECTION","status.operation.instrument.lan.CON","Set bit indicates that the LAN cable is connected and a link has been detected.","Bit B0 decimal value: 1","B1","status.operation.instrument.lan.CONFIGURING","status.operation.instrument.lan.CONF","Set bit indicates the LAN is performing its configuration sequence.","Bit B1 decimal value: 2","B2-B9","Not used","Not available","B10","status.operation.instrument.lan.TRIGGER_OVERRUN","status.operation.instrument.lan.TRGOVR","Set bit indicates one or more enabled bits for the operation status LAN trigger overrun register is set.","Bit B10 decimal value: 1024","B11-B15","Not used","Not applicable","As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.","In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8,192","4,096","2,048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Example","operationRegister ="," status.operation.instrument.lan.CONF +"," status.operation.instrument.lan.TRGOVR","status.operation.instrument.lan.enable = operationRegister","Sets bit B1 and bit B10 of the operation status lan summary enable register using constants.","Also see","Operation Status Registers","status.operation.instrument.lan.trigger_overrun.*","status.operation.instrument.lan.*","15838.html");
+Page[385]=new Array("This attribute contains the operation status LAN trigger overrun register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","510 (All bits set)","Usage","operationRegister = status.operation.instrument.lan.trigger_overrun.condition","operationRegister = status.operation.instrument.lan.trigger_overrun.enable","operationRegister = status.operation.instrument.lan.trigger_overrun.event","operationRegister = status.operation.instrument.lan.trigger_overrun.ntr","operationRegister = status.operation.instrument.lan.trigger_overrun.ptr","status.operation.instrument.lan.trigger_overrun.enable = operationRegister","status.operation.instrument.lan.trigger_overrun.ntr = operationRegister","status.operation.instrument.lan.trigger_overrun.ptr = operationRegister ","operationRegister","The operation status lan trigger overrun register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","Details","These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000 0001 0000 0010. This value indicates that bit B1 and bit B8 are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","0","0","0","0","0","1","0","0","0","0","0","0","1","0","* Least significant bit ** Most significant bit ","A set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable","B1","status.operation.instrument.lan.trigger_overrun.LAN1","Bit B1 decimal value: 2","B2","status.operation.instrument.lan.trigger_overrun.LAN2","Bit B2 decimal value: 4","B3","status.operation.instrument.lan.trigger_overrun.LAN3","Bit B3 decimal value: 8","B4","status.operation.instrument.lan.trigger_overrun.LAN4","Bit B4 decimal value: 16","B5","status.operation.instrument.lan.trigger_overrun.LAN5","Bit B5 decimal value: 32","B6","status.operation.instrument.lan.trigger_overrun.LAN6","Bit B6 decimal value: 64","B7","status.operation.instrument.lan.trigger_overrun.LAN7","Bit B7 decimal value: 128","B8","status.operation.instrument.lan.trigger_overrun.LAN8","Bit B8 decimal value: 256","B9-B15","Not used","Not applicable","As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.","In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256). ","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8,192","4,096","2,048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Example","operationRegister = "," status.operation.instrument.lan.trigger_overrun.LAN1 +"," status.operation.instrument.lan.trigger_overrun.LAN8","status.operation.instrument.lan.trigger_overrun.enable ="," operationRegister","Sets bit B1 and bit B8 of the operation status lan trigger overrun enable register using constants.","Also see","Operation Status Registers","status.operation.instrument.lan.*","status.operation.instrument.lan.trigger_overrun.*","15839.html");
+Page[386]=new Array("This attribute contains the operation status SMU X summary register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","1049 (All bits set)","Usage","operationRegister = status.operation.instrument.smuX.condition","operationRegister = status.operation.instrument.smuX.enable","operationRegister = status.operation.instrument.smuX.event","operationRegister = status.operation.instrument.smuX.ntr","operationRegister = status.operation.instrument.smuX.ptr","status.operation.instrument.smuX.enable = operationRegister","status.operation.instrument.smuX.ntr = operationRegister","status.operation.instrument.smuX.ptr = operationRegister ","operationRegister","The operation status SMU X summary register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","X","Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel A)","Details","These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1025) is read as the value of the condition register, the binary equivalent is 0000 0100 0000 0010. This value indicates that bit B0 and bit B10 are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","0","0","0","1","0","0","0","0","0","0","0","0","1","0","* Least significant bit ** Most significant bit ","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","status.operation.instrument.smuX.CALIBRATING","status.operation.instrument.smuX.CAL","Set bit indicates that smuX is unlocked for calibration.","Bit B0 decimal value: 1","B1-B2","Not used","Not applicable.","B3","status.operation.instrument.smuX.SWEEPING","status.operation.instrument.smuX.SWE","Set bit indicates that smuX is sweeping.","Bit B3 decimal value: 8","B4","status.operation.instrument.smuX.MEASURING","status.operation.instrument.smuX.MEAS","Bit will be set when taking an overlapped measurement, but it will not set when taking a normal synchronous measurement.","Bit B4 decimal value: 16","B5-B9","Not used","Not applicable.","B10","status.operation.instrument.smuX.TRIGGER_OVERRUN","status.operation.instrument.smuX.TRGOVR","Set bit indicates an enabled bit has been set in the operation status smu X trigger overrun event register.","Bit B10 decimal value: 1024","B11-B15","Not used","Not applicable.","As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.","In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1025 (which is the sum of 1 + 1024). ","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8,192","4,096","2,048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Example","status.operation.instrument.smua.enable ="," status.operation.instrument.smua.MEAS","Sets the MEAS bit of the operation status SMU A summary enable register using a constant.","Also see","Operation Status Registers","status.operation.instrument.smuX.trigger_overrrun.*","status.operation.instrument.smuX.*","15840.html");
+Page[387]=new Array("This attribute contains the operation status SMU X trigger overrun register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","30 (All bits set)","Usage","operationRegister = status.operation.instrument.smuX.trigger_overrun.condition","operationRegister = status.operation.instrument.smuX.trigger_overrun.enable","operationRegister = status.operation.instrument.smuX.trigger_overrun.event","operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr","operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr","status.operation.instrument.smuX.trigger_overrun.enable = operationRegister","status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister","status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister ","operationRegister","The operation status SMU X trigger overrun register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","Details","These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000 0001 0010. This value indicates that bit B1 and bit B4 are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","0","0","0","0","0","0","0","0","0","1","0","0","1","0","* Least significant bit ** Most significant bit ","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable.","B1","status.operation.instrument.smuX.trigger_overrun.ARM","Set bit indicates that the arm event detector of the SMU was already in the detected state when a trigger was received.","Bit B1 decimal value: 2","B2","status.operation.instrument.smuX.trigger_overrun.SRC","Set bit indicates that the source event detector of the SMU was already in the detected state when a trigger was received.","Bit B2 decimal value: 4","B3","status.operation.instrument.smuX.trigger_overrun.MEAS","Set bit indicates that the measure event detector of the SMU was already in the detected state when a trigger was received.","Bit B3 decimal value: 8","B4","status.operation.instrument.smuX.trigger_overrun.ENDP","Set bit indicates that the end pulse event detector of the SMU was already in the detected state when a trigger was received.","Bit B4 decimal value: 16","B5-B15","Not used","Not applicable.","As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable = status.operation.instrument.smua.trigger_overrun.ARM.","In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8,192","4,096","2,048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Example","status.operation.instrument.smua.trigger_overrun.enable ="," status.operation.instrument.smua.trigger_overrun.ARM","Sets the ARM bit of the operation status SMU A trigger overrun enable register using a constant.","Also see","Operation Status Registers","status.operation.instrument.smuX.*","status.operation.instrument.smuX.trigger_overrrun.*","15841.html");
+Page[388]=new Array("This attribute contains the operation status trigger blender summary register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","1024 (All bits set)","Usage","operationRegister = status.operation.instrument.trigger_blender.condition","operationRegister = status.operation.instrument.trigger_blender.enable","operationRegister = status.operation.instrument.trigger_blender.event","operationRegister = status.operation.instrument.trigger_blender.ntr","operationRegister = status.operation.instrument.trigger_blender.ptr","status.operation.instrument.trigger_blender.enable = operationRegister","status.operation.instrument.trigger_blender.ntr = operationRegister","status.operation.instrument.trigger_blender.ptr = operationRegister ","operationRegister","The operation status trigger blender summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024","Details","These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0-B9","Not used","Not applicable.","B10","status.operation.instrument.trigger_blender.TRIGGER_OVERRUN","status.operation.instrument.trigger_blender.TRGOVR","Set bit indicates one or more enabled bits for operation status trigger blender overrun register is set.","Bit B10 decimal value: 1024","Binary value: 0100 0000 0000","B11-B15","Not used","Not applicable.","In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to 1024.","Example","status.operation.instrument.trigger_blender.enable = 1024","Sets the TRGOVR bit of the operation status trigger blender summary enable using a decimal value.","Also see","Operation Status Registers","status.operation.instrument.trigger_blender.trigger_overrun.*","status.operation.instrument.trigger_blender.*","15842.html");
+Page[389]=new Array("This attribute contains the operation status trigger blender overrun register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","30 (All bits set)","Usage","operationRegister = "," status.operation.instrument.trigger_blender.trigger_overrun.condition","operationRegister ="," status.operation.instrument.trigger_blender.trigger_overrun.enable","operationRegister ="," status.operation.instrument.trigger_blender.trigger_overrun.event","operationRegister ="," status.operation.instrument.trigger_blender.trigger_overrun.ntr","operationRegister ="," status.operation.instrument.trigger_blender.trigger_overrun.ptr","status.operation.instrument.trigger_blender.trigger_overrun.enable ="," operationRegister","status.operation.instrument.trigger_blender.trigger_overrun.ntr ="," operationRegister","status.operation.instrument.trigger_blender.trigger_overrun.ptr ="," operationRegister ","operationRegister","The operation status trigger blender overrun register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","Details","These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000 0001 0010. This value indicates that bit B1 and bit B4 are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","0","0","0","0","0","0","0","0","0","1","0","0","1","0","* Least significant bit ** Most significant bit ","A set bit value indicates that the specified trigger blender generated an action overrun.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable","B1","status.operation.instrument.trigger_blender.trigger_overrun.BLND1","Bit B1 decimal value: 2","B2","status.operation.instrument.trigger_blender.trigger_overrun.BLND2","Bit B2 decimal value: 4","B3","status.operation.instrument.trigger_blender.trigger_overrun.BLND3","Bit B3 decimal value: 8","B4","status.operation.instrument.trigger_blender.trigger_overrun.BLND4","Bit B4 decimal value: 16","B5-B15","Not used","Not applicable","As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.","In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8,192","4,096","2,048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Example","status.operation.instrument.trigger_blender.trigger_overrun.enable"," = status.operation.instrument.trigger_blender.trigger_overrun.BLND1","Sets the bit for blender 1 of the operation status trigger blender overrun enable register using a constant.","Also see","Operation Status Registers","status.operation.instrument.trigger_blender.*","status.operation.instrument.trigger_blender.trigger_overrun.*","15843.html");
+Page[390]=new Array("This attribute contains the operation status trigger timer summary register set. ","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","1024 (All bits set)","Usage","operationRegister = status.operation.instrument.trigger_timer.condition","operationRegister = status.operation.instrument.trigger_timer.enable","operationRegister = status.operation.instrument.trigger_timer.event","operationRegister = status.operation.instrument.trigger_timer.ntr","operationRegister = status.operation.instrument.trigger_timer.ptr","status.operation.instrument.trigger_timer.enable = operationRegister","status.operation.instrument.trigger_timer.ntr = operationRegister","status.operation.instrument.trigger_timer.ptr = operationRegister ","operationRegister","The operation status trigger timer summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024","Details","These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0-B9","Not used","Not applicable","B10","status.operation.instrument.trigger_timer.TRIGGER_OVERRUN status.operation.instrument.trigger_timer.TRGOVR","Set bit indicates one or more enabled bits for the operation status trigger timer overrun register is set.","Bit B10 decimal value: 1024","Binary value: 0100 0000 0000","B11-B15","Not used","Not applicable","In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to 1024. ","Example","status.operation.instrument.trigger_timer.enable = 1024","Sets the TRGOVR bit of the operation status trigger timer summary enable register using a decimal value.","Also see","Operation Status Registers","status.operation.instrument.trigger_timer.trigger_overrun.*","status.operation.instrument.trigger_timer.*","15844.html");
+Page[391]=new Array("This attribute contains the operation status trigger timer overrun register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","510 (All bits set)","Usage","operationRegister = "," status.operation.instrument.trigger_timer.trigger_overrun.condition","operationRegister = "," status.operation.instrument.trigger_timer.trigger_overrun.enable","operationRegister = "," status.operation.instrument.trigger_timer.trigger_overrun.event","operationRegister = "," status.operation.instrument.trigger_timer.trigger_overrun.ntr","operationRegister = "," status.operation.instrument.trigger_timer.trigger_overrun.ptr","status.operation.instrument.trigger_timer.trigger_overrun.enable = "," operationRegister","status.operation.instrument.trigger_timer.trigger_overrun.ntr = "," operationRegister","status.operation.instrument.trigger_timer.trigger_overrun.ptr = "," operationRegister ","operationRegister","The operation status trigger timer trigger overrun register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","Details","These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000 0001 0010. This value indicates that bit B1 and bit B4 are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","0","0","0","0","0","0","0","0","0","1","0","0","1","0","* Least significant bit ** Most significant bit ","A set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable","B1","status.operation.instrument.trigger_timer.trigger_overrun.TMR1","Bit B1 decimal value: 2","B2","status.operation.instrument.trigger_timer.trigger_overrun.TMR2","Bit B2 decimal value: 4","B3","status.operation.instrument.trigger_timer.trigger_overrun.TMR3","Bit B3 decimal value: 8","B4","status.operation.instrument.trigger_timer.trigger_overrun.TMR4","Bit B4 decimal value: 16","B5","status.operation.instrument.trigger_timer.trigger_overrun.TMR5","Bit B5 decimal value: 32","B6","status.operation.instrument.trigger_timer.trigger_overrun.TMR6","Bit B6 decimal value: 64","B7","status.operation.instrument.trigger_timer.trigger_overrun.TMR7","Bit B7 decimal value: 128","B8","status.operation.instrument.trigger_timer.trigger_overrun.TMR8","Bit B8 decimal value: 256","B9-B15","Not used","Not applicable","As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.","In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8,192","4,096","2,048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Example","status.operation.instrument.trigger_timer.trigger_overrun.enable ="," status.operation.instrument.trigger_timer.trigger_overrun.TMR3","Sets the timer 3 bit of the operation status trigger timer overrun enable register using a constant.","Also see","Operation Status Registers","status.operation.instrument.trigger_timer.*","status.operation.instrument.trigger_timer.trigger_overrun.*","15845.html");
+Page[392]=new Array("This attribute contains the operation status TSP-Link summary register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","1024 (All bits set)","Usage","operationRegister = status.operation.instrument.tsplink.condition","operationRegister = status.operation.instrument.tsplink.enable","operationRegister = status.operation.instrument.tsplink.event","operationRegister = status.operation.instrument.tsplink.ntr","operationRegister = status.operation.instrument.tsplink.ptr","status.operation.instrument.tsplink.enable = operationRegister","status.operation.instrument.tsplink.ntr = operationRegister","status.operation.instrument.tsplink.ptr = operationRegister ","operationRegister","The operation status TSP-Link summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024","Details","These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0-B9","Not used","Not applicable","B10","status.operation.instrument.tsplink.TRIGGER_OVERRUN status.operation.instrument.tsplink.TRGOVR","Set bit indicates one or more enabled bits for the operation status TSP-Link overrun register is set.","Bit B10 decimal value: 1024","Binary value: 0100 0000 0000","B11-B15","Not used","Not applicable","In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to 1024. ","Example","status.operation.instrument.tsplink.enable = 1024","Sets the trigger overrun bit of the operation status TSP-Link summary enable register using a decimal value.","Also see","Operation Status Registers","status.operation.instrument.tsplink.trigger_overrun.*","status.operation.instrument.tsplink.*","15846.html");
+Page[393]=new Array("This attribute contains the operation status TSP-Link overrun register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","14 (All bits set)","Usage","operationRegister = "," status.operation.instrument.tsplink.trigger_overrun.condition","operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable","operationRegister = status.operation.instrument.tsplink.trigger_overrun.event","operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr","operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr","status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister","status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister","status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister ","operationRegister","The operation status TSP-link overrun register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","Details","These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000 0000 0000 1010. This value indicates that bit B1 and bit B3 are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","0","0","0","0","0","0","0","0","0","0","1","0","1","0","* Least significant bit ** Most significant bit ","A set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable","B1","status.operation.instrument.tsplink.trigger_overrun.LINE1","Bit B1 decimal value: 2","B2","status.operation.instrument.tsplink.trigger_overrun.LINE2","Bit B2 decimal value: 4","B3","status.operation.instrument.tsplink.trigger_overrun.LINE3","Bit B3 decimal value: 8","B4-B15","Not used","Not applicable","As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.","In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8,192","4,096","2,048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Example 1","status.operation.instrument.tsplink.trigger_overrun.enable ="," status.operation.instrument.tsplink.trigger_overrun.LINE1","Sets the line 1 bit of the operation status TSP-Link overrun enable register using a constant.","Also see","Operation Status Registers","status.operation.instrument.trigger_timer.*","status.operation.instrument.tsplink.trigger_overrun.*","15847.html");
+Page[394]=new Array("This attribute contains the operation status measuring summary register set. ","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","2 (All bits set)","Usage","operationRegister = status.operation.measuring.condition","operationRegister = status.operation.measuring.enable","operationRegister = status.operation.measuring.event","operationRegister = status.operation.measuring.ntr","operationRegister = status.operation.measuring.ptr","status.operation.measuring.enable = operationRegister","status.operation.measuring.ntr = operationRegister","status.operation.measuring.ptr = operationRegister ","operationRegister","The operation status measuring summary register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than zero (0) is 2","Details","These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable.","B1","status.operation.measuring.SMUA","Bit will be set when taking an overlapped measurement, but it will not set when taking a normal synchronous measurement.","Bit B1 decimal value: 2","Binary value: 0000 0010","B2-B15","Not used","Not applicable.","In addition to the above constant, operationRegister can be set to the decimal equivalent of the bit to set.","Example","status.operation.measuring.enable ="," status.operation.measuring.SMUA","Sets the SMUA bit of the operation status measuring summary enable register using a constant.","Also see","Operation Status Registers","status.operation.*","status.operation.measuring.*","15848.html");
+Page[395]=new Array("This attribute contains the operation status remote summary register set. ","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","2050 (All bits set)","Usage","operationRegister = status.operation.remote.condition","operationRegister = status.operation.remote.enable","operationRegister = status.operation.remote.event","operationRegister = status.operation.remote.ntr","operationRegister = status.operation.remote.ptr","status.operation.remote.enable = operationRegister","status.operation.remote.ntr = operationRegister","status.operation.remote.ptr = operationRegister ","operationRegister","The operation status remote summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","Details","These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable.","B1","status.operation.remote.COMMAND_AVAILABLE","status.operation.remote.CAV","Set bit indicates there is a command available in the execution queue.","Bit B1 decimal value: 2","Binary value: 0000 0000 0000 0010","B2-B10","Not used","Not applicable.","B11","status.operation.remote.PROMPTS_ENABLED","status.operation.remote.PRMPT","Set bit indicates command prompts are enabled.","Bit B11 decimal value: 2048","Binary value: 0000 0100 0000 0000","B12-B15","Not used","Not applicable.","As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.","In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B11, set operationRegister to 2050 (which is the sum of 2 + 2048). ","Example","status.operation.remote.enable ="," status.operation.remote.CAV","Sets the CAV bit of the operation status remote summary enable register using a constant.","Also see","Operation Status Registers","status.operation.*","status.operation.remote.*","15849.html");
+Page[396]=new Array("This attribute contains the operation status sweeping summary register set. ","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","2 (All bits set)","Usage","operationRegister = status.operation.sweeping.condition","operationRegister = status.operation.sweeping.enable","operationRegister = status.operation.sweeping.event","operationRegister = status.operation.sweeping.ntr","operationRegister = status.operation.sweeping.ptr","status.operation.sweeping.enable = operationRegister","status.operation.sweeping.ntr = operationRegister","status.operation.sweeping.ptr = operationRegister ","operationRegister","The operation status sweeping summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than zero (0) is 2","Details","These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable.","B1","status.operation.sweeping.SMUA","Set bit indicates that SMU A is sweeping.","Bit B1 decimal value: 2","Binary value: 0000 0010","B2-B5","Not used","Not applicable.","In addition to the above constant, operationRegister can be set to the decimal equivalent of the bit to set.","Example","status.operation.sweeping.enable ="," status.operation.sweeping.SMUA","Sets the SMUA bit of the operation status sweeping summary enable register using a constant.","Also see","Operation Status Registers","status.operation.*","status.operation.sweeping.*","15850.html");
+Page[397]=new Array("This attribute contains the operation status trigger overrun summary register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","31,746 (All bits set)","Usage","operationRegister = status.operation.trigger_overrun.condition","operationRegister = status.operation.trigger_overrun.enable","operationRegister = status.operation.trigger_overrun.event","operationRegister = status.operation.trigger_overrun.ntr","operationRegister = status.operation.trigger_overrun.ptr","status.operation.trigger_overrun.enable = operationRegister","status.operation.trigger_overrun.ntr = operationRegister","status.operation.trigger_overrun.ptr = operationRegister ","operationRegister","The operation status trigger overrun summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","Details","These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000 0100 0000 0010. This value indicates that bit B1 and bit B10 are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","0","0","0","1","0","0","0","0","0","0","0","0","1","0","* Least significant bit ** Most significant bit","The bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable.","B1","status.operation.trigger_overrun.SMUA","Set bit indicates one of the enabled bits in the operation status SMU A trigger overrun event register is set.","Bit B1 decimal value: 2","B2-B9","Not used","Not applicable.","B10","status.operation.trigger_overrun.TRIGGER_BLENDER","status.operation.trigger_overrun.TRGBLND","Set bit indicates one of the enabled bits in the operation status trigger blender overrun event register is set.","Bit B10 decimal value: 1024","B11","status.operation.trigger_overrun.TRIGGER_TIMER","status.operation.trigger_overrun.TRGTMR","Set bit indicates one of the enabled bits in the operation status trigger timer overrun event register is set.","Bit B11 decimal value: 2048","B12","status.operation.trigger_overrun.DIGITAL_IO","status.operation.trigger_overrun.DIGIO","Set bit indicates one of the enabled bits in the operation status digital I/O overrun event register is set.","Bit B12 decimal value: 4096","B13","status.operation.trigger_overrun.TSPLINK","Set bit indicates one of the enabled bits in the operation status TSP-Link overrun event register is set.","Bit B13 decimal value: 8192","B14","status.operation.trigger_overrun.LAN","Set bit indicates one of the enabled bits in the operation status LAN trigger overrun event register is set.","Bit B14 decimal value: 16,384","B15","Not used","Not applicable.","As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.","In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1026 (which is the sum of 2 + 1024). ","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8,192","4,096","2,048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Example","operationRegister = "," status.operation.trigger_overrun.SMUA +"," status.operation.trigger_overrun.TRGBLND","status.operation.trigger_overrun.enable = operationRegister","Sets bit B1 and bit B10 of the operation status trigger overrun summary enable register using constants.","Also see","Operation Status Registers","status.operation.*","status.operation.trigger_overrun.*","15851.html");
+Page[398]=new Array("These attributes manage the status model's operation status user register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (RW)","Yes","Status reset","Not saved","0",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","32,767 (All bits set)","Usage","operationRegister = status.operation.user.condition","operationRegister = status.operation.user.enable","operationRegister = status.operation.user.event","operationRegister = status.operation.user.ntr","operationRegister = status.operation.user.ptr","status.operation.user.condition = operationRegister","status.operation.user.enable = operationRegister","status.operation.user.ntr = operationRegister","status.operation.user.ptr = operationRegister","operationRegister","The operation status user register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","Details","These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000 0000 1000 0001. This value indicates that bits B0 and B7 are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","0","0","0","0","0","0","1","0","0","0","0","0","0","1","* Least significant bit ** Most significant bit","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","status.operation.user.BIT0","Bit B0 decimal value: 1","B1","status.operation.user.BIT1","Bit B1 decimal value: 2","B2","status.operation.user.BIT2","Bit B2 decimal value: 4","B3","status.operation.user.BIT3","Bit B3 decimal value: 8","B4","status.operation.user.BIT4","Bit B4 decimal value: 16","B5","status.operation.user.BIT5","Bit B5 decimal value: 32","B6","status.operation.user.BIT6","Bit B6 decimal value: 64","B7","status.operation.user.BIT7","Bit B7 decimal value: 128","B8","status.operation.user.BIT8","Bit B8 decimal value: 256","B9","status.operation.user.BIT9","Bit B9 decimal value: 512","B10","status.operation.user.BIT10","Bit B10 decimal value: 1024","B11","status.operation.user.BIT11","Bit B11 decimal value: 2048","B12","status.operation.user.BIT12","Bit B12 decimal value: 4096","B13","status.operation.user.BIT13","Bit B13 decimal value: 8192","B14","status.operation.user.BIT14","Bit B14 decimal value: 16,384","B15","Not used","Not applicable","As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.","In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2048 + 16,384). ","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8,192","4,096","2,048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Example 1","operationRegister = status.operation.user.BIT11 +"," status.operation.user.BIT14","status.operation.user.enable = operationRegister","Sets bits B11 and B14 of the operation status user enable register using constants.","Example 2","-- 18432 = binary 0100 1000 0000 0000","operationRegister = 18432","status.operation.enable = operationRegister","Sets bits B11 and B14 of the operation status user enable register using a decimal value.","Also see","status.operation.*","Operation Status Register","status.operation.user.*","15852.html");
+Page[399]=new Array("These attributes manage the status model's questionable status register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","13,056 (All bits set)","Usage","quesRegister = status.questionable.condition","quesRegister = status.questionable.enable","quesRegister = status.questionable.event","quesRegister = status.questionable.ntr","quesRegister = status.questionable.ptr","status.questionable.enable = quesRegister","status.questionable.ntr = quesRegister","status.questionable.ptr = quesRegister","quesRegister","The questionable status register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","Details","These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011 0000 0000 0000. This value indicates that bits B12 and B13 are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","1","1","0","0","0","0","0","0","0","0","0","0","0","0","* Least significant bit ** Most significant bit ","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0-B7","Not used","Not available","B8","status.questionable.CALIBRATION status.questionable.CAL","An enabled bit in the questionable status calibration summary event register is set.","Bit B6 decimal value:256","B9","status.questionable.UNSTABLE_OUTPUT status.questionable.UO","An enabled bit in the questionable status unstable output summary event register is set.","Bit B9 decimal value: 512","B10-B11","Not used","Not available","B12","status.questionable.OVER_TEMPERATURE status.questionable.OTEMP","An enabled bit in the questionable status over temperature summary event register is set.","Bit B12 decimal value: 4,096","B13","status.questionable.INSTRUMENT_SUMMARY status.questionable.INST","An enabled bit in the questionable status instrument summary event register is set.","Bit B13 decimal value: 8,192","B14-B15","Not used","Not available","As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.","In addition to the above constants, quesRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set quesRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set quesRegister to 12,288 (which is the sum of 4096 + 8192). ","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8,192","4,096","2,048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Also see","Questionable Status Registers","status.questionable.*","15853.html");
+Page[400]=new Array("This attribute contains the questionable status calibration summary register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","2 (All bits set)","Usage","questionableRegister = status.questionable.calibration.condition","questionableRegister = status.questionable.calibration.enable","questionableRegister = status.questionable.calibration.event","questionableRegister = status.questionable.calibration.ntr","questionableRegister = status.questionable.calibration.ptr","status.questionable.calibration.enable = questionableRegister","status.questionable.calibration.ntr = questionableRegister","status.questionable.calibration.ptr = questionableRegister ","questionableRegister","The questionable status calibration summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than zero (0) is 2","Details","These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. ","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable.","B1","status.questionable.calibration.SMUA","Set bit indicates that the calibration constants stored in nonvolatile memory were corrupted and could not be loaded when the instrument powered up.","Bit B1 decimal value: 2","Binary value: 0000 0010","B2 to B15","Not used","Not applicable.","In addition to the above constant, questionableRegister can be set to the decimal equivalent of the bit to set.","Example","status.questionable.calibration.enable ="," status.questionable.calibration.SMUA","Sets the SMUA bit of the questionable status calibration summary enable register using a constant.","Also see","Questionable Status Registers","status.questionable.*","status.questionable.calibration.*","15854.html");
+Page[401]=new Array("This attribute contains the questionable status instrument summary register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","2 (All bits set)","Usage","questionableRegister = status.questionable.instrument.condition","questionableRegister = status.questionable.instrument.enable","questionableRegister = status.questionable.instrument.event","questionableRegister = status.questionable.instrument.ntr","questionableRegister = status.questionable.instrument.ptr","status.questionable.instrument.enable = questionableRegister","status.questionable.instrument.ntr = questionableRegister","status.questionable.instrument.ptr = questionableRegister ","questionableRegister","The questionable status instrument summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 2","Details","These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable","B1","status.questionable.instrument.SMUA","Set bit indicates one or more enabled bits in the questionable status SMU A summary event register is set.","Bit B1 decimal value: 2","Binary value: 0000 0010","B2 to B15","Not used","Not applicable.","In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. ","Example","status.questionable.instrument.enable ="," status.questionable.instrument.SMUA","Sets the SMUA bit of the questionable status instrument summary enable register using a constant.","Also see","Questionable Status Registers","status.questionable.*","status.questionable.instrument.*","15855.html");
+Page[402]=new Array("This attribute contains the questionable status SMU X summary register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","4864 (All bits set)","Usage","questionableRegister = status.questionable.instrument.smuX.condition","questionableRegister = status.questionable.instrument.smuX.enable","questionableRegister = status.questionable.instrument.smuX.event","questionableRegister = status.questionable.instrument.smuX.ntr","questionableRegister = status.questionable.instrument.smuX.ptr","status.questionable.instrument.smuX.enable = questionableRegister","status.questionable.instrument.smuX.ntr = questionableRegister","status.questionable.instrument.smuX.ptr = questionableRegister ","questionableRegister","The questionable status SMU X summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","X","Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)","Details","These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000 0011 0000 0000. This value indicates that bit B8 and bit B9 are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","0","0","0","0","1","1","0","0","0","0","0","0","0","0","* Least significant bit ** Most significant bit ","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0-B7","Not used","Not applicable.","B8","status.questionable.instrument.smuX.CALIBRATION status.questionable.instrument.smuX.CAL","Set bit indicates that the calibration constants stored in nonvolatile memory were corrupted and could not be loaded when the instrument powered up.","Bit B8 decimal value: 256","B9","status.questionable.instrument.smuX.UNSTABLE_OUTPUT status.questionable.instrument.smuX.UO","Set bit indicates that an unstable output condition was detected.","Bit B9 decimal value: 512","B10-B11","Not used","Not applicable","B12","status.questionable.instrument.smuX.OVER_TEMPERATURE status.questionable.instrument.smuX.OTEMP","Set bit indicates that an over temperature condition was detected.","Bit B12 decimal value: 4096","B13-B15","Not used","Not applicable.","As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.","In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512). ","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8,192","4,096","2,048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Example","questionableRegister = "," status.questionable.instrument.smua.CAL +"," status.questionable.instrument.smua.UO","status.questionable.instrument.smua.enable ="," questionableRegister","Sets bit B8 and bit B9 of the questionable status SMU A summary enable register using constants.","Also see","Questionable Status Registers","status.operation.*","status.questionable.instrument.smuX.*","15856.html");
+Page[403]=new Array("This attribute contains the questionable status over temperature summary register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","2 (All bits set)","Usage","questionableRegister = status.questionable.over_temperature.condition","questionableRegister = status.questionable.over_temperature.enable","questionableRegister = status.questionable.over_temperature.event","questionableRegister = status.questionable.over_temperature.ntr","questionableRegister = status.questionable.over_temperature.ptr","status.questionable.over_temperature.enable = questionableRegister","status.questionable.over_temperature.ntr = questionableRegister","status.questionable.over_temperature.ptr = questionableRegister ","operationRegister","The questionable status over temperature summary register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 2","Details","These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable.","B1","status.questionable.over_temperature.SMUA","Set bit indicates that an over temperature indication was detected.","Bit B1 decimal value: 2","Binary value: 0000 0010","B2-B15","Not used","Not applicable.","In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. ","Example","status.questionable.over_temperature.enable ="," status.questionable.over_temperature.SMUA","Sets the SMU A bit in the questionable status over temperature summary enable register using a constant.","Also see","Questionable Status Registers","status.questionable.*","status.questionable.over_temperature.*","15857.html");
+Page[404]=new Array("This attribute contains the questionable status unstable output summary register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","2 (All bits set)","Usage","questionableRegister = status.questionable.unstable_output.condition","questionableRegister = status.questionable.unstable_output.enable","questionableRegister = status.questionable.unstable_output.event","questionableRegister = status.questionable.unstable_output.ntr","questionableRegister = status.questionable.unstable_output.ptr","status.questionable.unstable_output.enable = questionableRegister","status.questionable.unstable_output.ntr = questionableRegister","status.questionable.unstable_output.ptr = questionableRegister ","operationRegister","The questionable status unstable output summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 2","Details","These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable.","B1","status.questionable.unstable_output.SMUA","Set bit indicates that an unstable output condition was detected.","Bit B1 decimal value: 2","Binary value: 0000 0010","B2-B15","Not used","Not applicable.","In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. ","Example","status.questionable.unstable_output.enable ="," status.questionable.unstable_output.SMUA","Sets the SMU A bit in the questionable status unstable output summary enable register bit using a constant.","Also see","Questionable Status Registers","status.questionable.*","status.questionable.unstable_output.*","15858.html");
+Page[405]=new Array("This attribute stores the service request (SRQ) enable register.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Status reset","Not saved","0","Usage","requestSRQEnableRegister = status.request_enable","status.request_enable = requestSRQEnableRegister","requestSRQEnableRegister","The service request (SRQ) enable register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","Details","This attribute is used to read or write to the service request enable register. Reading the service request enable register returns a value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000 0001. This value indicates that bit B0 and bit B7 are set.","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">","*","1","0","0","0","0","0","0","1","* Least significant bit ** Most significant bit ","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","status.MEASUREMENT_SUMMARY_BIT","status.MSB","Set summary bit indicates that an enabled event in the Measurement Event Register has occurred.","Bit B0 decimal value: 1","B1","status.SYSTEM_SUMMARY_BIT","status.SSB","Set summary bit indicates that an enabled event in the System Summary Register has occurred.","Bit B1 decimal value: 2","B2","status.ERROR_AVAILABLE","status.EAV","Set summary bit indicates that an error or status message is present in the Error Queue.","Bit B2 decimal value: 4","B3","status.QUESTIONABLE_SUMMARY_BIT","status.QSB","Set summary bit indicates that an enabled event in the Questionable Status Register has occurred.","Bit B3 decimal value: 8","B4","status.MESSAGE_AVAILABLE","status.MAV","Set summary bit indicates that a response message is present in the Output Queue.","Bit B4 decimal value: 16","B5","status.EVENT_SUMMARY_BIT","status.ESB","Set summary bit indicates that an enabled event in the Standard Event Status Register has occurred.","Bit B5 decimal value: 32","B6","Not used","Not applicable","B7","status.OPERATION_SUMMARY_BIT","status.OSB","Set summary bit indicates that an enabled event in the Operation Status Register has occurred.","Bit B7 decimal value: 128","As an example, to set bit B0 of the service request enable register, set status.request_enable = status.MSB.","In addition to the above values, requestSRQEnableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set requestSRQEnableRegister to the sum of their decimal weights. For example, to set bits B0 and B7, set requestSRQEnableRegister to 129 (1 + 128).","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Example 1","requestSRQEnableRegister = status.MSB + status.OSB","status.request_enable = requestSRQEnableRegister","Sets the MSB and OSB bits of the service request (SRQ) enable register using constants.","Example 2","-- decimal 129 = binary 10000001","requestSRQEnableRegister = 129","status.request_enable = requestSRQEnableRegister","Sets the MSB and OSB bits of the service request (SRQ) enable register using a decimal value.","Also see","status.condition","status.system.*","Status model overview","Status byte and service request (SRQ)","status.request_enable","17593.html");
+Page[406]=new Array("This attribute stores the service request (SRQ) event register.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not saved","0","Usage","requestSRQEventRegister = status.request_event","requestSRQEventRegister","The request event register's status; a zero (0) indicates no bits set; other values indicate various bit settings","Details","This attribute is used to read the service request event register, which is returned as a numeric value. Reading this register returns a value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000 0001. This value indicates that bit B0 and bit B7 are set.","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">","*","1","0","0","0","0","0","0","1","* Least significant bit ** Most significant bit ","The returned value can indicate one or more status events occurred.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","status.MEASUREMENT_SUMMARY_BIT","status.MSB","Set summary bit indicates that an enabled event in the Measurement Event Register has occurred.","Bit B0 decimal value: 1","B1","status.SYSTEM_SUMMARY_BIT","status.SSB","Set summary bit indicates that an enabled event in the System Summary Register has occurred.","Bit B1 decimal value: 2","B2","status.ERROR_AVAILABLE","status.EAV","Set summary bit indicates that an error or status message is present in the Error Queue.","Bit B2 decimal value: 4","B3","status.QUESTIONABLE_SUMMARY_BIT","status.QSB","Set summary bit indicates that an enabled event in the Questionable Status Register has occurred.","Bit B3 decimal value: 8","B4","status.MESSAGE_AVAILABLE","status.MAV","Set summary bit indicates that a response message is present in the Output Queue.","Bit B4 decimal value: 16","B5","status.EVENT_SUMMARY_BIT","status.ESB","Set summary bit indicates that an enabled event in the Standard Event Status Register has occurred.","Bit B5 decimal value: 32","B6","Not used","Not applicable","B7","status.OPERATION_SUMMARY_BIT","status.OSB","Set summary bit indicates that an enabled event in the Operation Status Register has occurred.","Bit B7 decimal value: 128","In addition to the above constants, requestEventRegister can be set to the decimal equivalent of the bit(s) set. When more than one bit of the register is set, requestEventRegister contains the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Example","requestEventRegister = status.request_event","print(requestEventRegister)","Reads the status request event register.","Sample output: 1.29000e+02","Converting this output (129) to its binary equivalent yields: 1000 0001 ","Therefore, this output indicates that the set bits of the status request event register are presently B0 (MSB) and B7 (OSB).","Also see","status.condition","status.system.*","Status model overview","Status byte and service request (SRQ)","status.request_event","17594.html");
+Page[407]=new Array("This function resets all bits in the system status model.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","status.reset()","Details","This function clears all status data structure registers (enable, event, NTR, and PTR) to their default values. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers.","Example","status.reset()","Resets the instrument status model.","Also see","Status model","status.reset()","15861.html");
+Page[408]=new Array("These attributes manage the status model's standard event status register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","253 (All bits set)","Usage","standardRegister = status.standard.condition","standardRegister = status.standard.enable","standardRegister = status.standard.event","standardRegister = status.standard.ntr","standardRegister = status.standard.ptr","status.standard.enable = standardRegister","status.standard.ntr = standardRegister","status.standard.ptr = standardRegister","standardRegister","The standard event status register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","Details","These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000 0000 1000 0001. This value indicates that bit B0 and bit B7 are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","0","0","0","0","0","0","1","0","0","0","0","0","0","1","* Least significant bit ** Most significant bit ","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","status.standard.OPERATION_COMPLETE status.standard.OPC","Set bit indicates that all pending selected instrument operations are completed and the instrument is ready to accept new commands. The bit is set in response to an *OPC command. The opc() function can be used in place of the *OPC command.","Bit B0 decimal value: 1","B1","Not used","Not applicable","B2","status.standard.QUERY_ERROR status.standard.QYE","Set bit indicates that you attempted to read data from an empty Output Queue.","Bit B2 decimal value: 4","B3","status.standard.DEVICE_DEPENDENT_ERROR status.standard.DDE","Set bit indicates that an instrument operation did not execute properly due to some internal condition. ","Bit B3 decimal value: 8","B4","status.standard.EXECUTION_ERROR status.standard.EXE","Set bit indicates that the instrument detected an error while trying to execute a command.","Bit B4 decimal value: 16","B5","status.standard.COMMAND_ERROR status.standard.CME","Set bit indicates that a command error has occurred. Command errors include:","IEEE Std 488.2 syntax error: Instrument received a message that does not follow the defined syntax of the IEEE Std 488.2 standard.","Semantic error: Instrument received a command that was misspelled or received an optional IEEE Std 488.2 command that is not implemented.","GET error: The instrument received a Group Execute Trigger (GET) inside a program message.","Bit B5 decimal value: 32","B6","status.standard.USER_REQUEST status.standard.URQ","Set bit indicates that the LOCAL key on the instrument front panel was pressed.","Bit B6 decimal value: 64","B7","status.standard.POWER_ON status.standard.PON","Set bit indicates that the instrument has been turned off and turned back on since the last time this register has been read.","Bit B7 decimal value: 128","B8-B15","Not used","Not applicable","As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.","In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Example 1","standardRegister = status.standard.OPC"," + status.standard.EXE","status.standard.enable = standardRegister","Sets the OPC and EXE bits of the standard event status enable register using constants.","Example 2","-- decimal 17 = binary 0001 0001","standardRegister = 17","status.standard.enable = standardRegister","Sets the OPC and EXE bits of the standard event status enable register using a decimal value.","Also see","Standard Event Register ","status.standard.*","15862.html");
+Page[409]=new Array("These attributes manage the status model's TSP-Link® system summary register for nodes 1 through 14.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","32,767 (All bits set)","Usage","enableRegister = status.system.condition","enableRegister = status.system.enable","enableRegister = status.system.event","enableRegister = status.system.ntr","enableRegister = status.system.ptr","status.system.enable = enableRegister","status.system.ntr = enableRegister","status.system.ptr = enableRegister","enableRegister","The system summary register's status; a zero (0) indicates no bits set; other values indicate various bit settings","Details","In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000 0000 1000 0001. This value indicates that bit B0 and bit B7 are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","0","0","0","0","0","0","1","0","0","0","0","0","0","1","* Least significant bit ** Most significant bit ","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","status.system.EXTENSION_BIT status.system.EXT","Bit B0 decimal value: 1","B1","status.system.NODE1","Bit B1 decimal value: 2","B2","status.system.NODE2","Bit B2 decimal value: 4","B3","status.system.NODE3","Bit B3 decimal value: 8","B4","status.system.NODE4","Bit B4 decimal value: 16","B5","status.system.NODE5","Bit B5 decimal value: 32","B6","status.system.NODE6","Bit B6 decimal value: 64","B7","status.system.NODE7","Bit B7 decimal value: 128","B8","status.system.NODE8","Bit B8 decimal value: 256","B9","status.system.NODE9","Bit B9 decimal value: 512","B10","status.system.NODE10","Bit B10 decimal value: 1024","B11","status.system.NODE11","Bit B11 decimal value: 2048","B12","status.system.NODE12","Bit B12 decimal value: 4096","B13","status.system.NODE13","Bit B13 decimal value: 8192","B14","status.system.NODE14","Bit B14 decimal value: 16384","B15","Not used","Not applicable","As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.","In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2048 + 16,384). ","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8,192","4,096","2,048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Example 1","enableRegister = status.system.NODE11 +"," status.system.NODE14","status.system.enable = enableRegister","Sets bits B11 and B14 of the system summary enable register using constants.","Example 2","-- decimal 18432 = binary 0100 1000 0000 0000","enableRegister = 18432","status.system.enable = enableRegister","Sets bits B11 and B14 of the system summary enable register using a decimal value.","Also see","status.system2.*","System summary and standard event registers","status.system.*","15863.html");
+Page[410]=new Array("These attributes manage the status model's TSP-Link® system summary register for nodes 15 through 28.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","32,767 (All bits set)","Usage","enableRegister = status.system2.condition","enableRegister = status.system2.enable","enableRegister = status.system2.event","enableRegister = status.system2.ntr","enableRegister = status.system2.ptr","status.system2.enable = enableRegister","status.system2.ntr = enableRegister","status.system2.ptr = enableRegister","enableRegister","The system summary 2 register's status; a zero (0) indicates no bits set; other values indicate various bit settings","Details","In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000 0000 1000 0001. This value indicates that bit B0 and bit B7 are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","0","0","0","0","0","0","1","0","0","0","0","0","0","1","* Least significant bit ** Most significant bit ","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","status.system2.EXTENSION_BIT status.system2.EXT","Bit B0 decimal value: 1","B1","status.system2.NODE15","Bit B1 decimal value: 2","B2","status.system2.NODE16","Bit B2 decimal value: 4","B3","status.system2.NODE17","Bit B3 decimal value: 8","B4","status.system2.NODE18","Bit B4 decimal value: 16","B5","status.system2.NODE19","Bit B5 decimal value: 32","B6","status.system2.NODE20","Bit B6 decimal value: 64","B7","status.system2.NODE21","Bit B7 decimal value: 128","B8","status.system2.NODE22","Bit B8 decimal value: 256","B9","status.system2.NODE23","Bit B9 decimal value: 512","B10","status.system2.NODE24","Bit B10 decimal value: 1024","B11","status.system2.NODE25","Bit B11 decimal value: 2048","B12","status.system2.NODE26","Bit B12 decimal value: 4096","B13","status.system2.NODE27","Bit B13 decimal value: 8192","B14","status.system2.NODE28","Bit B14 decimal value: 16,384","B15","Not used","Not applicable","As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.","In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2048 + 16,384). ","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8,192","4,096","2,048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Example 1","enableRegister = status.system2.NODE25 +"," status.system2.NODE28","status.system2.enable = enableRegister ","Sets bits B11 and B14 of the system summary 2 enable register using constants.","Example 2","-- decimal 18432 = binary 0100 1000 0000 0000","enableRegister = 18432","status.system2.enable = enableRegister","Sets bits B11 and B14 of the system summary 2 enable register using a decimal value.","Also see","status.system.*","status.system3.*","System summary and standard event registers","status.system2.*","15864.html");
+Page[411]=new Array("These attributes manage the status model's TSP-Link® system summary register for nodes 29 through 42.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","32,767 (All bits set)","Usage","enableRegister = status.system3.condition","enableRegister = status.system3.enable","enableRegister = status.system3.event","enableRegister = status.system3.ntr","enableRegister = status.system3.ptr","status.system3.enable = enableRegister","status.system3.ntr = enableRegister","status.system3.ptr = enableRegister","enableRegister","The system summary 3 register's status; a zero (0) indicates no bits set; other values indicate various bit settings","Details","In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000 0000 1000 0001. This value indicates that bit B0 and bit B7 are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","0","0","0","0","0","0","1","0","0","0","0","0","0","1","* Least significant bit ** Most significant bit ","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","status.system3.EXTENSION_BIT status.system3.EXT","Bit B0 decimal value: 1","B1","status.system3.NODE29","Bit B1 decimal value: 2","B2","status.system3.NODE30","Bit B2 decimal value: 4","B3","status.system3.NODE31","Bit B3 decimal value: 8","B4","status.system3.NODE32","Bit B4 decimal value: 16","B5","status.system3.NODE33","Bit B5 decimal value: 32","B6","status.system3.NODE34","Bit B6 decimal value: 64","B7","status.system3.NODE35","Bit B7 decimal value: 128","B8","status.system3.NODE36","Bit B8 decimal value: 256","B9","status.system3.NODE37","Bit B9 decimal value: 512","B10","status.system3.NODE38","Bit B10 decimal value: 1024","B11","status.system3.NODE39","Bit B11 decimal value: 2048","B12","status.system3.NODE40","Bit B12 decimal value: 4096","B13","status.system3.NODE41","Bit B13 decimal value: 8192","B14","status.system3.NODE42","Bit B14 decimal value: 16,384","B15","Not used","Not applicable","As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.","In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2048 + 16,384). ","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8,192","4,096","2,048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Example 1","enableRegister = status.system3.NODE39 +"," status.system3.NODE42","status.system3.enable = enableRegister ","Sets bits B11 and B14 of the system summary 3 enable register using constants.","Example 2","-- decimal 18432 = binary 0100 1000 0000 0000","enableRegister = 18432","status.system3.enable = enableRegister","Sets bits B11 and B14 of the system summary 3 enable register using a decimal value.","Also see","status.system2.*","status.system4.*","System summary and standard event registers","status.system3.*","15865.html");
+Page[412]=new Array("These attributes manage the status model's TSP-Link® system summary register for nodes 43 through 56.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","32,767 (All bits set)","Usage","enableRegister = status.system4.condition","enableRegister = status.system4.enable","enableRegister = status.system4.event","enableRegister = status.system4.ntr","enableRegister = status.system4.ptr","status.system4.enable = enableRegister","status.system4.ntr = enableRegister","status.system4.ptr = enableRegister","enableRegister","The system summary 4 register's status; a zero (0) indicates no bits set; other values indicate various bit settings","Details","In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000 0000 1000 0001. This value indicates that bit B0 and bit B7 are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","0","0","0","0","0","0","1","0","0","0","0","0","0","1","* Least significant bit ** Most significant bit ","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","status.system4.EXTENSION_BIT status.system4.EXT","Bit B0 decimal value: 1","B1","status.system4.NODE43","Bit B1 decimal value: 2","B2","status.system4.NODE44","Bit B2 decimal value: 4","B3","status.system4.NODE45","Bit B3 decimal value: 8","B4","status.system4.NODE46","Bit B4 decimal value: 16","B5","status.system4.NODE47","Bit B5 decimal value: 32","B6","status.system4.NODE48","Bit B6 decimal value: 64","B7","status.system4.NODE49","Bit B7 decimal value: 128","B8","status.system4.NODE50","Bit B8 decimal value: 256","B9","status.system4.NODE51","Bit B9 decimal value: 512","B10","status.system4.NODE52","Bit B10 decimal value: 1024","B11","status.system4.NODE53","Bit B11 decimal value: 2048","B12","status.system4.NODE54","Bit B12 decimal value: 4096","B13","status.system4.NODE55","Bit B13 decimal value: 8192","B14","status.system4.NODE56","Bit B14 decimal value: 16,384","B15","Not used","Not applicable","As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.","In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2048 + 16,384). ","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8,192","4,096","2,048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Example 1","enableRegister = status.system4.NODE53 +"," status.system4.NODE56","status.system2.enable = enableRegister ","Sets bit B11 and bit B14 of the system summary 4 enable register using constants.","Example 2","-- decimal 18432 = binary 0100 1000 0000 0000","enableRegister = 18432","status.system4.enable = enableRegister","Sets bit B11 and bit B14 of the system summary 4 enable register using a decimal value.","Also see","status.system3.*","status.system5.*","System summary and standard event registers","status.system4.*","15866.html");
+Page[413]=new Array("These attributes manage the status model's TSP-Link® system summary register for nodes 57 through 64.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","510 (All bits set)","Usage","enableRegister = status.system5.condition","enableRegister = status.system5.enable","enableRegister = status.system5.event","enableRegister = status.system5.ntr","enableRegister = status.system5.ptr","status.system5.enable = enableRegister","status.system5.ntr = enableRegister","status.system5.ptr = enableRegister","enableRegister","The system summary 5 register's status; a zero (0) indicates no bits set; other values indicate various bit settings","Details","In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000 0000 1000 0010. This value indicates that bit B1 and bit B7 are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","0","0","0","0","0","0","1","0","0","0","0","0","1","0","* Least significant bit ** Most significant bit ","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register sets and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable","B1","status.system5.NODE57","Bit B1 decimal value: 2","B2","status.system5.NODE58","Bit B2 decimal value: 4","B3","status.system5.NODE59","Bit B3 decimal value: 8","B4","status.system5.NODE60","Bit B4 decimal value: 16","B5","status.system5.NODE61","Bit B5 decimal value: 32","B6","status.system5.NODE62","Bit B6 decimal value: 64","B7","status.system5.NODE63","Bit B7 decimal value: 128","B8","status.system5.NODE64","Bit B8 decimal value: 256","B9-B15","Not used","Not applicable","As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.","In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8,192","4,096","2,048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Example 1","enableRegister = status.system5.NODE57 +"," status.system5.NODE60","status.system2.enable = enableRegister ","Sets bits B1 and B4 of the system summary 5 enable register using constants.","Example 2","-- decimal 18 = binary 0000 0000 0001 0010","enableRegister = 18","status.system5.enable = enableRegister","Sets bits B1 and B4 of the system summary 5 enable register using a decimal value.","Also see","status.system4.*","System summary and standard event registers","status.system5.*","15867.html");
+Page[414]=new Array("This KISweep factory script function performs a linear current sweep with voltage measured at every step (point).","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","SweepILinMeasureV(smu, starti, stopi, stime, points)","smu","System SourceMeter® instrument channel (set to smua)","starti","Sweep start current in amperes","stopi","Sweep stop current in amperes","stime","Settling time in seconds; occurs after stepping the source and before performing a measurement","points","Number of sweep points (must be ≥2)","Details","Data for voltage measurements, current source values, and timestamps are stored in smuX.nvbuffer1.","If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.","Performs a linear current sweep with voltage measured at every step (point):","1. Sets the smu to output starti amperes, allows the source to settle for stime seconds, and then performs a voltage measurement.","2. Sets the smu to output the next amperes step, allows the source to settle for stime seconds, and then performs a voltage measurement.","3. Repeats the above sequence until the voltage is measured on the stopi amperes step.","The linear step size is automatically calculated as follows:","step = (stopi – starti) / (points – 1)","Example","SweepILinMeasureV(smua, -1E-3, 1E-3, 0, 100)","This function performs a 100-point linear current sweep starting at -1 mA and stopping at +1 mA. Voltage is measured at every step (point) in the sweep. Because stime is set for 0 s, voltage will be measured as fast as possible after each current step.","Also see","None","SweepILinMeasureV()","12177.html");
+Page[415]=new Array("This KISweep factory script function performs a current list sweep with voltage measured at every step (point).","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","SweepIListMeasureV(smu, ilist, stime, points)","smu","System SourceMeter® instrument channel (set to smua)","ilist","Arbitrary list of current source values; ilist = {value1, value2, ...valueN}","stime","Settling time in seconds; occurs after stepping the source and before performing a measurement","points","Number of sweep points (must be ≥2)","Details","Data for voltage measurements, current source values, and timestamps are stored in smuX.nvbuffer1.","If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.","Performs a current list sweep with voltage measured at every step (point):","1. Sets the smu to output ilist amperes value, allows the source to settle for stime seconds, and then performs a voltage measurement.","2. Sets the smu to output the next ilist step, allows the source to settle for stime seconds, and then performs a voltage measurement.","3. Repeats the above sequence until the voltage is measured for the last amperes value. The last point in the list to be measured is points.","Example","testilist = {-100E-9, 100E-9, -1E-6, 1E-6,"," -1E-3, 1E-3}","SweepIListMeasureV(smua, testilist, "," 500E-3, 6)","This function performs a six‑point current list sweep starting at the first point in testilist. Voltage is measured at every step (point) in the sweep. The source will be allowed to settle on each step for 500 ms before a measurement is performed.","Also see","None","SweepIListMeasureV()","12190.html");
+Page[416]=new Array("This KISweep factory script function performs a logarithmic current sweep with voltage measured at every step (point).","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","SweepILogMeasureV(smu, starti, stopi, stime, points)","smu","System SourceMeter® instrument channel (set to smua)","starti","Sweep start current in amperes","stopi","Sweep stop current in amperes","stime","Settling time in seconds; occurs after stepping the source and before performing a measurement","points","Number of sweep points (must be ≥2)","Details","Data for voltage measurements, current source values, and timestamps are stored in smuX.nvbuffer1.","If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.","Performs a logarithmic current sweep with voltage measured at every step (point):","1. Sets the smu to output starti amperes value, allows the source to settle for stime seconds, and then performs a voltage measurement.","2. Sets the smu to output the next amperes step, allows the source to settle for stime seconds, and then performs a voltage measurement.","3. Repeats the above sequence until the voltage is measured on the stopi amperes step.","The source level at each step (SourceStepLevel) is automatically calculated as follows:","MeasurePoint = The step point number for a measurement ","For example, for a five-point sweep (points = 5), a measurement is performed at MeasurePoint 1, 2, 3, 4, and 5.","LogStepSize = (log10(stopi) – log10(starti)) / (points – 1)","LogStep = (MeasurePoint – 1) * (LogStepSize)","SourceStepLevel = antilog(LogStep) * starti","Example","SweepILogMeasureV(smua, 0.01, 0.1,"," 0.001, 5)","This function performs a five‑point linear current sweep starting at 10 mA and stopping at 100 mA. Voltage is measured at every step (point) in the sweep. The source will be allowed to settle on each step for 1 ms before a measurement is performed.","The following table contains log values and corresponding source levels for the five‑point logarithmic sweep:","MeasurePoint","LogStepSize","LogStep","SourceStepLevel","1","0.25","0.0","0.01 A","2","0.25","0.25","0.017783 A","3","0.25","0.5","0.031623 A","4","0.25","0.75","0.056234 A","5","0.25","1.0","0.1 A","Also see","None","SweepILogMeasureV()","12184.html");
+Page[417]=new Array("This KISweep factory script function performs a linear voltage sweep with current measured at every step (point).","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","SweepVLinMeasureI(smu, startv, stopv, stime, points)","smu","System SourceMeter® instrument channel (set to smua)","startv","Sweep start voltage in volts","stopv","Sweep stop voltage in volts","stime","Settling time in seconds; occurs after stepping the source and before performing a measurement","points","Number of sweep points (must be ≥2)","Details","Data for current measurements, voltage source values, and timestamps are stored in smuX.nvbuffer1.","If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.","Performs a linear voltage sweep with current measured at every step (point):","1. Sets the smu to output startv amperes, allows the source to settle for stime seconds, and then performs a current measurement.","2. Sets the smu to output the next amperes step, allows the source to settle for stime seconds, and then performs a voltage measurement.","3. Repeats the above sequence until the voltage is measured on the stopv amperes step.","The linear step size is automatically calculated as follows:","step = (stopv – startv) / (points – 1)","Example","SweepVLinMeasureI(smua, -1, 1, 1E-3, 1000)","This function performs a 1000-point linear voltage sweep starting at -1 V and stopping at +1 V. Current is measured at every step (point) in the sweep after a 1 ms source settling period.","Also see","None","SweepVLinMeasureI()","12181.html");
+Page[418]=new Array("This KISweep factory script function performs a voltage list sweep with current measured at every step (point).","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","SweepVListMeasureI(smu, vlist, stime, points)","smu","System SourceMeter® instrument channel (set to smua)","vlist","Arbitrary list of voltage source values; vlist = {value1, value2, ... valueN}","stime","Settling time in seconds; occurs after stepping the source and before performing a measurement","points","Number of sweep points (must be ≥2)","Details","Data for current measurements, voltage source values, and timestamps are stored in smuX.nvbuffer1.","If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.","Performs a voltage list sweep with current measured at every step (point):","1. Sets the smu to output vlist volts value, allows the source to settle for stime seconds, and then performs a current measurement.","2. Sets the smu to output the next vlist volts value, allows the source to settle for stime seconds, and then performs a current measurement.","3. Repeats the above sequence until the current is measured for the last volts value. The last point in the list to be measured is points.","Example","myvlist = {-0.1, 0.1, -1, 1, -6, 6, -40,"," 40, 0, 0}","SweepVListMeasureI(smua, myvlist, "," 500E-3, 10)","This function performs a 10‑point voltage list sweep starting at the first point in myvlist. Current is measured at every step (point) in the sweep. The source will be allowed to settle on each step for 500 ms before a measurement is performed.","Also see","None","SweepVListMeasureI()","19138.html");
+Page[419]=new Array("This KISweep factory script function performs a logarithmic voltage sweep with current measured at every step (point).","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","SweepVLogMeasureI(smu, startv, stopv, stime, points)","smu","System SourceMeter® instrument channel (set to smua)","startv","Sweep start voltage in volts","stopv","Sweep stop voltage in volts","stime","Settling time in seconds; occurs after stepping the source and before performing a measurement","points","Number of sweep points (must be ≥2)","Details","Data for current measurements, voltage source values, and timestamps are stored in smuX.nvbuffer1.","If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.","Performs a logarithmic voltage sweep with current measured at every step (point):","1. Sets the smu to output startv amperes, allows the source to settle for stime seconds, and then performs a current measurement.","2. Sets the smu to output the next volts step, allows the source to settle for stime seconds, and then performs a current measurement.","3. Repeats the above sequence until the voltage is measured on the stopv volts step.","The source level at each step (SourceStepLevel) is automatically calculated as follows:","MeasurePoint = The step point number for a measurement ","For example, for a five-point sweep (points = 5), a measurement is performed at MeasurePoint 1, 2, 3, 4, and 5.","LogStepSize = (log10(stopi) – log10(starti)) / (points – 1)","LogStep = (MeasurePoint – 1) * (LogStepSize)","SourceStepLevel = antilog(LogStep) * startv","Example","SweepVLogMeasureI(smua, 1, 10,"," 0.001, 5)","This function performs a five‑point logarithmic voltage sweep starting at 1 V and stopping at 10 V. Current is measured at every step (point) in the sweep after a 1 ms source settling period.","The following table contains log values and corresponding source levels for the five‑point logarithmic sweep:","MeasurePoint","LogStepSize","LogStep","SourceStepLevel","1","0.25","0.0","1.0000 V","2","0.25","0.25","1.7783 V","3","0.25","0.5","3.1623 V","4","0.25","0.75","5.6234 V","5","0.25","1.0","10.000 V","Also see","None","SweepVLogMeasureI()","12192.html");
+Page[420]=new Array("This function measures the elapsed time since the timer was last reset.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","time = timer.measure.t()","time","The elapsed time in seconds (1 ïs resolution)","Example 1","timer.reset()","-- (intervening code)","time = timer.measure.t()","print(time)","Resets the timer and measures the time since the reset.","Output:","1.469077e+01","The output will vary. The above output indicates that timer.measure.t() was executed 14.69077 seconds after timer.reset().","Example 2","beeper.beep(0.5, 2400)","print("reset timer")","timer.reset()","delay(0.5)","dt = timer.measure.t()","print("timer after delay:", dt)","beeper.beep(0.5, 2400)","Sets the beeper, resets the timer, sets a delay, then verifies the time of the delay before the next beeper.","Output:","reset timer","timer after delay: 5.00e-01","Also see","timer.reset()","timer.measure.t()","15281.html");
+Page[421]=new Array("This function resets the timer to zero (0) seconds.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","timer.reset()","Example","timer.reset()","-- (intervening code)","time = timer.measure.t()","print(time)","Resets the timer and then measures the time since the reset.","Output:","1.469077e+01","The above output indicates that timer.measure.t() was executed 14.69077 seconds after timer.reset().","Also see","timer.measure.t()","timer.reset()","15282.html");
+Page[422]=new Array("This function clears the blender event detector and resets blender N.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","trigger.blender[N].clear()","N","The blender number (1 to 4)","Details","This function sets the blender event detector to the undetected state and resets the event detector's overrun indicator.","Example","trigger.blender[2].clear()","Clears the event detector for blender 2.","Also see","None","trigger.blender[N].clear()","15785.html");
+Page[423]=new Array("This constant contains the trigger blender event number.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Constant","Yes","Usage","eventID = trigger.blender[N].EVENT_ID","eventID","Trigger event number","N","The blender number (1 to 4)","Details","Set the stimulus of any trigger event detector to the value of this constant to have it respond to trigger events from this trigger blender.","Example","digio.trigger[1].stimulus = trigger.blender[2].EVENT_ID","Set the trigger stimulus of digital I/O trigger 1 to be controlled by the trigger blender 2 event.","Also see","None","trigger.blender[N].EVENT_ID","15786.html");
+Page[424]=new Array("This attribute selects whether the blender operates in OR mode or AND mode.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Trigger blender N reset Recall setup","Not saved ","false (AND mode)","Usage","orenable = trigger.blender[N].orenable","trigger.blender[N].orenable = orenable","orenable","The orenable mode:","true: OR mode","false: AND mode","N","The trigger blender (1 to 4)","Details","This attribute selects whether the blender waits for any one event (the “OR” mode) or waits for all selected events (the “AND” mode) before signaling an output event.","Example","trigger.blender[1].orenable = true","trigger.blender[1].stimulus[1] = digio.trigger[3].EVENT_ID","trigger.blender[1].stimulus[2] = digio.trigger[5].EVENT_ID","Generate a trigger blender 1 event when a digital I/O trigger happens on line 3 or 5.","Also see","trigger.blender[N].reset()","trigger.blender[N].orenable","15787.html");
+Page[425]=new Array("This attribute indicates whether or not an event was ignored because of the event detector state.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Instrument reset Trigger blender N clear Trigger blender N reset","Not applicable","Not applicable","Usage","overrun = trigger.blender[N].overrun","overrun","Trigger blender overrun state","N","The trigger event blender (1 to 4)","Details","Indicates if an event was ignored because the event detector was already in the detected state when the event occurred. This is an indication of the state of the event detector that is built into the event blender itself.","This attribute does not indicate if an overrun occurred in any other part of the trigger model or in any other trigger object that is monitoring the event. It also is not an indication of an action overrun.","Example","print(trigger.blender[1].overrun)","If an event was ignored, the output is true.","If an event was not ignored, the output is false.","Also see","trigger.blender[N].reset()","trigger.blender[N].overrun","15788.html");
+Page[426]=new Array("This function resets some of the trigger blender settings to their factory defaults.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","trigger.blender[N].reset()","N","The trigger event blender (1 to 4)","Details","The trigger.blender[N].reset() function resets the following attributes to their factory defaults:","trigger.blender[N].orenable","trigger.blender[N].stimulus[M]","It also clears trigger.blender[N].overrun.","Example","trigger.blender[1].reset()","Resets the trigger blender 1 settings back to factory defaults.","Also see","trigger.blender[N].orenable","trigger.blender[N].overrun","trigger.blender[N].stimulus[M]","trigger.blender[N].reset()","17666.html");
+Page[427]=new Array("This attribute specifies which events trigger the blender.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Recall setup Trigger blender N reset","Not saved","0","Usage","eventID = trigger.blender[N].stimulus[M]","trigger.blender[N].stimulus[M] = eventID","eventID","The event that triggers the blender action; see Details","N","An integer representing the trigger event blender (1 to 4)","M","An integer representing the stimulus index (1 to 4)","Details","There are four acceptors that can each select a different event. The eventID parameter can be the event ID of any trigger event.","Use zero to disable the blender input. ","The eventID parameter may be one of the existing trigger event IDs shown in the following table.","Trigger event IDs*","Event ID","Event description","smua.trigger.SWEEPING_EVENT_ID","Occurs when the source‑measure unit (SMU) transitions from the idle state to the arm layer of the trigger model","smua.trigger.ARMED_EVENT_ID","Occurs when the SMU moves from the arm layer to the trigger layer of the trigger model","smua.trigger.SOURCE_COMPLETE_EVENT_ID","Occurs when the SMU completes a source action","smua.trigger.MEASURE_COMPLETE_EVENT_ID","Occurs when the SMU completes a measure action","smua.trigger.PULSE_COMPLETE_EVENT_ID","Occurs when the SMU completes a pulse","smua.trigger.SWEEP_COMPLETE_EVENT_ID","Occurs when the SMU completes a sweep","smua.trigger.IDLE_EVENT_ID","Occurs when the SMU returns to the idle state","digio.trigger[N].EVENT_ID","Occurs when an edge is detected on a digital I/O line","tsplink.trigger[N].EVENT_ID","Occurs when an edge is detected on a TSP‑Link line","lan.trigger[N].EVENT_ID","Occurs when the appropriate LXI trigger packet is received on LAN trigger object N","display.trigger.EVENT_ID","Occurs when the TRIG key on the front panel is pressed","trigger.EVENT_ID","Occurs when a *TRG command is received on the remote interface","(GPIB only) Occurs when a GET bus command is received","(VXI-11 only) Occurs with the VXI-11 command device_trigger; reference the VXI-11 standard for additional details on the device trigger operation","trigger.blender[N].EVENT_ID","Occurs after a collection of events is detected","trigger.timer[N].EVENT_ID","Occurs when a delay expires","* Use the name of the trigger event ID to set the stimulus value rather than the numeric value. Using the name makes the code compatible for future upgrades (for example, if the numeric values must change when enhancements are added to the instrument).","Example","digio.trigger[3].mode = digio.TRIG_FALLING","digio.trigger[5].mode = digio.TRIG_FALLING","trigger.blender[1].orenable = true","trigger.blender[1].stimulus[1] = digio.trigger[3].EVENT_ID","trigger.blender[1].stimulus[2] = digio.trigger[5].EVENT_ID","Generate a trigger blender 1 event when a digital I/O trigger happens on line 3 or 5.","Also see","trigger.blender[N].reset()","trigger.blender[N].stimulus[M]","17684.html");
+Page[428]=new Array("This function waits for a blender trigger event to occur.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","triggered = trigger.blender[N].wait(timeout)","triggered","Trigger detection indication for blender","N","The trigger blender (1 to 4) on which to wait","timeout","Maximum amount of time in seconds to wait for the trigger blender event","Details","This function waits for an event blender trigger event. If one or more trigger events were detected since the last time trigger.blender[N].wait() or trigger.blender[N].clear() was called, this function returns immediately.","After detecting a trigger with this function, the event detector automatically resets and rearms. This is true regardless of the number of events detected.","Example","digio.trigger[3].mode = digio.TRIG_FALLING","digio.trigger[5].mode = digio.TRIG_FALLING","trigger.blender[1].orenable = true","trigger.blender[1].stimulus[1] = digio.trigger[3].EVENT_ID","trigger.blender[1].stimulus[2] = digio.trigger[5].EVENT_ID","print(trigger.blender[1].wait(3))","Generate a trigger blender 1 event when a digital I/O trigger happens either on line 3 or 5.","Wait three seconds while checking if trigger blender 1 event has occurred.","If the blender trigger event has happened, then true is output. If the trigger event has not happened, then false is output after the timeout expires.","Also see","trigger.blender[N].clear()","trigger.blender[N].wait()","15790.html");
+Page[429]=new Array("This function clears the command interface trigger event detector.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","trigger.clear()","Details","The trigger event detector indicates if an event has been detected since the last trigger.wait() call. This function clears the trigger's event detector and discards the previous history of command interface trigger events.","Also see","trigger.wait()","trigger.clear()","15791.html");
+Page[430]=new Array("This constant contains the command interface trigger event number.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Constant","Yes","Usage","eventID = trigger.EVENT_ID","eventID","The command interface trigger event number","Details","You can set the stimulus of any trigger event detector to the value of this constant to have it respond to command interface trigger events.","Example","trigger.timer[1].stimulus = trigger.EVENT_ID","Sets the trigger stimulus of trigger timer 1 to the command interface trigger event.","Also see","None","trigger.EVENT_ID","15792.html");
+Page[431]=new Array("This function clears the timer event detector and overrun indicator for the specified trigger timer number.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","trigger.timer[N].clear()","N","Trigger timer number to clear (1 to 4)","Details","This function sets the timer event detector to the undetected state and resets the overrun indicator.","Example","trigger.timer[1].clear()","Clears trigger timer 1.","Also see","trigger.timer[N].count","trigger.timer[N].clear()","15793.html");
+Page[432]=new Array("This attribute sets the number of events to generate each time the timer is triggered.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Recall setup Trigger timer N reset","Not saved ","1","Usage","count = trigger.timer[N].count","trigger.timer[N].count = count","count","Number of times to repeat the trigger","N","A trigger timer number (1 to 4)","Details","If count is set to a number greater than 1, the timer automatically starts the next delay at expiration of the previous delay.","Set count to zero (0) to cause the timer to generate trigger events indefinitely.","Example","print(trigger.timer[1].count)","Read trigger count for timer number 1.","Also see","trigger.timer[N].clear()","trigger.timer[N].reset()","trigger.timer[N].count","15820.html");
+Page[433]=new Array("This attribute sets and reads the timer delay.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Recall setup Trigger timer N reset","Not saved ","10e-6 (10 mS)","Usage","interval = trigger.timer[N].delay","trigger.timer[N].delay = interval","interval","Delay interval in seconds","N","Trigger timer number (1 to 4)","Details","Each time the timer is triggered, it uses this delay period.","Assigning a value to this attribute is equivalent to:","trigger.timer[N].delaylist = {interval}","This creates a delay list of one value.","Reading this attribute returns the delay interval that will be used the next time the timer is triggered.","Example","trigger.timer[1].delay = 50e-6","Set the trigger timer 1 to delay for 50 µs.","Also see","trigger.timer[N].reset()","trigger.timer[N].delay","15794.html");
+Page[434]=new Array("This attribute sets an array of timer intervals that are used when triggered.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Recall setup Trigger timer N reset","Not saved ","{10e-6}","Usage","intervals = trigger.timer[N].delaylist","trigger.timer[N].delaylist = intervals","intervals","Table of delay intervals in seconds","N","Trigger timer number (1 to 4)","Details","Each time the timer is triggered, it uses the next delay period from the array. The default value is an array with one value of 10 mS.","After all elements in the array have been used, the delays restart at the beginning of the list.","If the array contains more than one element, the average of the delay intervals in the list must be ≥ 50 µs.","Example","trigger.timer[3].delaylist = {50e-6, 100e-6, 150e-6}","DelayList = trigger.timer[3].delaylist","for x = 1, table.getn(DelayList) do"," print(DelayList[x])","end","Set a delay list on trigger timer 3 with three delays (50 µs, 100 µs, and 150 µs).","Read the delay list on trigger timer 3.","Output (assuming the delay list was set to 50 µs, 100 µs, and 150 µs):","5.000000000e-05","1.000000000e-04","1.500000000e-04","Also see","trigger.timer[N].reset()","trigger.timer[N].delaylist","15795.html");
+Page[435]=new Array("This constant specifies the trigger timer event number.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Constant","Yes","Usage","eventID = trigger.timer[N].EVENT_ID","eventID","The trigger event number","N","The trigger timer number (1 to 4)","Details","This constant is an identification number that identifies events generated by this timer.","Set the stimulus of any trigger event detector to the value of this constant to have it respond to events from this timer.","Example","trigger.timer[1].stimulus = tsplink.trigger[2].EVENT_ID","Sets the trigger stimulus of trigger timer 1 to the TSP-Link trigger 2 event.","Also see","None","trigger.timer[N].EVENT_ID","15796.html");
+Page[436]=new Array("This attribute indicates if an event was ignored because of the event detector state.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Instrument reset Recall setup Trigger timer N clear Trigger timer N reset","Not applicable","false","Usage","overrun = trigger.timer[N].overrun","overrun","Trigger overrun state","N","Trigger timer number (1 to 4)","Details","This attribute indicates if an event was ignored because the event detector was already in the detected state when the event occurred.","This is an indication of the state of the event detector built into the timer itself. It does not indicate if an overrun occurred in any other part of the trigger model or in any other construct that is monitoring the delay completion event. It also is not an indication of a delay overrun.","Example","print(trigger.timer[1].overrun)","If an event was ignored, the output is true.","If the event was not ignored, the output is false.","Also see","trigger.timer[N].reset()","trigger.timer[N].overrun","15797.html");
+Page[437]=new Array("This attribute enables or disables the timer trigger pass‑through mode.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Recall setup Trigger timer N reset","Not saved ","false (disabled)","Usage","passthrough = trigger.timer[N].passthrough","trigger.timer[N].passthrough = passthrough","passthrough","The state of pass-through mode. Set to to one of the following values:","true: Enabled","false: Disabled","N","Trigger timer number (1 to 4)","Details","When enabled, triggers are passed through immediately and initiate the delay. When disabled, a trigger only initiates a delay.","Example","trigger.timer[1].passthrough = true","Enables pass‑through mode on trigger timer 1.","Also see","trigger.timer[N].reset()","trigger.timer[N].passthrough","15798.html");
+Page[438]=new Array("This function resets some of the trigger timer settings to their factory defaults.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","trigger.timer[N].reset()","N","Trigger timer number (1 to 4)","Details","The trigger.timer[N].reset() function resets the following attributes to their factory defaults:","trigger.timer[N].count","trigger.timer[N].delay","trigger.timer[N].delaylist","trigger.timer[N].passthrough","trigger.timer[N].stimulus","It also clears trigger.timer[N].overrun.","Example","trigger.timer[1].reset()","Resets the attributes associated with timer 1 back to factory default values.","Also see","trigger.timer[N].count","trigger.timer[N].delay","trigger.timer[N].delaylist","trigger.timer[N].overrun","trigger.timer[N].passthrough","trigger.timer[N].stimulus","trigger.timer[N].reset()","17668.html");
+Page[439]=new Array("This attribute specifies which event starts the timer.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Recall setup Trigger timer N reset","Not saved","0","Usage","eventID = trigger.timer[N].stimulus","trigger.timer[N].stimulus = eventID","eventID","The event that triggers the timer delay","N","Trigger timer number (1 to 4)","Details","The eventID parameter may be one of the trigger event IDs shown in the following table.","Trigger event IDs*","Event ID","Event description","smua.trigger.SWEEPING_EVENT_ID","Occurs when the source‑measure unit (SMU) transitions from the idle state to the arm layer of the trigger model","smua.trigger.ARMED_EVENT_ID","Occurs when the SMU moves from the arm layer to the trigger layer of the trigger model","smua.trigger.SOURCE_COMPLETE_EVENT_ID","Occurs when the SMU completes a source action","smua.trigger.MEASURE_COMPLETE_EVENT_ID","Occurs when the SMU completes a measure action","smua.trigger.PULSE_COMPLETE_EVENT_ID","Occurs when the SMU completes a pulse","smua.trigger.SWEEP_COMPLETE_EVENT_ID","Occurs when the SMU completes a sweep","smua.trigger.IDLE_EVENT_ID","Occurs when the SMU returns to the idle state","digio.trigger[N].EVENT_ID","Occurs when an edge is detected on a digital I/O line","tsplink.trigger[N].EVENT_ID","Occurs when an edge is detected on a TSP‑Link line","lan.trigger[N].EVENT_ID","Occurs when the appropriate LXI trigger packet is received on LAN trigger object N","display.trigger.EVENT_ID","Occurs when the TRIG key on the front panel is pressed","trigger.EVENT_ID","Occurs when a *TRG command is received on the remote interface","(GPIB only) Occurs when a GET bus command is received","(VXI-11 only) Occurs with the VXI-11 command device_trigger; reference the VXI-11 standard for additional details on the device trigger operation","trigger.blender[N].EVENT_ID","Occurs after a collection of events is detected","trigger.timer[N].EVENT_ID","Occurs when a delay expires","* Use the name of the trigger event ID to set the stimulus value rather than the numeric value. Using the name makes the code compatible for future upgrades (for example, if the numeric values must change when enhancements are added to the instrument).","Set this attribute to the eventID of any trigger event to cause the timer to start when that event occurs.","Use zero (0) to disable event processing.","Example","print(trigger.timer[1].stimulus)","Prints the event that will start a trigger 1 timer action.","Also see","trigger.timer[N].reset()","trigger.timer[N].stimulus","17688.html");
+Page[440]=new Array("This function waits for a trigger.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","triggered = trigger.timer[N].wait(timeout)","triggered","Trigger detection indication","N","Trigger timer number (1 to 4)","timeout","Maximum amount of time in seconds to wait for the trigger","Details","If one or more trigger events were detected since the last time trigger.timer[N].wait() or trigger.timer[N].clear() was called, this function returns immediately.","After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.","Example","triggered = trigger.timer[3].wait(10)","print(triggered)","Waits up to 10 seconds for a trigger on timer 3.","If false is returned, no trigger was detected during the 10-second timeout.","If true is returned, a trigger was detected.","Also see","trigger.timer[N].clear()","trigger.timer[N].wait()","15800.html");
+Page[441]=new Array("This function waits for a command interface trigger event.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","triggered = trigger.wait(timeout)","triggered","true: A trigger was detected during the timeout period","false: No triggers were detected during the timeout period","timeout","Maximum amount of time in seconds to wait for the trigger","Details","This function waits up to timeout seconds for a trigger on the active command interface. A command interface trigger occurs when:","A GPIB GET command is detected (GPIB only)","A VXI-11 device_trigger method is invoked (VXI-11 only)","A *TRG message is received","If one or more of these trigger events were previously detected, this function returns immediately.","After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.","Example","triggered = trigger.wait(10)","print(triggered)","Waits up to 10 seconds for a trigger.","If false is returned, no trigger was detected during the 10‑second timeout.","If true is returned, a trigger was detected.","Also see","trigger.clear()","trigger.wait()","15801.html");
+Page[442]=new Array("This attribute is the group number of a TSP‑Link node.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Not applicable","Not saved","0","Usage","groupNumber = tsplink.group","tsplink.group = groupNumber","groupNumber","The group number of the TSP-Link node (0 to 64)","Details","To remove the node from all groups, set the attribute value to 0.","When the node is turned off, the group number for that node changes to 0.","The master node can be assigned to any group. You can also include other nodes in the group that includes the master. Note that any nodes that are set to 0 are automatically included in the group that contains the master node, regardless of the group that is assigned to the master node.","Example","tsplink.group = 3","Assign the instrument to TSP-Link group number 3.","Also see","Using groups to manage nodes on TSP-Link network","tsplink.group","15285.html");
+Page[443]=new Array("This attribute reads the node number assigned to the master node.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not applicable","Not applicable","Usage","masterNodeNumber = tsplink.master","masterNodeNumber","The node number of the master node","Details","After doing a TSP-Link reset (tsplink.reset()), use this attribute to access the node number of the master in a set of instruments connected over TSP-Link.","Example","LinkMaster = tsplink.master","Store the TSP-Link master node number in a variable called LinkMaster.","Also see","tsplink.reset()","tsplink.master","15286.html");
+Page[444]=new Array("This attribute defines the node number.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Not applicable","Nonvolatile memory","1","Usage","nodeNumber = tsplink.node","tsplink.node = nodeNumber","nodeNumber","Set node to a number (1 to 64)","Details","This attribute sets the TSP‑Link node number and saves the value in nonvolatile memory.","Changes to the node number do not take effect until the next time tsplink.reset() is executed on any node in the system.","Each node connected to the TSP-Link system must be assigned a different node number.","Example","tsplink.node = 2","Sets the TSP‑Link node to number 2.","Also see","tsplink.reset()","tsplink.state","tsplink.node","15287.html");
+Page[445]=new Array("This function reads the state of a TSP-Link synchronization line.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","data = tsplink.readbit(N)","data","A custom variable that stores the state of the synchronization line","N","The trigger line (1 to 3)","Details","Returns a value of zero (0) if the line is low and 1 if the line is high.","Example","data = tsplink.readbit(3)","print(data)","Assume line 3 is set high, and it is then read.","Output","1.000000e+00","Also see","tsplink.readport()","tsplink.writebit()","tsplink.readbit()","15288.html");
+Page[446]=new Array("This function reads the TSP-Link® synchronization lines as a digital I/O port.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","data = tsplink.readport()","data","Numeric value returned indicating which register bits are set","Details","The binary equivalent of the returned value indicates the input pattern on the I/O port. The least significant bit of the binary number corresponds to line 1 and bit B3 corresponds to line 3. For example, a returned value of 2 has a binary equivalent of 010. Line 2 is high (1), and the other 2 lines are low (0).","Example","data = tsplink.readport()","print(data)","Reads state of all three TSP-Link lines.","Assuming line 2 is set high, the output is:","2.000000e+00 ","(binary 010)","Also see","TSP-Link synchronization lines","tsplink.readbit()","tsplink.writebit()","tsplink.writeport()","tsplink.readport()","15289.html");
+Page[447]=new Array("This function initializes (resets) all nodes (instruments) in the TSP‑Link system.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","nodesFound = tsplink.reset()","nodesFound = tsplink.reset(expectedNodes)","nodesFound","The number of nodes actually found on the system","expectedNodes","The number of nodes expected on the system (1 to 64)","Details","This function erases all knowledge of other nodes connected on the TSP-Link system and regenerates the system configuration. This function must be called at least once before any remote nodes can be accessed. If the node number for any instrument is changed, the TSP-Link nodes must be initialized again.","If expectedNodes is not given, this function generates an error if no other nodes are found on the TSP‑Link network.","If nodesFound is less than expectedNodes, an error is generated. Note that the node on which the command is running is counted as a node. For example, giving an expected node count of 1 will not generate any errors, even if there are no other nodes on the TSP-Link network.","Also returns the number of nodes found.","Example","nodesFound = tsplink.reset(2)","print("Nodes found = " .. nodesFound)","Perform a TSP-Link reset and indicate how many nodes are found.","Sample output if found 2 nodes: Nodes found = 2","Sample output if fewer nodes are found and if localnode.showerrors = 1: 1219, TSP-Link found fewer nodes than expected Nodes found = 1","Also see","localnode.showerrors","tsplink.node","tsplink.state","tsplink.reset()","15290.html");
+Page[448]=new Array("This attribute describes the TSP‑Link online state.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not applicable","Not applicable","Usage","state = tsplink.state","state","TSP-Link state (online or offline)","Details","When the instrument power is turned on, the state is offline. After tsplink.reset() function is successful, the state is online.","Example","state = tsplink.state","print(state)","Read the state of the TSP‑Link. If it is online, the output is:","online","Also see","tsplink.node","tsplink.reset()","tsplink.state","15291.html");
+Page[449]=new Array("This function simulates the occurrence of the trigger and generates the corresponding event ID.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","tsplink.trigger[N].assert()","N","The trigger line (1 to 3)","Details","The set pulse width determines how long the trigger is asserted.","Example","tsplink.trigger[2].assert()","Asserts trigger on trigger line 2.","Also see","tsplink.trigger[N].clear()","tsplink.trigger[N].mode","tsplink.trigger[N].overrun","tsplink.trigger[N].pulsewidth","tsplink.trigger[N].release()","tsplink.trigger[N].stimulus","tsplink.trigger[N].wait()","tsplink.trigger[N].assert()","15292.html");
+Page[450]=new Array("This function clears the event detector for a trigger.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","tsplink.trigger[N].clear()","N","The trigger line (1 to 3)","Details","The event detector for a trigger recalls if a trigger event has been detected since the last tsplink.trigger[N].wait() call. This function clears a trigger event detector, discards the previous history of the trigger line, and clears the tsplink.trigger[N].overrun attribute.","Example","tsplink.trigger[2].clear()","Clears trigger event on synchronization line 2.","Also see","tsplink.trigger[N].mode","tsplink.trigger[N].overrun","tsplink.trigger[N].release()","tsplink.trigger[N].stimulus","tsplink.trigger[N].wait()","tsplink.trigger[N].clear()","15293.html");
+Page[451]=new Array("This constant identifies the number that is used for the trigger events.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Constant","Yes","Usage","eventID = tsplink.trigger[N].EVENT_ID","eventID","The trigger event number","N","The trigger line (1 to 3)","Details","This number is used by the TSP-Link trigger line when it detects an input trigger.","Set the stimulus of any trigger event detector to the value of this constant to have it respond to trigger events from this line.","Example","trigger.timer[1].stimulus = tsplink.trigger[2].EVENT_ID","Sets the trigger stimulus of trigger timer 1 to the TSP-Link trigger 2 event.","Also see","None","tsplink.trigger[N].EVENT_ID","15294.html");
+Page[452]=new Array("This attribute defines the trigger operation and detection mode.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Recall setup TSP-Link trigger N reset","Not saved ","0 (tsplink.TRIG_BYPASS)","Usage","mode = tsplink.trigger[N].mode","tsplink.trigger[N].mode = mode","mode","The trigger mode","N","The trigger line (1 to 3)","Details","This attribute controls the mode in which the trigger event detector and the output trigger generator operate on the given trigger line.","The setting for mode can be one of the following values:","Mode","Number value","Description","tsplink.TRIG_BYPASS","0","Allows direct control of the line as a digital I/O line.","tsplink.TRIG_FALLING","1","Detects falling‑edge triggers as input. Asserts a TTL-low pulse for output.","tsplink.TRIG_RISING","2","If the programmed state of the line is high, the tsplink.TRIG_RISING mode behaves similar to tsplink.TRIG_RISINGA. If the programmed state of the line is low, the tsplink.TRIG_RISING mode behaves similar to tsplink.TRIG_RISINGM. Use tsplink.TRIG_RISINGA if the line is in the high output state. Use tsplink.TRIG_RISINGM if the line is in the low output state.","tsplink.TRIG_EITHER","3","Detects rising‑ or falling‑edge triggers as input. Asserts a TTL‑low pulse for output.","tsplink.TRIG_SYNCHRONOUSA","4","Detects the falling‑edge input triggers and automatically latches and drives the trigger line low.","tsplink.TRIG_SYNCHRONOUS","5","Detects the falling‑edge input triggers and automatically latches and drives the trigger line low. Asserts a TTL-low pulse as an output trigger.","tsplink.TRIG_SYNCHRONOUSM","6","Detects rising‑edge triggers as an input. Asserts a TTL‑low pulse for output.","tsplink.TRIG_RISINGA","7","Detects rising‑edge triggers as input. Asserts a TTL‑low pulse for output.","tsplink.TRIG_RISINGM","8","Edge detection as an input is not available. Generates a TTL‑high pulse as an output trigger.","When programmed to any other mode, the output state of the I/O line is controlled by the trigger logic, and the user-specified output state of the line is ignored.","When the trigger mode is set to tsplink.TRIG_RISING, the user‑specified output state of the line will be examined. If the output state selected when the mode is changed is high, the actual mode used will be tsplink.TRIG_RISINGA. If the output state selected when the mode is changed is low, the actual mode used will be tsplink.TRIG_RISINGM.","The custom variable mode stores the trigger mode as a numeric value when the attribute is read.","To control the line state, use the tsplink.TRIG_BYPASS mode with the tsplink.writebit() and the tsplink.writeport() commands.","Example","tsplink.trigger[3].mode = tsplink.TRIG_RISINGM","Sets the trigger mode for synchronization line 3 to tsplink.TRIG_RISINGM.","Also see","digio.writebit()","digio.writeport()","tsplink.trigger[N].assert()","tsplink.trigger[N].clear()","tsplink.trigger[N].overrun","tsplink.trigger[N].release()","tsplink.trigger[N].reset()","tsplink.trigger[N].stimulus","tsplink.trigger[N].wait()","tsplink.trigger[N].mode","15295.html");
+Page[453]=new Array("This attribute indicates if the event detector ignored an event while in the detected state.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Instrument reset Recall setup TSP-Link trigger N clear TSP-Link trigger N reset","Not applicable","Not applicable","Usage","overrun = tsplink.trigger[N].overrun","overrun","Trigger overrun state","N","The trigger line (1 to 3)","Details","Indicates that an event was ignored because the event detector was in the detected state when the event was detected.","Indicates the overrun state of the event detector built into the line itself.","It does not indicate whether an overrun occurred in any other part of the trigger model or in any other detector that is monitoring the event.","It does not indicate output trigger overrun.","Example","print(tsplink.trigger[1].overrun)","If an event was ignored, displays true; if an event was not ignored, displays false.","Also see","tsplink.trigger[N].assert()","tsplink.trigger[N].clear()","tsplink.trigger[N].mode","tsplink.trigger[N].release()","tsplink.trigger[N].reset()","tsplink.trigger[N].stimulus","tsplink.trigger[N].wait()","tsplink.trigger[N].overrun","15296.html");
+Page[454]=new Array("This attribute sets the length of time that the trigger line is asserted for output triggers.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset TSP-Link trigger N reset Recall setup","Not saved","10e-6 (10 mS)","Usage","width = tsplink.trigger[N].pulsewidth","tsplink.trigger[N].pulsewidth = width","width","The pulse width (in seconds)","N","The trigger line (1 to 3)","Details","Setting the pulse width to 0 (seconds) asserts the trigger indefinitely.","Example","tsplink.trigger[3].pulsewidth = 20e-6","Sets pulse width for trigger line 3 to 20 μs.","Also see","tsplink.trigger[N].release()","tsplink.trigger[N].pulsewidth","15297.html");
+Page[455]=new Array("This function releases a latched trigger on the given TSP‑Link trigger line.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","tsplink.trigger[N].release()","N","The trigger line (1 to 3)","Details","Releases a trigger that was asserted with an indefinite pulse width, as well as a trigger that was latched in response to receiving a synchronous mode trigger.","Example","tsplink.trigger[3].release()","Releases trigger line 3.","Also see","tsplink.trigger[N].assert()","tsplink.trigger[N].clear()","tsplink.trigger[N].mode","tsplink.trigger[N].overrun","tsplink.trigger[N].pulsewidth","tsplink.trigger[N].stimulus","tsplink.trigger[N].wait()","tsplink.trigger[N].release()","15298.html");
+Page[456]=new Array("This function resets some of the TSP-Link trigger settings to their factory defaults.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","tsplink.trigger[N].reset()","N","The trigger line (1 to 3)","Details","The tsplink.trigger[N].reset() function resets the following attributes to their factory defaults:","tsplink.trigger[N].mode","tsplink.trigger[N].stimulus","tsplink.trigger[N].pulsewidth","This also clears tsplink.trigger[N].overrun.","Example","tsplink.trigger[3].reset()","Resets TSP-Link trigger line 3 attributes back to factory default values.","Also see","tsplink.trigger[N].mode","tsplink.trigger[N].overrun","tsplink.trigger[N].pulsewidth","tsplink.trigger[N].stimulus","tsplink.trigger[N].reset()","17669.html");
+Page[457]=new Array("This attribute specifies the event that causes the synchronization line to assert a trigger.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Recall setup TSP-Link trigger N reset","Not saved","0","Usage","eventID = tsplink.trigger[N].stimulus","tsplink.trigger[N].stimulus = eventID","eventID","The event identifier for the triggering event","N","The trigger line (1 to 3)","Details","To disable automatic trigger assertion on the synchronization line, set this attribute to zero (0).","Do not use this attribute when triggering under script control. Use tsplink.trigger[N].assert() instead.","The eventID parameter may be one of the existing trigger event IDs shown in the following table.","Trigger event IDs*","Event ID","Event description","smua.trigger.SWEEPING_EVENT_ID","Occurs when the source‑measure unit (SMU) transitions from the idle state to the arm layer of the trigger model","smua.trigger.ARMED_EVENT_ID","Occurs when the SMU moves from the arm layer to the trigger layer of the trigger model","smua.trigger.SOURCE_COMPLETE_EVENT_ID","Occurs when the SMU completes a source action","smua.trigger.MEASURE_COMPLETE_EVENT_ID","Occurs when the SMU completes a measure action","smua.trigger.PULSE_COMPLETE_EVENT_ID","Occurs when the SMU completes a pulse","smua.trigger.SWEEP_COMPLETE_EVENT_ID","Occurs when the SMU completes a sweep","smua.trigger.IDLE_EVENT_ID","Occurs when the SMU returns to the idle state","digio.trigger[N].EVENT_ID","Occurs when an edge is detected on a digital I/O line","tsplink.trigger[N].EVENT_ID","Occurs when an edge is detected on a TSP‑Link line","lan.trigger[N].EVENT_ID","Occurs when the appropriate LXI trigger packet is received on LAN trigger object N","display.trigger.EVENT_ID","Occurs when the TRIG key on the front panel is pressed","trigger.EVENT_ID","Occurs when a *TRG command is received on the remote interface","(GPIB only) Occurs when a GET bus command is received","(VXI-11 only) Occurs with the VXI-11 command device_trigger; reference the VXI-11 standard for additional details on the device trigger operation","trigger.blender[N].EVENT_ID","Occurs after a collection of events is detected","trigger.timer[N].EVENT_ID","Occurs when a delay expires","* Use the name of the trigger event ID to set the stimulus value rather than the numeric value. Using the name makes the code compatible for future upgrades (for example, if the numeric values must change when enhancements are added to the instrument).","Example","print(tsplink.trigger[3].stimulus)","Prints the event that will start TSP-Link trigger line 3 action.","Also see","tsplink.trigger[N].assert()","tsplink.trigger[N].reset()","tsplink.trigger[N].stimulus","17682.html");
+Page[458]=new Array("This function waits for a trigger.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","triggered = tsplink.trigger[N].wait(timeout)","triggered","Trigger detection indication; set to one of the following values:","true: A trigger is detected during the timeout period","false: A trigger is not detected during the timeout period","N","The trigger line (1 to 3)","timeout","The timeout value in seconds","Details","This function waits up to the timeout value for an input trigger. If one or more trigger events were detected since the last time tsplink.trigger[N].wait() or tsplink.trigger[N].clear() was called, this function returns immediately.","After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.","Example","triggered = tsplink.trigger[3].wait(10)","print(triggered)","Waits up to 10 seconds for a trigger on TSP-Link® line 3.","If false is returned, no trigger was detected during the 10-second timeout.","If true is returned, a trigger was detected.","Also see","tsplink.trigger[N].clear()","tsplink.trigger[N].wait()","15300.html");
+Page[459]=new Array("This function sets a TSP-Link synchronization line high or low.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","tsplink.writebit(N, data)","N","The trigger line (1 to 3)","data","The value to write to the bit:","Low: 0","High: 1","Details","Use tsplink.writebit() and tsplink.writeport() to control the output state of the trigger line when trigger operation is set to tsplink.TRIG_BYPASS.","If the output line is write‑protected by the tsplink.writeprotect attribute, this command is ignored.","The reset function does not affect the present states of the TSP-Link trigger lines.","Example","tsplink.writebit(3, 0)","Sets trigger line 3 low (0).","Also see","tsplink.readbit()","tsplink.readport()","tsplink.writeport()","tsplink.writeprotect","tsplink.writebit()","15301.html");
+Page[460]=new Array("This function writes to all TSP‑Link synchronization lines.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","tsplink.writeport(data)","data","Value to write to the port (0 to 7)","Details","The binary representation of data indicates the output pattern that is written to the I/O port. For example, a data value of 2 has a binary equivalent of 010. Line 2 is set high (1), and the other two lines are set low (0).","Write‑protected lines are not changed.","The reset() function does not affect the present states of the trigger lines.","Use the tsplink.writebit() and tsplink.writeport() commands to control the output state of the synchronization line when trigger operation is set to tsplink.TRIG_BYPASS.","Example","tsplink.writeport(3)","Sets the synchronization lines 1 and 2 high (binary 011).","Also see","tsplink.readbit()","tsplink.readport()","tsplink.writebit()","tsplink.writeprotect","tsplink.writeport()","15302.html");
+Page[461]=new Array("This attribute contains the write‑protect mask that protects bits from changes by the tsplink.writebit() and tsplink.writeport() functions.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Recall setup","Saved setup ","0","Usage","mask = tsplink.writeprotect","tsplink.writeprotect = mask","mask","An integer that specifies the value of the bit pattern for write‑protect; set bits to 1 to write‑protect the corresponding TSP-Link trigger line","Details","The binary equivalent of mask indicates the mask to be set for the TSP-Link trigger line. For example, a mask value of 5 has a binary equivalent 101. This mask write‑protects TSP-Link trigger lines 1 and 3.","Example","tsplink.writeprotect = 5","Write‑protects TSP-Link trigger lines 1 and 3.","Also see","Controlling digital I/O lines","tsplink.readbit()","tsplink.readport()","tsplink.writebit()","tsplink.writeport()","tsplink.writeprotect","17630.html");
+Page[462]=new Array("This function clears any pending output data from the instrument.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","tspnet.clear(connectionID)","connectionID","The connection ID returned from tspnet.connect()","Details","This function clears any pending output data from the device. No data is returned to the caller and no data is processed.","Example","tspnet.write(testdevice, "print([[hello]])")","print(tspnet.readavailable(testdevice))","tspnet.clear(testdevice)","print(tspnet.readavailable(testdevice))","Write data to a device, then print how much is available.","Output:","6.00000e+00","Clear data and print how much data is available again.","Output:","0.00000e+00","Also see","tspnet.connect()","tspnet.readavailable()","tspnet.write()","tspnet.clear()","14073.html");
+Page[463]=new Array("This function connects the device processing the command to another device through the LAN interface.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","connectionID = tspnet.connect(ipAddress)","connectionID = tspnet.connect(ipAddress, portNumber, initString)","connectionID","The connection ID to be used as a handle in all other tspnet function calls","ipAddress","IP address to which to connect","portNumber","Port number","initString","Initialization string to send to ipAddress","Details","This command connects a device to another device through the LAN interface. The default port number is 5025. If the portNumber is 23, the interface uses the Telnet protocol and sets appropriate termination characters to communicate with the device.","If a portNumber and initString are provided, it is assumed that the remote device is not TSP‑enabled. The Model 2651A does not perform any extra processing, prompt handling, error handling, or sending of commands. Additionally, the tspnet.tsp.* commands cannot be used on devices that are not TSP‑enabled.","If neither a portNumber nor an initString is provided, the remote device is assumed to be a Keithley Instruments TSP‑enabled device. Depending on the state of the tspnet.tsp.abortonconnect attribute, the Model 2651A sends an abort command to the remote device on connection. ","The Model 2651A also enables TSP prompts on the remote device and error management. The Model 2651A places remote errors from the TSP‑enabled device in its own error queue and prefaces these errors with Remote Error, followed by an error description. ","Do not manually change either the prompt functionality (localnode.prompts) or show errors by changing localnode.showerrors on the remote TSP-enabled device, or subsequent tspnet.tsp.* commands using the connection may fail.","You can simultaneously connect to a maximum of 32 remote devices.","Example 1","instrumentID = tspnet.connect("192.0.2.1")","if instrumentID then"," -- Use instrumentID as needed here"," tspnet.disconnect(instrumentID)","end","Connect to a TSP-enabled device.","Example 2","instrumentID = tspnet.connect("192.0.2.1", 1394, "*rst\\r\\n")","if instrumentID then"," -- Use instrumentID as needed here"," tspnet.disconnect(instrumentID)","end","Connect to a device that is not TSP‑enabled.","Also see","localnode.prompts","localnode.showerrors","tspnet.tsp.abortonconnect","tspnet.disconnect()","tspnet.connect()","14074.html");
+Page[464]=new Array("This function disconnects a specified TSP-Net session.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","tspnet.disconnect(connectionID)","connectionID","The connection ID returned from tspnet.connect()","Details","This function disconnects the two devices by closing the connection. The connectionID is the session handle returned by tspnet.connect().","For TSP-enabled devices, this aborts any remotely running commands or scripts.","Example","testID = tspnet.connect("192.0.2.0")","-- Use the connection","tspnet.disconnect(testID)","Create a TSP‑Net session.","Close the session.","Also see","tspnet.connect()","tspnet.disconnect()","14076.html");
+Page[465]=new Array("This function executes a command string on the remote device.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","tspnet.execute(connectionID, commandString)","value1 = tspnet.execute(connectionID, commandString, formatString)","value1, value2 = tspnet.execute(connectionID, commandString, formatString)","value1, ..., valuen = tspnet.execute(connectionID, commandString, formatString)","connectionID","The connection ID returned from tspnet.connect()","commandString","The command to send to the remote device","value1","The first value decoded from the response message","value2","The second value decoded from the response message","valuen","The nth value decoded from the response message; there is one return value per format specifier in the format string","...","One or more values separated with commas","formatString","Format string for the output","Details","This command sends the command string to the remote instrument. A termination is added to the command string when it is sent to the remote instrument (tspnet.termination()). You can also specify a format string, which causes the command to wait for a response from the remote instrument. The Model 2651A decodes the response message according to the format specified in the format string and returns the message as return values from the function (see tspnet.read() for format specifiers).","When this command is sent to a TSP-enabled instrument, the Model 2651A suspends operation until a timeout error is generated or until the instrument responds, even if no format string is specified. The TSP prompt from the remote instrument is read and thrown away. The Model 2651A places any remotely generated errors into its error queue. When the optional format string is not specified, this command is equivalent to tspnet.write(), except that a termination is automatically added to the end of the command.","Example 1","tspnet.execute(instrumentID, "runScript()")","Command remote device to run script named runScript.","Example 2","tspnet.termination(instrumentID, tspnet.TERM_CRLF)","tspnet.execute(instrumentID, "*idn?")","print("tspnet.execute returns:", tspnet.read(instrumentID))","Print the *idn? string from the remote device.","Also see","tspnet.connect()","tspnet.read()","tspnet.termination()","tspnet.write()","tspnet.execute()","14077.html");
+Page[466]=new Array("This function retrieves the response of the remote device to *IDN?.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","idnString = tspnet.idn(connectionID)","idnString","The returned *IDN? string","connectionID","The connection ID returned from tspnet.connect()","Details","This function retrieves the response of the remote device to *IDN?.","Example","deviceID = tspnet.connect("192.0.2.1")","print(tspnet.idn(deviceID))","tspnet.disconnect(deviceID)","Assume the instrument at IP address 192.0.2.1.","The output from connecting to the instrument and reading the IDN string may appear as:","Keithley Instruments Inc., Model 2651A, 00000170, 1.1.0","Also see","tspnet.connect()","tspnet.idn()","14078.html");
+Page[467]=new Array("This function reads data from a remote device.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","value1 = tspnet.read(connectionID)","value1 = tspnet.read(connectionID, formatString)","value1, value2 = tspnet.read(connectionID, formatString)","value1, ..., valuen = tspnet.read(connectionID, formatString)","value1","The first value decoded from the response message","value2","The second value decoded from the response message","valuen","The nth value decoded from the response message; there is one return value per format specifier in the format string","...","One or more values separated with commas","connectionID","The connection ID returned from tspnet.connect()","formatString","Format string for the output, maximum of 10 specifiers","Details","This command reads available data from the remote instrument and returns responses for the specified number of arguments.","The format string can contain the following specifiers:","%[width]s","Read data until the specific length","%[max width]t","Read data until the specific length or delimited by punctuation","%[max width]n","Read data until a newline or carriage return","%d","Read a number (delimited by punctuation)","A maximum of 10 format specifiers can be used for a maximum of 10 return values.","If formatString is not provided, the command returns a string containing the data until a new line is reached. If no data is available, the Model 2651A pauses operation until the requested data is available or until a timeout error is generated. Use tspnet.timeout to specify the timeout period.","When reading from a TSP-enabled remote instrument, the Model 2651A removes Test Script Processor (TSP®) prompts and places any errors received from the remote instrument into its own error queue. The Model 2651A prefaces errors from the remote device with "Remote Error," and follows this with the error number and error description.","Example","tspnet.write(deviceID, "*idn?\\r\\n")","print("write/read returns:", tspnet.read(deviceID))","Send the "*idn?\\r\\n" message to the instrument connected as deviceID.","Display the response that is read from deviceID (based on the *idn? message).","Also see","tspnet.connect()","tspnet.readavailable()","tspnet.timeout","tspnet.write()","tspnet.read()","14079.html");
+Page[468]=new Array("This function checks to see if data is available from the remote device.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","bytesAvailable = tspnet.readavailable(connectionID)","bytesAvailable","The number of bytes available to be read from the connection","connectionID","The connection ID returned from tspnet.connect()","Details","This command checks to see if any output data is available from the device. No data is read from the instrument. This allows TSP scripts to continue to run without waiting on a remote command to finish.","Example","ID = tspnet.connect("192.0.2.1")","tspnet.write(ID, "*idn?\\r\\n")","repeat bytes = tspnet.readavailable(ID) until bytes > 0","print(tspnet.read(ID))","tspnet.disconnect(ID)","Send commands that will create data.","Wait for data to be available.","Also see","tspnet.connect()","tspnet.read()","tspnet.readavailable()","14080.html");
+Page[469]=new Array("This function disconnects all TSP-Net sessions.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","tspnet.reset()","Details","This command disconnects all remote instruments connected through TSP-Net. For TSP-enabled devices, this causes any commands or scripts running remotely to be terminated.","Also see","None","tspnet.reset()","14081.html");
+Page[470]=new Array("This function sets the device line termination sequence.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","type = tspnet.termination(connectionID)","type = tspnet.termination(connectionID, termSequence)","type","An enumerated value indicating the termination type:","1 or tspnet.TERM_LF","4 or tspnet.TERM_CR","2 or tspnet.TERM_CRLF","3 or tspnet.TERM_LFCR","connectionID","The connection ID returned from tspnet.connect()","termSequence","The termination sequence","Details","This function sets and gets the termination character sequence that is used to indicate the end of a line for a TSP-Net connection.","Using the termSequence parameter sets the termination sequence. The present termination sequence is always returned.","For the termSequence parameter, use the same values listed in the table above for type. There are four possible combinations, all of which are made up of line feeds (LF or 0x10) and carriage returns (CR or 0x13). For TSP-enabled devices, the default is tspnet.TERM_LF. For devices that are not TSP‑enabled, the default is tspnet.TERM_CRLF.","Example","deviceID = tspnet.connect("192.0.2.1")","if deviceID then"," tspnet.termination(deviceID, tspnet.TERM_LF)","end","Sets termination type for IP address 192.0.2.1 to TERM_LF.","Also see","tspnet.connect()","tspnet.disconnect()","tspnet.termination()","14082.html");
+Page[471]=new Array("This attribute sets the timeout value for the tspnet.connect(), tspnet.execute(), and tspnet.read() commands.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Recall setup","Not saved ","20.0 (20 s)","Usage","value = tspnet.timeout","tspnet.timeout = value","value","The timeout duration in seconds (0.001 s to 30.000 s)","Details","This attribute sets the amount of time the tspnet.connect(), tspnet.execute(), and tspnet.read() commands will wait for a response.","The time is specified in seconds. The timeout may be specified to millisecond resolution, but is only accurate to the nearest 10 ms.","Example","tspnet.timeout = 2.0","Sets the timeout duration to two seconds.","Also see","tspnet.connect()","tspnet.execute()","tspnet.read()","tspnet.timeout","14084.html");
+Page[472]=new Array("This function causes the TSP-enabled instrument to stop executing any of the commands that were previously sent ot it.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","tspnet.tsp.abort(connectionID)","connectionID","Integer value used as a handle for other tspnet commands","Details","This function is appropriate only for TSP-enabled instruments.","Sends an abort command to the remote instrument.","Example","tspnet.tsp.abort(testConnection)","Stops remote instrument execution on testConnection.","Also see","None","tspnet.tsp.abort()","14085.html");
+Page[473]=new Array("This attribute contains the setting for abort on connect to a TSP-enabled instrument.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Recall setup","Not saved ","1 (enable)","Usage","tspnet.tsp.abortonconnect = value","value = tspnet.tsp.abortonconnect","value","1 (enable) or 0 (disable)","Details","This setting determines if the instrument sends an abort message when it attempts to connect to a TSP‑enabled instrument using the tspnet.connect() function.","When you send the abort command on an interface, it causes any other active interface on that instrument to close. If you do not send an abort command (or if tspnet.tsp.abortonconnect is set to 0) and another interface is active, connecting to a TSP‑enabled remote instrument results in a connection. However, the instrument will not respond to subsequent reads or executes because control of the instrument is not obtained until an abort command has been sent. See Communications interfaces.","Example","tspnet.tsp.abortonconnect = 0","Configure the instrument so that it does not send an abort command when connecting to a TSP‑enabled instrument.","Also see","tspnet.connect()","tspnet.tsp.abortonconnect","14086.html");
+Page[474]=new Array("This function copies a reading buffer synchronous table from a remote instrument to a TSP-enabled instrument.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","table = tspnet.tsp.rbtablecopy(connectionID, name)","table = tspnet.tsp.rbtablecopy(connectionID, name, startIndex, endIndex)","table","A copy of the synchronous table or a string","connectionID","Integer value used as a handle for other tspnet commands","name","The full name of the reading buffer name and synchronous table to copy","startIndex","Integer start value","endIndex","Integer end value","Details","This function is only appropriate for TSP-enabled instruments.","This function reads the data from a reading buffer on a remote instrument and returns an array of numbers or a string representing the data. The startIndex and endIndex parameters specify the portion of the reading buffer to read. If no index is specified, the entire buffer is copied. ","The function will return a table if the table is an array of numbers; otherwise a comma‑delimited string is returned.","This command is limited to transferring 50,000 readings at a time.","Example","t = tspnet.tsp.rbtablecopy(testConnection,"," "testRemotebuffername.readings", 1, 3)","print(t[1], t[2], t[3])","Copy the specified readings table for buffer items 1 through 3, then display the first three readings. Sample output:","4.56534e-01","4.52675e-01","4.57535e-01","Also see","None","tspnet.tsp.rbtablecopy()","14090.html");
+Page[475]=new Array("This function loads and runs a script on a remote TSP-enabled instrument.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","tspnet.tsp.runscript(connectionID, script)","tspnet.tsp.runscript(connectionID, name, script)","connectionID","Integer value used as an identifier for other tspnet commands","name","The name that is assigned to the script","script","The body of the script as a string","Details","This function is appropriate only for TSP-enabled instruments.","This function downloads a script to a remote instrument and runs it. It automatically adds the appropriate loadscript and endscript commands around the script, captures any errors, and reads back any prompts. No additional substitutions are done on the text.","The script is automatically loaded, compiled, and run.","Any output from previous commands is discarded.","This command does not wait for the script to complete.","If you do not want the script to do anything immediately, make sure the script only defines functions for later use. Use the tspnet.execute() function to execute those functions at a later time.","If no name is specified, the script will be loaded as the anonymous script.","Example","tspnet.tsp.runscript(myconnection, "mytest",",""print([[start]]) for d = 1, 10 do print([[work]]) end print([[end]])")","Load and run a script entitled mytest on the TSP‑enabled instrument connected with myconnection.","Also see","tspnet.execute()","tspnet.tsp.runscript()","15280.html");
+Page[476]=new Array("This function writes a string to the remote instrument.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","tspnet.write(connectionID, inputString)","connectionID","The connection ID returned from tspnet.connect()","inputString","The string to be written","Details","The tspnet.write() function sends inputString to the remote instrument. It does not wait for command completion on the remote instrument.","The Model 2651A sends inputString to the remote instrument exactly as indicated. The inputString must contain any necessary new lines, termination, or other syntax elements needed to complete properly.","Because tspnet.write() does not process output from the remote instrument, do not send commands that generate too much output without processing the output. This command can stop executing if there is too much unprocessed output from previous commands.","Example","tspnet.write(myID, "runscript()\\r\\n")","Commands the remote instrument to execute a command or script named "runscript()" on a remote device identified in the system as myID.","Also see","tspnet.connect()","tspnet.read()","tspnet.write()","14089.html");
+Page[477]=new Array("This function adds a user-defined string to nonvolatile memory.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","userstring.add(name, value)","name","The name of the string; the key of the key-value pair","value","The string to associate with name; the value of the key-value pair","Details","This function associates the string value with the string name and stores this key-value pair in nonvolatile memory.","Use the userstring.get() function to retrieve the value associated with the specified name.","Example","userstring.add("assetnumber", "236")","userstring.add("product", "Widgets")","userstring.add("contact", "John Doe")","Stores user-defined strings in nonvolatile memory.","Also see","userstring.catalog()","userstring.delete()","userstring.get()","userstring.add()","13987.html");
+Page[478]=new Array("This function creates an iterator for the user string catalog.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","for name in userstring.catalog() do body end","name","The name of the string; the key of the key-value pair","body","Code to execute in the body of the for loop","Details","The catalog provides access for userstring pairs, allowing you to manipulate all the key-value pairs in nonvolatile memory. The entries are enumerated in no particular order.","Example 1","for name in userstring.catalog() do"," userstring.delete(name)","end","Deletes all user strings in nonvolatile memory.","Example 2","for name in userstring.catalog() do"," print(name .. " = " .."," userstring.get(name))","end","Prints all userstring key‑value pairs.","Output:","product = Widgets","assetnumber = 236","contact = John Doe","The above output lists the user strings added in the example for the userstring.add() function. Notice the key-value pairs are not listed in the order they were added.","Also see","userstring.add()","userstring.delete()","userstring.get()","userstring.catalog()","13988.html");
+Page[479]=new Array("This function deletes a user-defined string from nonvolatile memory.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","userstring.delete(name)","name","The name (key) of the key-value pair of the userstring to delete","Details","This function deletes the string that is associated with name from nonvolatile memory.","Example","userstring.delete("assetnumber")","userstring.delete("product")","userstring.delete("contact")","Deletes the user-defined strings associated with the "assetnumber", "product", and "contact" names.","Also see","userstring.add()","userstring.catalog()","userstring.get()","userstring.delete()","13989.html");
+Page[480]=new Array("This function retrieves a user-defined string from nonvolatile memory.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","value = userstring.get(name)","value","The value of the userstring key-value pair","name","The name (key) of the userstring","Details","This function retrieves the string that is associated with name from nonvolatile memory.","Example","value = userstring.get("assetnumber")","print(value)","Read the value associated with a user-string named "assetnumber".","Store it in a variable called value, then print the variable value.","Output:","236","Also see","userstring.add()","userstring.catalog()","userstring.delete()","userstring.get()","13990.html");
+Page[481]=new Array("This function waits for all overlapped commands in a specified group to complete.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","waitcomplete()","waitcomplete(group)","group","Specifies which TSP-Link group on which to wait","Details","This function will wait for all previously started overlapped commands to complete.","A group number may only be specified when this node is the master node.","If no group is specified, the local group is used.","If zero (0) is specified for the group, this function waits for all nodes in the system.","@ Any nodes that are not assigned to a group (group number is 0) are part of the master node's group.","Example 1","waitcomplete()","Waits for all nodes in the local group.","Example 2","waitcomplete(G)","Waits for all nodes in group G.","Example 3","waitcomplete(0)","Waits for all nodes on the TSP-Link network.","Also see","None","waitcomplete()","13986.html");
+Page[482]=new Array("See the "2-wire local sensing connections" topic in the Model 2651A reference manual.","2-wire local sensing connections","19568.html");
+Page[483]=new Array("See the "4-wire remote sensing connections" topic in the Model 2651A reference manual.","4-wire remote sensing connections","19569.html");
+Page[484]=new Array("See the "Adjustment" topic in the Model 2651A reference manual.","Adjustment","19563.html");
+Page[485]=new Array("The Model 2651A has two analog-to-digital converters (ADC): An integrating ADC and a fast ADC.","The integrating ADC uses a ratiometric analog-to-digital conversion technique. Depending on the configuration of the integrating ADC, periodic fresh reference measurements are required to minimize drift. The measurement aperture is used to determine the time interval between these measurement updates. For additional information, see Autozero. To help optimize operation of this ADC, the instrument caches the reference and zero values for up to ten of the most recent number of power line cycles. For additional information, see NPLC caching.","The fast ADC can acquire measurements at speeds up to 1 million samples per second. The fast ADC does not take reference measurements. A reading measurement acquisition buffer allows up to 5,000 readings to be made at the maximum acquisition rate of the fast ADCs. If this buffer is filled, the instrument slows its acquisition rate to the rate at which the instrument can process the data.","Data acquisition takes priority over both source operation and display operation. Sustained high data acquisition rates will cause the display to stop updating. A sustained high data acquisition rate during a sweep or pulse train may slow source operations. This can cause erratic sweep or pulse timing and may lead to triggers being missed (trigger overruns). Use the status model to monitor for trigger overruns. If a high sustained data acquisition rate causes undesirable sweep or pulse timing, reduce the data acquisition rate or reduce the total number of measurements until the desired sweep or pulse timing is achieved.","Analog-to-digital converter","18560.html");
+Page[486]=new Array("The integrating ADC of the Model 2651A uses a ratiometric A/D conversion technique. To ensure accuracy of readings, the instrument must periodically obtain fresh measurements of its internal ground and voltage reference. Separate reference and zero measurements are used for each aperture.","There are three different settings for autozero as summarized in the table below. By default, the instrument automatically checks these reference measurements whenever a signal measurement is made (AUTO). If the reference measurements are out of date when a signal measurement is made, the instrument will automatically take two more A/D conversions, one for the reference and one for the zero, before returning the result. Thus, occasionally, a measurement takes longer than normal.","This extra time can cause problems in sweeps and other test sequences in which measurement timing is critical. To avoid the extra time for the reference measurements in these situations, the OFF selection can be used to disable the automatic reference measurements. Note that with automatic reference measurements disabled, the instrument may gradually drift out of specification.","To minimize the drift, a reference and zero measurement should be made just prior to the critical test sequence. The ONCE setting can be used to force a refresh of the reference and zero measurements used for the current aperture setting.","Autozero settings","Autozero setting","Description","OFF","Turns automatic reference measurements off.","ONCE","Turns automatic reference measurements off, after immediately taking one reference and one zero measurement.","AUTO","Automatically takes new acquisitions when the Model 2651A determines reference and zero values are out-of-date.","Autozero","11440.html");
+Page[487]=new Array("This library provides generic functions for string manipulation.","Base library functions","Function","Description","collectgarbage()","collectgarbage(limit)","Sets the garbage-collection threshold to the given limit (in kilobytes) and checks it against the byte counter. If the new threshold is smaller than the byte counter, Lua immediately runs the garbage collector. If there is no limit parameter, it defaults to zero (0), which forces a garbage‑collection cycle. See Lua memory management for more information.","gcinfo()","Returns the number of kilobytes of dynamic memory that the Test Script Processor (TSP®) scripting engine is using, and returns the current garbage collector threshold (also in kilobytes). See Lua memory management for more information.","tonumber(x)","tonumber(x, base)","Returns x converted to a number. If x is already a number, or a convertible string, the number is returned; otherwise, it returns nil.","An optional argument specifies the base to interpret the numeral. The base may be any integer between 2 and 36, inclusive. In bases above 10, the letter A (in either upper or lower case) represents 10, B represents 11, and so forth, with Z representing 35. In base 10, the default, the number may have a decimal part, as well as an optional exponent. In other bases, only unsigned integers are accepted.","tostring(x)","Receives an argument of any type and converts it to a string in a reasonable format.","type(v)","Returns the type of its only argument, coded as a string. The possible results of this function are "nil" (a string, not the value nil), "number", "string", "boolean", "table", "function", "thread", and "userdata".","Base library functions","2430.html");
+Page[488]=new Array("See the "Calibration" topic in the Model 2651A reference manual.","Calibration","19570.html");
+Page[489]=new Array("A history of the key code for the last pressed front panel key is maintained by the Model 2651A. When the instrument is turned on (or when transitioning from local to remote operation), the key code is set to 0 (display.KEY_NONE).","When a front‑panel key is pressed, the key code value for that key can be captured and returned. There are two functions associated with the capture of key-press codes: display.getlastkey() and display.waitkey().","Capturing key-press codes","12125.html");
+Page[490]=new Array("See the "Configuring and running sweeps" topic in the Model 2651A reference manual.","Configuring and running sweeps","19567.html");
+Page[491]=new Array("See the "Contact check connections" topic in the Model 2651A reference manual.","Contact check connections","19564.html");
+Page[492]=new Array("See the "Contact check measurements" topic in the Model 2651A reference manual.","Contact check measurements","19565.html");
+Page[493]=new Array("Although the digital I/O lines are primarily intended for use with a device handler for limit testing, they can also be used for other purposes such as controlling external logic circuits. You can control lines either from the front panel or over a remote interface.","@ The trigger mode for the line must be set to digio.TRIG_BYPASS in order to use the line for digital I/O. See Triggering for more information.","To set digital I/O values from the front panel:","Press the MENU key, select DIGOUT, and then press the ENTER key or press the navigation wheel @.","Select DIG-IO-OUTPUT, and then press the ENTER key or the navigation wheel @.","Set the decimal value as required to set digital I/O lines within the range of 0 to 16,383 (see the table in Digital I/O bit weighting), and then press the ENTER key or the navigation wheel @.","Press the EXIT (LOCAL) key as needed to return to the main menu.","To write-protect specific digital I/O lines to prevent their values from being changed:","Press the MENU key, then select DIGOUT, and then press the ENTER key or the navigation wheel @.","Select WRITE-PROTECT, and then press the ENTER key or the navigation wheel @.","Set the decimal value as required to write‑protect digital I/O lines within the range of 0 to 16,383 (see Digital I/O bit weighting), and then press the ENTER key or the navigation wheel @.","Press the EXIT (LOCAL) key as needed to return to the main menu.","To remove write protection, repeat the above steps, but enter the original value in step 3.","Controlling digital I/O lines","11508.html");
+Page[494]=new Array("See the "Create a script using the script.new() command" topic in the Model 2651A reference manual.","Create a script using the script.new() command","19556.html");
+Page[495]=new Array("@ These steps remove a script from nonvolatile memory. To completely remove a script from the instrument, there are additional steps you must take. See Delete user scripts from the instrument.","You can delete the script from nonvolatile memory by sending either of the following commands:","script.delete("name")","script.user.delete("name")","Where: name is the user-defined name of the script.","To delete a script from nonvolatile memory using TSB Embedded:","In TSB Embedded, select the script from the User Scripts list.","Click Delete. There is no confirmation message.","Example: Delete a user script from nonvolatile memory","script.delete("test8")","Delete a user script named test8 from nonvolatile memory.","Delete user scripts","16805.html");
+Page[496]=new Array("In most circumstances, you can delete a script using script.delete() (as described in Delete user scripts), and then turn the instrument off and back on again. However, if you cannot turn the instrument off, you can use the following steps to completely remove a script from the instrument.","When you completely remove a script, you delete all references to the script from the run-time environment, the script.user.scripts table, and nonvolatile memory.","To completely remove a script:","Remove the script from the run-time environment. Set any variables that refer to the script to nil or assign the variables a different value. For example, to remove the script "beepTwoSec" from the run-time environment, send the following code: beepTwoSec = nil","Remove the script from the script.user.scripts table. Set the name attribute to an empty string (""). This makes the script nameless, but does not make the script become the anonymous script. For example, to remove the script named "beepTwoSec", send the following code: script.user.scripts.beepTwoSec.name = ""","Remove the script from nonvolatile memory. To delete the script from nonvolatile memory, send the command: script.delete("name")","Where name is the name that the script was saved as. For example, to delete beepTwoSec, you would send: script.delete("beepTwoSec")","Delete user scripts from the instrument","2408.html");
+Page[497]=new Array("See the "Digital I/O" topic in the Model 2651A reference manual.","Digital I/O","19553.html");
+Page[498]=new Array("Bit weighting for the digital I/O lines is shown in the following table.","Digital bit weight","Line #","Bit","Decimal weighting","Hexadecimal weighting","1","B1","1","0x0001","2","B2","2","0x0002","3","B3","4","0x0004","4","B4","8","0x0008","5","B5","16","0x0010","6","B6","32","0x0020","7","B7","64","0x0040","8","B8","128","0x0080","9","B9","256","0x0100","10","B10","512","0x0200","11","B11","1024","0x0400","12","B12","2048","0x0800","13","B13","4096","0x1000","14","B14","8192","0x2000","Digital I/O bit weighting","11500.html");
+Page[499]=new Array("The Model 2651A instruments have a digital input/output port that can be used to control external digital circuitry. For example, a handler that is used to perform binning operations can be used with a digital I/O port. The digital I/O port is a standard female DB-25 connector.","Digital I/O port","1401.html");
+Page[500]=new Array("See the "DUT test connections" topic in the Model 2651A reference manual.","DUT test connections","19573.html");
+Page[501]=new Array("The filter feature lets you set the filter response to stabilize noisy measurements. The Model 2651A uses a digital filter, which is based on reading conversions. The displayed, stored, or transmitted reading is calculated using one or more reading conversions (from 1 to 100).","Filters","11532.html");
+Page[502]=new Array("See the "Global variables and the script.user.scripts table" topic in the Model 2651A reference manual.","Global variables and the script.user.scripts table","19557.html");
+Page[503]=new Array("See the "GPIB operation" topic in the Model 2651A reference manual.","GPIB operation","24524.html");
+Page[504]=new Array("See the "High-capacitance mode" topic in the Model 2651A reference manual.","High-capacitance mode","19566.html");
+Page[505]=new Array("See the "Load a script by sending commands over the remote interface" topic in the Model 2651A reference manual.","Load a script by sending commands over the remote interface","19559.html");
+Page[506]=new Array("The logical operators in Lua are and, or, and not. All logical operators consider both false and nil as false and anything else as true.","The operator not always returns false or true.","The conjunction operator and returns its first argument if this value is false or nil; otherwise, and returns its second argument. The disjunction operator or returns its first argument if this value is different from nil and false; otherwise, or returns its second argument. Both and and or use shortcut evaluation, that is, the second operand is evaluated only if necessary.","Example","print(10 or errorqueue.next())","print(nil or "a")","print(nil and 10)","print(false and errorqueue.next())","print(false and nil)","print(false or nil)","print(10 and 20)","1.00000e+01","a","nil","false","false","nil","2.00000e+01","Logical operators","12893.html");
+Page[507]=new Array("The measure delay is a specific delay applied before each measurement is taken. This delay is disabled by default (measurements are taken immediately). You can change the default delay by setting the smuX.measure.delay attribute either to a specific value or to an auto delay setting (set smuX.measure.delay = smuX.DELAY_AUTO). If the measure delay is set to the auto delay setting, a range-dependent delay is applied each time the instrument performs a current measurement, or after changing current ranges during an autoranged measurement. The following table contains the measure auto delays associated with each current range.","Range","Measure auto delay","10 mA (and above)","0 ms (no delay)","1 mA","100 ms","100 mA","150 ms","10 mA","500 ms","1 mA","2.5 ms","100 nA","15 ms","You can increase or decrease the auto delay by changing the delay factor (for example, to reduce the delay across all ranges by half, set smuX.measure.delayfactor = 0.5). For additional information, refer to smuX.measure.delayfactor.","Measure auto delay","19632.html");
+Page[508]=new Array("See the "Measurement event registers" topic in the Model 2651A reference manual.","Measurement event registers","19571.html");
+Page[509]=new Array("See the "Named scripts" topic in the Model 2651A reference manual.","Named scripts","19558.html");
+Page[510]=new Array("See the "Operation Status Registers" topic in the Model 2651A reference manual.","Operation Status Registers","19578.html");
+Page[511]=new Array(" ","@ Carefully consider and configure the appropriate output-off state, source, and compliance levels before connecting the Model 2651A to a device that can deliver energy (for example, other voltage sources, batteries, capacitors, solar cells, or other Model 2651A instruments ). Program recommended instrument settings before making connections to the device. Failure to consider the output-off state, source, and compliance levels may result in damage to the instrument or to the device under test (DUT).","Output-off states","15424.html");
+Page[512]=new Array("See the "Questionable Status Registers" topic in the Model 2651A reference manual.","Questionable Status Registers","19579.html");
+Page[513]=new Array("See the "Queues" topic in the Model 2651A reference manual.","Queues","19552.html");
+Page[514]=new Array("The selected measurement range effects the accuracy of the measurements as well as the maximum signal that can be measured. Note that dashed lines are displayed (for example, --.---- µA) to indicate that the previous measurement is not recent. To update the displayed reading, trigger a measurement.","Range","11993.html");
+Page[515]=new Array("Reading buffers capture measurements, ranges, instrument status, and output state of the Keithley Instruments Model 2651A High Power System SourceMeter® Instrument. The Model 2651A has two dedicated reading buffers. You can use the dedicated reading buffers to acquire readings, or you can use the smuX.makebuffer() function to create dynamic reading buffers.","Each dedicated reading buffer in the Model 2651A can store over 60,000 readings with the timestamps and source values options enabled. Disable the timestamps and source values options to store over 140,000 readings internally.","You can save the dedicated reading buffers to internal nonvolatile memory in the instrument or to the USB flash drive.","Once you save the reading buffers to the USB flash drive, insert the USB flash drive into the USB port on your computer to view the data in any compatible data analysis application, or to transfer the data from the USB flash drive to your computer.","@ Reading buffers (other than the dedicated reading buffers) have fixed capacity and are not specifically limited to 60,000 or 140,000 readings.","Reading buffers","13629.html");
+Page[516]=new Array("The relative offset (REL) feature can be used to set offsets to zero (0) or subtract a baseline reading from present and future readings. With relative offset enabled, subsequent readings are the difference between the actual input value and the relative offset value, as follows:","Displayed reading = Actual input - Relative offset value","Once a relative offset value is established for a measurement function, the value is the same for all ranges. For example, if 0.5 A is set as a relative offset value on the 1 A range, the relative offset value is also 0.5 A on the lower current ranges.For example, on the 1 A range, the Model 2651A still overflows for a more than 1.02 A input.","When relative offset is enabled, the REL indicator turns on. Changing measurement functions changes the relative offset value to the established relative offset value and state for that measurement function.","Relative offset","12001.html");
+Page[517]=new Array("Readings can be obtained by taking overlapped or non-overlapped measurements. Routines that make single‑point measurements can be configured to make multiple measurements where one would ordinarily be made. The measured value is not the only component of a reading. The measurement status (for example, “In Compliance” or “Overranged”) is also an element of data associated with a particular reading.","All routines that return measurements can also store the measurements in the reading buffers. Overlapped measurements always return readings in a reading buffer. Non-overlapped measurement functions can return single-point measurement values or store multiple values in a reading buffer.","A reading buffer is based on a Lua table. The measurements are accessed by ordinary array accesses. If rb is a reading buffer, the first measurement is accessed as rb[1] and the 9th measurement as rb[9], and so on. The additional information in the table is accessed as additional members of the table.","The load, save, and write operations for reading buffers function differently in the remote state. From a remote command interface, you can extract data from reading buffers as the instrument acquires the data.","Remote reading buffer programming","11655.html");
+Page[518]=new Array("The node that acquires the data stores the data for the reading buffer. To optimize data access, all nodes can cache data from the node that stores the reading buffer data.","Running Lua code remotely can cause reading buffer data that is held in the cache to become stale. If the values in the reading buffer change while the Lua code runs remotely, another node can hold stale values. Use the clearcache() command to clear the cache. In addition, if the cachemode of a reading buffer is enabled, you might need to use the clearcache() command to avoid getting stale data. For additional detail on the reading buffer cache commands, see bufferVar.cachemode and bufferVar.clearcache().","The following example code demonstrates how stale values occur and how to use the clearcache() command to clear the cache on node 2, which is part of group 7.","-- Create a reading buffer on a node in a remote group.","node[2].tsplink.group = 7","node[2].execute("rbremote = smua.makebuffer(20)" .."," "smua.measure.count = 20 " .."," "smua.measure.v(rbremote)")","-- Create a variable on the local node to","-- access the reading buffer.","rblocal = node[2].getglobal("rbremote")","-- Access data from the reading buffer.","print(rblocal[1])","-- Run code on the remote node that updates the reading buffer.","node[2].execute("smua.measure.v(rbremote)")","-- Use the clearcache command if the reading buffer contains cached data.","rblocal.clearcache()","-- If you do not use the clearcache command, the data buffer","-- values will never update. Every time the print command is","-- issued after the first print command, the same data buffer","-- values will print.","print(rblocal[1])","Removing stale values from the reading buffer cache","3249.html");
+Page[519]=new Array("See the "Rename a script" topic in the Model 2651A reference manual.","Rename a script","19560.html");
+Page[520]=new Array("To retrieve the source code one line at a time, send the scriptVar.list() command. When this command is received, the instrument sends the entire script. Each line of the script is sent as a separate response message. The output includes the loadscript or loadandrunscript and endscript keywords.","After retrieving the source code, you can modify and save the command lines as a user script under the same name or a new name.","To retrieve the source code of a script one line at a time, send the command:","scriptVar.list()","Where scriptVar is the name of the script.","@ To retrieve the commands in the anonymous script, use script.anonymous.list().","Example: Retrieve source code one line at a time","test.list()","Retrieve the source of a script named "test".","The output will look similar to:","loadscript","display.clear()","display.settext(”This is a test”)","print(”This is a test”)","endscript ","Retrieve source code one line at a time","17030.html");
+Page[521]=new Array("See the "RS-232 interface operation" topic in the Model 2651A reference manual.","RS-232 interface operation","19561.html");
+Page[522]=new Array("You can save scripts to nonvolatile memory using commands or TSB Embedded.","Only named scripts can be saved to nonvolatile memory. The anonymous script must be named before it can be saved to nonvolatile memory.","@ If a script is not saved to nonvolatile memory, the script is lost when the instrument is turned off.","Save a user script","16803.html");
+Page[523]=new Array("The sense mode can be set to use 2-wire local sensing connections or 4-wire remote sensing connections.","@ The default sense setting is 2-wire local.","Sense mode selection","11848.html");
+Page[524]=new Array("There are two ways to adjust a value: the Navigation wheel method or Numeric entry method (using the keypad).","Navigation wheel method:","Use the CURSOR arrow keys (or turn the navigation wheel @) to move the cursor to the value that you want to edit.","Press the navigation wheel @ or the ENTER key to enter edit mode. The EDIT indicator is illuminated.","Rotate the navigation wheel @ to set the appropriate value.","Press the ENTER key to select the value or press the EXIT (LOCAL) key to cancel the change.","(Optional) Press the EXIT (LOCAL) key to return to the main menu.","Numeric entry method:","@ The numeric entry method may only be used if the numeric keypad is enabled and while the instrument is in edit mode.","@ To set a value to zero, press the 0000 numeric entry key. To toggle the polarity of a value, press the +/– numeric entry key.","If the keypad is disabled, press the MENU key, then select DISPLAY > NUMPAD > ENABLE.","Use the CURSOR arrow keys (or turn the navigation wheel @) to move the cursor to the value that you want to edit.","Press the navigation wheel @ or the ENTER key to enter edit mode. The EDIT indicator is illuminated.","Press any of the desired number keys (0-9, +/-, 0000) (see 2. Setup, performance control, special operation, and numbers ). The cursor moves to the next value on the right.","Repeat the above steps as required to set the desired values.","Press the ENTER key to select the value or press the EXIT (LOCAL) key to cancel change.","(Optional) Press the EXIT (LOCAL) key to return to the main menu.","Setting a value","11815.html");
+Page[525]=new Array("Depending on how it is programmed and what is connected to the output (load or source), the instrument can operate in any of the four quadrants. The four quadrants of operation are shown in the continuous operating boundaries figures. When operating in the first (I) or third (III) quadrant, the instrument is operating as a source (V and I have the same polarity). As a source, the instrument is delivering power to a load.","When operating in the second (II) or fourth (IV) quadrant, the instrument is operating as a sink (V and I have opposite polarity). As a sink, it is dissipating power rather than sourcing it. An external source or an energy storage device, such as a capacitor or battery, can force operation in the sink region.","Source or sink","11584.html");
+Page[526]=new Array("See the "Source-measure concepts" topic in the Model 2651A reference manual.","Source-measure concepts","19572.html");
+Page[527]=new Array("The Model 2651A has two analog-to-digital converters (ADC): one integrating, one high speed. Fastest reading rates are achieved using the fast ADC. With the exception of one setting, the SPEED key largely controls the integrating ADC (see Analog-to-digital converter). The SPEED key is used to set the integration time, or measurement aperture, of the analog-to-digital converter (the period of time the input signal is measured). The integration time affects the usable digits, the amount of reading noise, and the reading rate of the instrument. The integration time is specified in parameters based on the number of power line cycles (NPLC), where 1 PLC for 60 Hz is 16.67 ms (1/60) and 1 PLC for 50 Hz is 20 ms (1/50).","In general, the fastest integration time (0.001 PLC) results in the fastest reading rate for the integrating ADC, but also causes increased reading noise and fewer usable digits. The slowest integration time (25 PLC) provides the best common-mode and normal-mode noise rejection, but has the slowest reading rate. Settings between the fastest and slowest integration times are a compromise between speed and noise. The default power‑on speed setting is NORMAL (1 PLC).","Speed","11998.html");
+Page[528]=new Array("See the "Standard Event Register" topic in the Model 2651A reference manual.","Standard Event Register","19580.html");
+Page[529]=new Array("You can specify the Model 2651A start-up (power-on) configuration. Use the setup.poweron attribute to select which setup to return to upon power-up. To set the setup.poweron configuration attribute:","setup.poweron = n -- Select power-on setup.","Where:","n","=","0 (*RST/reset() factory defaults)","n","=","1 to 5 (user setups 1-5)","Start-up (power-on) configuration","11613.html");
+Page[530]=new Array("See the "Status byte and service request (SRQ)" topic in the Model 2651A reference manual.","Status byte and service request (SRQ)","19576.html");
+Page[531]=new Array("See the "Status model" topic in the Model 2651A reference manual.","","19551.html");
+Page[532]=new Array("See the "Status model overview" topic in the Model 2651A reference manual.","Status model overview","19575.html");
+Page[533]=new Array("See the "Sweep operation" topic in the Model 2651A reference manual.","Sweep operation","19550.html");
+Page[534]=new Array("See the "System summary and standard event registers" topic in the Model 2651A reference manual.","System summary and standard event registers","19581.html");
+Page[535]=new Array("See the "Triggering" topic in the Model 2651A reference manual.","Triggering","19574.html");
+Page[536]=new Array("See the "TSP advanced features" topic in the Model 2651A reference manual.","TSP advanced features","19555.html");
+Page[537]=new Array("See the "TSP-Link" topic in the Model 2651A reference manual.","TSP-Link","19554.html");
+Page[538]=new Array("The Model 2651A has three synchronization lines that you can use for triggering, digital I/O, and to synchronize multiple instruments on a TSP-Link® network.","TSP-Link synchronization lines","12458.html");
+Page[539]=new Array("See the "User setup" topic in the Model 2651A reference manual.","User setup","19562.html");
+var PageCount=540;
+
+function search(SearchWord){
+var Result="";
+var NrRes=0;
+Result='\n';
+Result+="\n";
+Result+="\n";
+Result+="\n";
+Result+="Search Results\n";
+Result+='\n';
+Result+='\n';
+Result+="\n";
+Result+="\n";
+Result+="\n";
+Result+='
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2657A/11382.html b/WebHelpDocs/Commands_2657A/11382.html
new file mode 100644
index 0000000..aa7962f
--- /dev/null
+++ b/WebHelpDocs/Commands_2657A/11382.html
@@ -0,0 +1,58 @@
+
+
+ Bit manipulation and logic operations
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Bit manipulation and logic operations
+
The bit functions perform bitwise logic operations on two given numbers, and bit operations on one given number. Logic and bit operations truncate the fractional part of given numbers to make them integers.
+
Logic operations
+
The bit.bitand(), bit.bitor(), and bit.bitxor() functions in this group perform bitwise logic operations on two numbers. The Test Script Processor (TSP®) scripting engine performs the indicated logic operation on the binary equivalents of the two integers. This bitwise logic operation is performed on all corresponding bits of the two numbers. The result of a logic operation is returned as an integer.
+
Bit operations
+
The rest of the functions in this group are used for operations on the bits of a given number. These functions can be used to:
+
Clear a bit
Toggle a bit
Test a bit
Set a bit or bit field
Retrieve the weighted value of a bit or field value
All these functions use an index parameter to specify the bit position of the given number. The least significant bit of a given number has an index of 1, and the most significant bit has an index of 32.
+
The Test Script Processor (TSP) scripting engine stores all numbers internally as IEEE Std 754 double-precision floating point values. The logical operations work on 32‑bit integers. Any fractional bits are truncated. For numbers larger than 4294967295, only the lower 32 bits are used.
The integrating ADC of the Model 2657A uses a ratiometric A/D conversion technique. To ensure accuracy of readings, the instrument must periodically obtain fresh measurements of its internal ground and voltage reference. Separate reference and zero measurements are used for each aperture.
+
As summarized in the "Autozero settings" table, there are three different settings for autozero. By default, the instrument automatically checks these reference measurements whenever a signal measurement is made (AUTO). If the reference measurements are out of date when a signal measurement is made, the instrument will automatically take two more A/D conversions, one for the reference and one for the zero, before returning the result. Thus, occasionally, a measurement takes longer than normal.
+
This extra time can cause problems in sweeps and other test sequences in which measurement timing is critical. To avoid the extra time for the reference measurements in these situations, the OFF selection can be used to disable the automatic reference measurements. Note that with automatic reference measurements disabled, the instrument may gradually drift out of specification.
+
To minimize the drift, a reference and zero measurement should be made just prior to the critical test sequence. The ONCE setting can be used to force a refresh of the reference and zero measurements used for the current aperture setting.
+
+
+
+
+
+
+
Autozero settings
+
+
+
+
Autozero setting
+
+
Description
+
+
+
+
OFF
+
+
Turns automatic reference measurements off.
+
+
+
+
ONCE
+
+
After immediately taking one reference and one zero measurement, turns automatic reference measurements off.
+
+
+
+
AUTO
+
+
Automatically takes new acquisitions when the Model 2657A determines reference and zero values are out-of-date.
+
+
+
+
+
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2657A/11500.html b/WebHelpDocs/Commands_2657A/11500.html
new file mode 100644
index 0000000..c74801c
--- /dev/null
+++ b/WebHelpDocs/Commands_2657A/11500.html
@@ -0,0 +1,205 @@
+
+
+ Digital I/O bit weighting
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Digital I/O bit weighting
+
Bit weighting for the digital I/O lines is shown in the following table.
+
+
+
+
+
+
+
+
+
Digital bit weight
+
+
+
+
Line #
+
+
Bit
+
+
Decimal weighting
+
+
Hexadecimal weighting
+
+
+
+
1
+
+
B1
+
+
1
+
+
0x0001
+
+
+
+
2
+
+
B2
+
+
2
+
+
0x0002
+
+
+
+
3
+
+
B3
+
+
4
+
+
0x0004
+
+
+
+
4
+
+
B4
+
+
8
+
+
0x0008
+
+
+
+
5
+
+
B5
+
+
16
+
+
0x0010
+
+
+
+
6
+
+
B6
+
+
32
+
+
0x0020
+
+
+
+
7
+
+
B7
+
+
64
+
+
0x0040
+
+
+
+
8
+
+
B8
+
+
128
+
+
0x0080
+
+
+
+
9
+
+
B9
+
+
256
+
+
0x0100
+
+
+
+
10
+
+
B10
+
+
512
+
+
0x0200
+
+
+
+
11
+
+
B11
+
+
1024
+
+
0x0400
+
+
+
+
12
+
+
B12
+
+
2048
+
+
0x0800
+
+
+
+
13
+
+
B13
+
+
4096
+
+
0x1000
+
+
+
+
14
+
+
B14
+
+
8192
+
+
0x2000
+
+
+
+
+
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
Although the digital I/O lines are primarily intended for use with a device handler for limit testing, they can also be used for other purposes such as controlling external logic circuits. You can control lines either from the front panel or over a remote interface.
+
The trigger mode for the line must be set to digio.TRIG_BYPASS in order to use the line for digital I/O. See Triggering for more information.
+
To set digital I/O values from the front panel:
+
Press the MENU key, select DIGOUT, and then press the ENTER key or press the navigation wheel .
Select DIG-IO-OUTPUT, and then press the ENTER key or the navigation wheel .
Set the decimal value as required to set digital I/O lines within the range of 0 to 16,383 (see the table in Digital I/O bit weighting), and then press the ENTER key or the navigation wheel .
Press the EXIT (LOCAL) key as needed to return to the main menu.
To write-protect specific digital I/O lines to prevent their values from being changed:
+
Press the MENU key, then select DIGOUT, and then press the ENTER key or the navigation wheel .
Select WRITE-PROTECT, and then press the ENTER key or the navigation wheel .
Set the decimal value as required to write‑protect digital I/O lines within the range of 0 to 16,383 (see Digital I/O bit weighting), and then press the ENTER key or the navigation wheel .
Press the EXIT (LOCAL) key as needed to return to the main menu.
To remove write protection, repeat the above steps, but enter the original value in step 3.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
The filter feature lets you set the filter response to stabilize noisy measurements. The Model 2657A uses a digital filter, which is based on reading conversions. The displayed, stored, or transmitted reading is calculated using one or more reading conversions (from 1 to 100).
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
Depending on how it is programmed and what is connected to the output (load or source), the instrument can operate in any of the four quadrants. The four quadrants of operation are shown in the continuous operating boundaries figures. When operating in the first (I) or third (III) quadrant, the instrument is operating as a source (V and I have the same polarity). As a source, the instrument is delivering power to a load.
+
+
When operating in the second (II) or fourth (IV) quadrant, the instrument is operating as a sink (V and I have opposite polarity). As a sink, it is dissipating power rather than sourcing it. An external source or an energy storage device, such as a capacitor or battery, can force operation in the sink region.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
You can specify the Model 2657A start-up (power-on) configuration. Use the setup.poweron attribute to select which setup to return to upon power-up. To set the setup.poweron configuration attribute:
+
setup.poweron = n -- Select power-on setup.
+
Where:
+
+
+
+
+
n
+
+
=
+
+
0 (*RST/reset() factory defaults)
+
+
+
+
+
+
n
+
+
=
+
+
1 to 5 (user setups 1-5)
+
+
+
+
+
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
Readings can be obtained by taking overlapped or non-overlapped measurements. Routines that make single‑point measurements can be configured to make multiple measurements where one would ordinarily be made. The measured value is not the only component of a reading. The measurement status (for example, “In Compliance” or “Overranged”) is also an element of data associated with a particular reading.
+
All routines that return measurements can also store the measurements in the reading buffers. Overlapped measurements always return readings in a reading buffer. Non-overlapped measurement functions can return single-point measurement values or store multiple values in a reading buffer.
+
A reading buffer is based on a Lua table. The measurements are accessed by ordinary array accesses. If rb is a reading buffer, the first measurement is accessed as rb[1] and the 9th measurement as rb[9], and so on. The additional information in the table is accessed as additional members of the table.
+
The load, save, and write operations for reading buffers function differently in the remote state. From a remote command interface, you can extract data from reading buffers as the instrument acquires the data.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2657A/11815.html b/WebHelpDocs/Commands_2657A/11815.html
new file mode 100644
index 0000000..5ef1918
--- /dev/null
+++ b/WebHelpDocs/Commands_2657A/11815.html
@@ -0,0 +1,47 @@
+
+
+ Setting a value
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Setting a value
+
There are two ways to adjust a value: the Navigation wheel method or Numeric entry method (using the keypad).
+
Navigation wheel method:
+
Use the CURSOR arrow keys (or turn the navigation wheel ) to move the cursor to the desired digit.
Press the navigation wheel or the ENTER key to enter edit mode. The EDIT indicator is illuminated.
Rotate the navigation wheel to set the appropriate value.
Press the ENTER key to select the value or press the EXIT (LOCAL) key to cancel the change.
(Optional) Press the EXIT (LOCAL) key to return to the main menu.
+
Numeric entry method:
+
The numeric entry method may only be used if the numeric keypad is enabled.
+
To set a value to zero, press the 0000 numeric entry key. To toggle the polarity of a value, press the +/– numeric entry key.
+
If the keypad is disabled, press the MENU key, then select DISPLAY > NUMPAD > ENABLE.
Use the CURSOR arrow keys (or turn the navigation wheel ) to move the cursor to the value that you want to edit.
Press the navigation wheel or the ENTER key to enter edit mode. The EDIT indicator is illuminated.
Press any of the desired number keys (0-9, +/-, 0000) (see 2. SMU setup, performance control, special operation, and numbers). The cursor moves to the next value on the right.
Repeat the above steps as required to set the desired values.
Press the ENTER key to select the value or press the EXIT (LOCAL) key to cancel change.
(Optional) Press the EXIT (LOCAL) key to return to the main menu.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2657A/11993.html b/WebHelpDocs/Commands_2657A/11993.html
new file mode 100644
index 0000000..eb1a4dd
--- /dev/null
+++ b/WebHelpDocs/Commands_2657A/11993.html
@@ -0,0 +1,41 @@
+
+
+ Range
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Range
+
The selected measurement range effects the accuracy of the measurements as well as the maximum signal that can be measured. If the range is changed, the display may contain dashes instead of a reading (for example, --.---- µA). This indicates that no measurement was taken using the current range. To update the displayed reading, trigger a measurement (if in local control, press the TRIG key).
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
The Model 2657A has two analog-to-digital converters (ADC): one integrating, one high speed. Fastest reading rates are achieved by selecting the fast ADC. You can select the fast ADC by pressing the SPEED key and choosing the FAST option.
+
You can also use the SPEED key to select the integrating ADC and set the period of time the input signal is measured (this is called the integration time or measurement aperture). The integration time affects the usable digits, the amount of reading noise, and the reading rate of the instrument. The integration time is specified in parameters based on the number of power line cycles (NPLC), where 1 PLC for 60 Hz is 16.67 ms (1/60) and 1 PLC for 50 Hz is 20 ms (1/50).
+
In general, the fastest integration time (0.001 PLC) results in the fastest reading rate for the integrating ADC, but also causes increased reading noise and fewer usable digits. The slowest integration time (25 PLC) provides the best common-mode and normal-mode noise rejection, but has the slowest reading rate. Settings between the fastest and slowest integration times are a compromise between speed and noise. The default power‑on speed setting is NORMAL (1 PLC).
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
The relative offset (REL) feature can be used to set offsets to zero (0) or subtract a baseline reading from present and future readings. With relative offset enabled, subsequent readings are the difference between the actual input value and the relative offset value, as follows:
+
Displayed reading = Actual input - Relative offset value
+
Once a relative offset value is established for a measurement function, the value is the same for all ranges. For example, if 50 mA is set as a relative offset value on the 120 mA range, the relative offset value is also 50 mA on the lower current ranges. This can cause an overflow condition if the selected range cannot accommodate the relative offset value.
+
When relative offset is enabled, the REL indicator turns on. Changing measurement functions changes the relative offset value to the established relative offset value and state for that measurement function.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2657A/12034.html b/WebHelpDocs/Commands_2657A/12034.html
new file mode 100644
index 0000000..f4fd5f1
--- /dev/null
+++ b/WebHelpDocs/Commands_2657A/12034.html
@@ -0,0 +1,42 @@
+
+
+ Local state
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Local state
+
The following actions will cancel the remote state and return the instrument to the local state:
+
Cycling power for the instrument.
Pressing the OUTPUT ON/OFF control.
Pressing front panel LOCAL key (if it is not locked out).
Sending the abort command from the PC.
Clicking the Abort Execution icon on the toolbar of the Instrument Console for Test Script Builder.
After a front panel script (FACTORY or USER test) is completed, the instrument will return to the local state.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
The following actions will place the instrument in the remote state:
+
Sending a command from the PC to the instrument.
Running a script (FACTORY or USER test) from the front panel. After the test is completed, the instrument will return to the local mode.
Opening communications between the instrument and Test Script Builder.
While in the remote state, front panel controls are disabled. However, the LOCAL key will be active if it has not been locked out. When an interactive script is running, the front panel controls will be active to allow the operator to input parameter values.
+
The OUTPUT ON/OFF control is always active. If it is pressed when the instrument is in the remote state, the instrument will turn the output off (if it is on) and return to the local state.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2657A/12044.html b/WebHelpDocs/Commands_2657A/12044.html
new file mode 100644
index 0000000..ca46e97
--- /dev/null
+++ b/WebHelpDocs/Commands_2657A/12044.html
@@ -0,0 +1,42 @@
+
+
+ Time and date values
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Time and date values
+
Time and date values are represented as the number of seconds since some base. Representing time as a number of seconds is referred to as “standard time format.” There are three time bases:
+
UTC 12:00 am Jan 1, 1970. Some examples of UTC time are reading buffer base timestamps, adjustment dates, and the value returned by os.time().
Instrument on. References time to when the instrument was turned on. The value returned by os.clock() is referenced to the turn-on time.
Event. Time referenced to an event, such as the first reading stored in a reading buffer.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
A history of the key code for the last pressed front panel key is maintained by the Model 2657A. When the instrument is turned on (or when transitioning from local to remote operation), the key code is set to 0 (display.KEY_NONE).
+
When a front‑panel key is pressed, the key code value for that key can be captured and returned. There are two functions associated with the capture of key-press codes: display.getlastkey() and display.waitkey().
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
The KISweep factory script provides simple sweep test programming and shows how to use the sweeping function.
+
This script is made up of the following functions. Access these functions from the front panel or the remote interfaces. The following functions make up the KISweep factory script:
System SourceMeter® instrument channel (set to smua)
+
+
+
+
starti
+
+
Sweep start current in amperes
+
+
+
+
stopi
+
+
Sweep stop current in amperes
+
+
+
+
stime
+
+
Settling time in seconds; occurs after stepping the source and before performing a measurement
+
+
+
+
points
+
+
Number of sweep points (must be ³2)
+
+
+
+
+
Details
+
Data for voltage measurements, current source values, and timestamps are stored in smuX.nvbuffer1.
+
If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.
+
Performs a linear current sweep with voltage measured at every step (point):
+
1. Sets the smu to output starti amperes, allows the source to settle for stime seconds, and then performs a voltage measurement.
+
2. Sets the smu to output the next amperes step, allows the source to settle for stime seconds, and then performs a voltage measurement.
+
3. Repeats the above sequence until the voltage is measured on the stopi amperes step.
+
The linear step size is automatically calculated as follows:
+
step = (stopi – starti) / (points – 1)
+
+
Example
+
+
+
+
SweepILinMeasureV(smua, -1E-3, 1E-3, 0, 100)
+
+
This function performs a 100-point linear current sweep starting at -1 mA and stopping at +1 mA. Voltage is measured at every step (point) in the sweep. Because stime is set for 0 s, voltage will be measured as fast as possible after each current step.
+
+
+
+
+
Also see
+
None
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
System SourceMeter® instrument channel (set to smua)
+
+
+
+
startv
+
+
Sweep start voltage in volts
+
+
+
+
stopv
+
+
Sweep stop voltage in volts
+
+
+
+
stime
+
+
Settling time in seconds; occurs after stepping the source and before performing a measurement
+
+
+
+
points
+
+
Number of sweep points (must be ³2)
+
+
+
+
+
Details
+
Data for current measurements, voltage source values, and timestamps are stored in smuX.nvbuffer1.
+
If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.
+
Performs a linear voltage sweep with current measured at every step (point):
+
1. Sets the smu to output startv amperes, allows the source to settle for stime seconds, and then performs a current measurement.
+
2. Sets the smu to output the next amperes step, allows the source to settle for stime seconds, and then performs a voltage measurement.
+
3. Repeats the above sequence until the voltage is measured on the stopv amperes step.
+
The linear step size is automatically calculated as follows:
+
step = (stopv – startv) / (points – 1)
+
+
Example
+
+
+
+
SweepVLinMeasureI(smua, 500, 3000, 15e-3, 26)
+
+
This function performs a 26-point linear voltage sweep starting at 500 V and stopping at 3000 V. Current is measured at every step (point) in the sweep after a 15 ms source settling period.
+
+
+
+
+
Also see
+
None
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This function performs a five‑point linear current sweep starting at 10 mA and stopping at 100 mA. Voltage is measured at every step (point) in the sweep. The source will be allowed to settle on each step for 1 ms before a measurement is performed.
+
+
The following table contains log values and corresponding source levels for the five‑point logarithmic sweep:
+
+
+
MeasurePoint
+
+
LogStepSize
+
+
LogStep
+
+
SourceStepLevel
+
+
+
+
1
+
+
0.25
+
+
0.0
+
+
0.01 A
+
+
+
+
2
+
+
0.25
+
+
0.25
+
+
0.017783 A
+
+
+
+
3
+
+
0.25
+
+
0.5
+
+
0.031623 A
+
+
+
+
4
+
+
0.25
+
+
0.75
+
+
0.056234 A
+
+
+
+
5
+
+
0.25
+
+
1.0
+
+
0.1 A
+
+
+
+
+
+
+
+
+
+
Also see
+
None
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This KISweep factory script function performs a current list sweep with voltage measured at every step (point).
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
SweepIListMeasureV(smu, ilist, stime, points)
+
+
+
+
smu
+
+
System SourceMeter® instrument channel (set to smua)
+
+
+
+
ilist
+
+
Arbitrary list of current source values; ilist = {value1, value2, ...valueN}
+
+
+
+
stime
+
+
Settling time in seconds; occurs after stepping the source and before performing a measurement
+
+
+
+
points
+
+
Number of sweep points (must be ³2)
+
+
+
+
+
Details
+
Data for voltage measurements, current source values, and timestamps are stored in smuX.nvbuffer1.
+
If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.
+
Performs a current list sweep with voltage measured at every step (point):
+
1. Sets the smu to output ilist amperes value, allows the source to settle for stime seconds, and then performs a voltage measurement.
+
2. Sets the smu to output the next ilist step, allows the source to settle for stime seconds, and then performs a voltage measurement.
+
3. Repeats the above sequence until the voltage is measured for the last amperes value. The last point in the list to be measured is points.
+
Example
+
+
+
+
testilist = {-100E-9, 100E-9, -1E-6, 1E-6,
+
-1E-3, 1E-3}
+
+
SweepIListMeasureV(smua, testilist,
+
500E-3, 6)
+
+
This function performs a six‑point current list sweep starting at the first point in testilist. Voltage is measured at every step (point) in the sweep. The source will be allowed to settle on each step for 500 ms before a measurement is performed.
+
+
+
+
+
Also see
+
None
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This function performs a five‑point logarithmic voltage sweep starting at 100 V and stopping at 1000 V. Current is measured at every step (point) in the sweep after a 20 ms source settling period.
+
+
The following table contains log values and corresponding source levels for the five‑point logarithmic sweep:
+
+
+
+
MeasurePoint
+
+
LogStepSize
+
+
LogStep
+
+
SourceStepLevel
+
+
+
+
1
+
+
0.25
+
+
0.0
+
+
100.00 V
+
+
+
+
2
+
+
0.25
+
+
0.25
+
+
177.83 V
+
+
+
+
3
+
+
0.25
+
+
0.5
+
+
316.23 V
+
+
+
+
4
+
+
0.25
+
+
0.75
+
+
562.34 V
+
+
+
+
5
+
+
0.25
+
+
1.0
+
+
1000.0 V
+
+
+
+
+
+
+
+
+
+
Also see
+
None
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2657A/12194.html b/WebHelpDocs/Commands_2657A/12194.html
new file mode 100644
index 0000000..a256000
--- /dev/null
+++ b/WebHelpDocs/Commands_2657A/12194.html
@@ -0,0 +1,48 @@
+
+
+ Retrieving and modifying a factory script listing
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Retrieving and modifying a factory script listing
+
The script listing for a factory script can be retrieved and modified. However, it cannot be saved as a factory script. The modified script can be saved as a user script using the same name or a new name.
+
An imported factory script can only be loaded back into the Model 2657A as a user script.
+
The following function retrieves a script listing. The script code is output with the shell keywords (loadscript or loadandrunscript, and endscript):
+
script.factory.scripts.name.list()
+
Where: name is the name of the factory script.
+
Example:
+
Retrieve the script listing for a factory script named “KIPulse”:
+
script.factory.scripts.KIPulse.list()
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2657A/124.gif b/WebHelpDocs/Commands_2657A/124.gif
new file mode 100644
index 0000000..65878ab
Binary files /dev/null and b/WebHelpDocs/Commands_2657A/124.gif differ
diff --git a/WebHelpDocs/Commands_2657A/12458.html b/WebHelpDocs/Commands_2657A/12458.html
new file mode 100644
index 0000000..8c3171c
--- /dev/null
+++ b/WebHelpDocs/Commands_2657A/12458.html
@@ -0,0 +1,41 @@
+
+
+ TSP-Link synchronization lines
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
TSP-Link synchronization lines
+
The Model 2657A has three synchronization lines that you can use for triggering, digital I/O, and to synchronize multiple instruments on a TSP-Link® network.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2657A/125.gif b/WebHelpDocs/Commands_2657A/125.gif
new file mode 100644
index 0000000..2478cb4
Binary files /dev/null and b/WebHelpDocs/Commands_2657A/125.gif differ
diff --git a/WebHelpDocs/Commands_2657A/12893.html b/WebHelpDocs/Commands_2657A/12893.html
new file mode 100644
index 0000000..131633e
--- /dev/null
+++ b/WebHelpDocs/Commands_2657A/12893.html
@@ -0,0 +1,67 @@
+
+
+ Logical operators
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Logical operators
+
The logical operators in Lua are and, or, and not. All logical operators consider both false and nil as false and anything else as true.
+
The operator not always returns false or true.
+
The conjunction operator and returns its first argument if this value is false or nil; otherwise, and returns its second argument. The disjunction operator or returns its first argument if this value is different from nil and false; otherwise, or returns its second argument. Both and and or use shortcut evaluation, that is, the second operand is evaluated only if necessary.
+
Example
+
+
+
+
print(10 or errorqueue.next())
+
print(nil or "a")
+
print(nil and 10)
+
print(false and errorqueue.next())
+
print(false and nil)
+
print(false or nil)
+
print(10 and 20)
+
+
1.00000e+01
+
a
+
nil
+
false
+
false
+
nil
+
2.00000e+01
+
+
+
+
+
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2657A/12906.html b/WebHelpDocs/Commands_2657A/12906.html
new file mode 100644
index 0000000..b5010e6
--- /dev/null
+++ b/WebHelpDocs/Commands_2657A/12906.html
@@ -0,0 +1,41 @@
+
+
+ Remote versus local state
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Remote versus local state
+
The Model 2657A can be in either the local state or the remote state. When in the local state (REM indicator off), the instrument is operated using the front panel controls. When in the remote state (REM indicator on), instrument operation is being controlled by the PC. When the instrument is powered-on, it will be in the local state.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
The Keithley Instruments Model 2657A High Power System SourceMeter® instrument is shipped with one or more factory scripts saved in its flash firmware memory. A factory script is made up of a number of functions. Some of them can be called from the front‑panel LOAD TEST menu. All of them can be called using remote programming.
+
As Keithley Instruments develops additional factory scripts, they will be made available on the Keithley Instruments website as a flash firmware upgrade for the Model 2657A. See Upgrading the firmware for instructions on upgrading the flash firmware of your Model 2657A instrument.
+
A factory script is similar to a user script, except a factory script is created by Keithley Instruments at the factory and is permanently stored in nonvolatile memory. The differences between a user script and a factory script include the following:
+
A factory script cannot be deleted from nonvolatile memory.
The script listing for a factory script can be retrieved and modified, but it will then be treated as a user script. A user script cannot be saved as a factory script.
Factory scripts are not stored in global variables. The only references to factory scripts are in the script.factory.scripts attribute.
The script.factory.catalog() function returns an iterator that can be used in a for loop to iterate over all the factory scripts.
Example
+
To retrieve the catalog listing for factory scripts, send:
+
for name in script.factory.catalog() do print(name) end
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
The KIPulse factory script provides examples of how to generate pulses and to provide a simple pulsing interface. Pulses can be generated using the functions listed below.
+
Please note the following information about the KIPulse factory script:
Ÿ This factory script only operates on the channels present in the instrument executing the pulse functions. These functions will not operate correctly if you attempt to access instrument channels over the TSP‑Link® interface.
Ÿ The KIPulse factory scripts are general purpose examples that may not be suitable for all use cases. Very short pulses (less than 1ms pulse width) may require optimization of the examples provided by the factory script in order to achieve settled measurements.
Ÿ The PulseIMeasureV() and PulseVMeasureI() functions may be accessed from the front panel. The remaining functions may only be accessed remotely.
+
Use the configuration KIPulse tag parameter pulse functions to configure a pulse train and assign the configuration to the tagparameter (use QueryPulseConfig() to inspect configured pulse trains). Use the initiation InitiatePulseTest() function to execute the pulse trains assigned to its tag arguments. The conditions listed in the table below must be true for these functions to execute successfully.
This KIPulse factory script function performs a specified number of pulse I, measure V cycles.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
PulseIMeasureV(smu, bias, level, ton, toff, points)
+
+
+
+
smu
+
+
System SourceMeter® instrument channel (set to smua)
+
+
+
+
bias
+
+
Bias level in amperes
+
+
+
+
level
+
+
Pulse level in amperes
+
+
+
+
ton
+
+
Pulse on time in seconds
+
+
+
+
toff
+
+
Pulse off time in seconds
+
+
+
+
points
+
+
Number of pulse-measure cycles
+
+
+
+
+
Details
+
Data for pulsed voltage measurements, current levels, and timestamps are stored in smua.nvbuffer1.
+
If any parameters are omitted or nil, the operator will be prompted to enter them using the front panel.
+
To perform the specified number of pulse I, measure V cycles, this function:
+
1. Sets the smu to output bias amperes and dwell for toff seconds.
+
2. Sets the smu to output level amperes and dwell for ton seconds.
+
3. Performs voltage measurement with source at level amperes.
+
4. Sets the smu to output bias amperes for toff seconds.
+
5. Repeats steps 2 through 4 for all remaining points pulse-measure cycles.
+
+
Example
+
+
+
+
PulseIMeasureV(smua, 0.001, 0.01,
+
20e-3, 40e-3, 10)
+
+
SMU A will output 1 mA and dwell for 40 ms, output 10 mA and dwell for 20 ms. The voltage measurements occur during each 20 ms dwell period. After the measurement, the output will return to 1 mA and dwell for 40 ms. This pulse‑measure process will repeat nine more times.
+
+
+
+
+
Also see
+
None
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This KIPulse factory script function performs a specified number of pulse V, measure I cycles.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
PulseVMeasureI(smu, bias, level, ton, toff, points)
+
+
+
+
smu
+
+
System SourceMeter® instrument channel (set to smua)
+
+
+
+
bias
+
+
Bias level in volts
+
+
+
+
level
+
+
Pulse level in volts
+
+
+
+
ton
+
+
Pulse on time in seconds
+
+
+
+
toff
+
+
Pulse off time in seconds
+
+
+
+
points
+
+
Number of pulse-measure cycles
+
+
+
+
+
Details
+
If any parameters are omitted or nil, the operator will be prompted to enter them using the front panel. Data for pulsed current measurements, voltage levels, and timestamps are stored in smuX.nvbuffer1.
+
To perform the specified number of pulse V, measure I cycles, this function:
+
Sets the smuto output bias volts and dwell for toff seconds
Sets the smu to output level volts and dwell for ton seconds
Performs voltage measurement with source at level volts
Sets the smu to output bias volts for toff seconds
Repeats steps 2 through 4 for the remaining points pulse-measure cycles
+
+
Example 1
+
+
+
+
smua.measure.nplc = 0.001
+
PulseVMeasureI(smua, -50, 125, 10e-3, 20e-3, 10)
+
+
SMU A will output -50 V and dwell for 10 ms, output 125 V and dwell for 20 ms. The current measurement occurs during the dwell period. After the measurement, the output will return to -50 V and dwell for 10 ms. This pulse-measure process will repeat 9 more times.
+
+
+
+
+
Also see
+
None
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
A Boolean flag; this flag will be true when the pulse was successfully configured, false when errors were encountered
+
+
+
+
msg
+
+
A string message; if the f flag is false, msg will contain an error message; if it is true, msg will contain a string indicating successful configuration
+
+
+
+
smu
+
+
System SourceMeter® instrument channel (set to smua)
+
+
+
+
bias
+
+
Bias level in amperes
+
+
+
+
level
+
+
Pulse level in amperes
+
+
+
+
limit
+
+
Voltage limit (for example, compliance) in volts
+
+
+
+
ton
+
+
Pulse on time in seconds
+
+
+
+
toff
+
+
Pulse off time in seconds
+
+
+
+
points
+
+
Number of pulse-measure cycles
+
+
+
+
buffer
+
+
Reading buffer where pulsed measurements will be stored; if this is nil when the function is called, no measurements will be made when the pulse train is initiated
+
+
+
+
tag
+
+
Numeric identifier to be assigned to the defined pulse train
+
+
+
+
sync_in
+
+
Defines a digital I/O trigger input line; if programmed, the pulse train will wait for a trigger input before executing each pulse
+
+
+
+
sync_out
+
+
Defines a digital I/O trigger output line; if programmed, the pulse train will generate a trigger output immediately before the start of ton
+
+
+
+
sync_in_timeout
+
+
Specifies the length of time (in seconds) to wait for input trigger; default value is 10 s
+
+
+
+
sync_in_abort
+
+
Specifies whether or not to abort pulse if input trigger is not received. If pulse aborts because of a missed trigger, a timer timeout message is returned; true or false
+
+
+
+
+
Details
+
Data for pulsed voltage measurements are stored in the reading buffer specified by the buffer input parameter.
+
This function configures a current pulse train with a voltage measurement at each point. Measurements are made at the end of the ton time.
+
This function does not cause the specified smu to output a pulse train. It simply checks to see if all of the pulse dimensions are achievable, and if they are, assigns the indicated tag or index to the pulse train.
+
Example
+
+
+
+
ConfigPulseIMeasureV(smua, 0, 10e-3,
+
100, 0.01, 0.1, 1, smua.nvbuffer1, 1)
+
+
Set up a pulse train that uses System SourceMeter® instrument channel A. The pulse amplitude will be 10 mA and will return to 0 A after 10 ms. The pulse will remain at 0 A for 100 ms and the voltage limit will be 100 V during the pulse. The pulse train will consist of only 1 pulse, and this pulse will be assigned a tag index of 1.
A Boolean flag; this flag will be true when the pulse was successfully configured, false when errors were encountered
+
+
+
+
msg
+
+
A string message; if the f flag is false, msg will contain an error message; if it is true, msg will contain a string indicating successful configuration
+
+
+
+
tag
+
+
Numeric identifier of the pulse configuration to be initiated
+
+
+
+
+
Details
+
This function will only initiate configured pulse trains assigned to a valid tag. Configure the pulse before initiating it using one of the ConfigurePulse* functions (refer to the Also see section).
+
Example
+
+
+
+
smua.reset()
+
+
smua.source.rangev = 200
+
smua.source.rangei = 0.01
+
smua.source.levelv = 0
+
+
smua.measure.rangev = 200
+
smua.measure.rangei = 0.01
+
smua.measure.nplc = 1
+
smua.measure.autozero = smua.AUTOZERO_ONCE
+
+
smua.nvbuffer1.clear()
+
smua.nvbuffer1.appendmode = 1
+
+
smua.source.output = smua.OUTPUT_ON
+
+
f1, msg1 = ConfigPulseVMeasureI(smua, 0,
+
100, 1e-3, 10e-3, 0.2, 10,
+
smua.nvbuffer1, 1)
+
+
if f1 == true then
+
f2, msg2 = InitiatePulseTest(1)
+
print("Initiate message:", msg2)
+
else
+
print("Config errors:", msg1)
+
end
+
+
Configure System SourceMeter® instrument channel A to generate a pulse train. If no errors are encountered, initiate the pulse train. Channel A will pulse voltage from a bias level of 0 V to a pulse level of 100 V. The pulse level will be present for 10 ms and the bias level for 200 ms, with a 1 mA limit setting. A total of 10 pulses will be generated, and the measurement data will be stored in smua.nvbuffer1. This pulse train will be assigned to tag = 1.
A Boolean flag; this flag will be true when the pulse was successfully configured, false when errors were encountered
+
+
+
+
msg
+
+
A string message; if the f flag is false, msg will contain an error message; if it is true, msg will contain a string indicating successful configuration
+
+
+
+
smu
+
+
System SourceMeter® instrument channel (set to smua)
+
+
+
+
bias
+
+
Bias level in volts
+
+
+
+
level
+
+
Pulse level in volts
+
+
+
+
limit
+
+
Current limit (for example, compliance) in amperes
+
+
+
+
ton
+
+
Pulse on time in seconds
+
+
+
+
toff
+
+
Pulse off time in seconds
+
+
+
+
points
+
+
Number of pulse-measure cycles
+
+
+
+
buffer
+
+
Reading buffer where pulsed measurements will be stored; if this is nil when the function is called, no measurements will be made when the pulse train is initiated
+
+
+
+
tag
+
+
Numeric identifier to be assigned to the defined pulse train
+
+
+
+
sync_in
+
+
Defines a digital I/O trigger input line; if programmed, the pulse train will wait for a trigger input before executing each pulse
+
+
+
+
sync_out
+
+
Defines a digital I/O trigger output line; if programmed, the pulse train will generate a trigger output immediately before the start of ton
+
+
+
+
sync_in_timeout
+
+
Specifies the length of time (in seconds) to wait for input trigger; default value is 10 s
+
+
+
+
sync_in_abort
+
+
Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or false
+
+
+
+
+
Details
+
Data for pulsed current measurements are stored in the reading buffer specified by the buffer input parameter.
+
This function configures a voltage pulse train with a current measurement at each point. Measurements are made at the end of the ton time.
+
This function does not cause the specified smu to output a pulse train. It simply checks to see if all of the pulse dimensions are achievable, and if they are, assigns the indicated tag or index to the pulse train.
+
+
Example 1
+
+
+
+
ConfigPulseVMeasureI(smua, 0, 400,
+
100e-6, 5e-3, 10e-3, 10,
+
smua.nvbuffer1, 2)
+
+
Set up a pulse train that uses System SourceMeter® instrument channel A. The pulse amplitude will be 400 V and will return to 0 V after 5 ms. The pulse will remain at 0 V for 10 ms, and the current limit will be 100 mA during the pulse. The pulse train will consist of 10 pulses, and the pulse train will be assigned a tag index of 2.
+
+
+
+
+
Example 2
+
+
+
+
local timelist = { 1, 2, 3, 4, 5 }
+
+
f, msg = ConfigPulseVMeasureI(smua, 0, 1,
+
100e-3, 1, timelist, 5, nil, 1)
+
+
Variable off time between pulses in a pulse train.
+
Configure a pulse with 1 second on-time and variable off-time, no measurement.
A Boolean flag; this flag will be true when the pulse was successfully configured, false when errors were encountered
+
+
+
+
msg
+
+
A string message; if the f flag is false, msg will contain an error message; if it is true, msg will contain a string indicating successful configuration
+
+
+
+
smu
+
+
System SourceMeter® instrument channel (set to smua)
+
+
+
+
bias
+
+
Bias level in amperes
+
+
+
+
start
+
+
Pulse sweep start level in volts
+
+
+
+
stop
+
+
Pulse sweep stop level in volts
+
+
+
+
limit
+
+
Voltage limit (for example, compliance) in volts
+
+
+
+
ton
+
+
Pulse on time in seconds
+
+
+
+
toff
+
+
Pulse off time in seconds
+
+
+
+
points
+
+
Number of pulse-measure cycles
+
+
+
+
buffer
+
+
Reading buffer where pulsed measurements will be stored; if this is nil when the function is called, no measurements will be made when the pulse train is initiated
+
+
+
+
tag
+
+
Numeric identifier to be assigned to the defined pulse train
+
+
+
+
sync_in
+
+
Defines a digital I/O trigger input line; if programmed, the pulse train will wait for a trigger input before executing each pulse
+
+
+
+
sync_out
+
+
Defines a digital I/O trigger output line; if programmed, the pulse train will generate a trigger output immediately before the start of ton
+
+
+
+
sync_in_timeout
+
+
Specifies the length of time (in seconds) to wait for input trigger; default value is 10 s
+
+
+
+
sync_in_abort
+
+
Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or false
+
+
+
+
+
Details
+
Data for pulsed voltage measurements are stored in the reading buffer specified by the buffer input parameter.
+
This function configures a linear pulsed current sweep with a voltage measurement at each point. Measurements are made at the end of the ton time.
+
The magnitude of the first pulse will be start amperes; the magnitude of the last pulse will be stop amperes. The magnitude of each pulse in between will be step amperes larger than the previous pulse, where:
+
step = (stop - start) / (points - 1)
+
This function does not cause the specified smu to output a pulse train. It simply checks to see if all of the pulse dimensions are achievable, and if they are, assigns the indicated tag or index to the pulse train.
Set up a pulsed sweep that will use System SourceMeter® instrument channel A. The pulsed sweep will start at 10 mA, end at 50 mA, and return to a 0 mA bias level between pulses. Each pulsed step will be on for 15 ms, and then at the bias level for 100 ms. The voltage limit will be 500 V during the entire pulsed sweep. The pulse train will be comprised of 20 pulsed steps and the pulse train will be assigned a tag index of 3.
f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff,
+
points, buffer, tag, sync_in, sync_out)
+
f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff,
+
points, buffer, tag, sync_in)
+
f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff,
+
points, buffer, tag)
+
+
+
+
f
+
+
A Boolean flag; this flag will be true when the pulse was successfully configured, false when errors were encountered
+
+
+
+
msg
+
+
A string message; if the f flag is false, msg will contain an error message; if it is true, msg will contain a string indicating successful configuration
+
+
+
+
smu
+
+
System SourceMeter® instrument channel (set to smua)
+
+
+
+
bias
+
+
Bias level in volts
+
+
+
+
start
+
+
Pulse sweep start level in volts
+
+
+
+
stop
+
+
Pulse sweep stop level in volts
+
+
+
+
limit
+
+
Current limit (for example, compliance) in amperes
+
+
+
+
ton
+
+
Pulse on time in seconds
+
+
+
+
toff
+
+
Pulse off time in seconds
+
+
+
+
points
+
+
Number of pulse-measure cycles
+
+
+
+
buffer
+
+
Reading buffer where pulsed measurements will be stored; if this is nil when the function is called, no measurements will be made when the pulse train is initiated
+
+
+
+
tag
+
+
Numeric identifier to be assigned to the defined pulse train
+
+
+
+
sync_in
+
+
Defines a digital I/O trigger input line; if programmed, the pulse train will wait for a trigger input before executing each pulse
+
+
+
+
sync_out
+
+
Defines a digital I/O trigger output line; if programmed, the pulse train will generate a trigger output immediately before the start of ton
+
+
+
+
sync_in_timeout
+
+
Specifies the length of time (in seconds) to wait for input trigger; default value is 10 s
+
+
+
+
sync_in_abort
+
+
Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or false
+
+
+
+
+
Details
+
Data for pulsed current measurements are stored in the reading buffer specified by the buffer input parameter.
+
This function configures a linear pulsed voltage sweep with a current measurement at each point. Measurements are made at the end of the ton time.
+
The magnitude of the first pulse will be start volts; the magnitude of the last pulse will be stop volts. The magnitude of each pulse in between will be step volts larger than the previous pulse, where:
+
step = (stop - start) / (points - 1)
+
This function does not cause the specified smu to output a pulse train. It simply checks to see if all of the pulse dimensions are achievable, and if they are, assigns the indicated tag or index to the pulse train.
+
Example
+
+
+
+
+
ConfigPulseVMeasureISweepLin(smua, 0,
+
100, 1000, 1e-3, 10e-3, 50e-3, 16,
+
smua.nvbuffer1, 4)
+
+
Set up a pulsed sweep that will use System SourceMeter® instrument channel A. The pulsed sweep will start at 100 V, end at 1000 V, and return to a 0 V bias level between pulses. Each pulsed step will be on for 10 ms, and then at the bias level for 50 ms.
+
The current limit will be 1 mA during the entire pulsed sweep. The pulse train will be comprised of 16 pulsed steps, and the pulse train will be assigned a tag index of 4.
f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff,
+
points, buffer, tag, sync_in, sync_out)
+
f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff,
+
points, buffer, tag, sync_in)
+
f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff,
+
points, buffer, tag)
+
+
+
+
f
+
+
A Boolean flag; this flag will be true when the pulse was successfully configured, false when errors were encountered
+
+
+
+
msg
+
+
A string message; if the f flag is false, msg will contain an error message; if it is true, msg will contain a string indicating successful configuration
+
+
+
+
smu
+
+
System SourceMeter® instrument channel (set to smua)
+
+
+
+
bias
+
+
Bias level in amperes
+
+
+
+
start
+
+
Pulse sweep start level in amperes
+
+
+
+
stop
+
+
Pulse sweep stop level in amperes
+
+
+
+
limit
+
+
Voltage limit (for example, compliance) in volts
+
+
+
+
ton
+
+
Pulse on time in seconds
+
+
+
+
toff
+
+
Pulse off time in seconds
+
+
+
+
points
+
+
Number of pulse-measure cycles
+
+
+
+
buffer
+
+
Reading buffer where pulsed measurements will be stored; if this is nil when the function is called, no measurements will be made when the pulse train is initiated
+
+
+
+
tag
+
+
Numeric identifier to be assigned to the defined pulse train
+
+
+
+
sync_in
+
+
Defines a digital I/O trigger input line; if programmed, the pulse train will wait for a trigger input before executing each pulse
+
+
+
+
sync_out
+
+
Defines a digital I/O trigger output line; if programmed, the pulse train will generate a trigger output immediately before the start of ton
+
+
+
+
sync_in_timeout
+
+
Specifies the length of time (in seconds) to wait for input trigger; default value is 10 s
+
+
+
+
sync_in_abort
+
+
Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or false
+
+
+
+
+
Details
+
Data for pulsed voltage measurements are stored in the reading buffer specified by the buffer input parameter.
+
This function configures a logarithmic pulsed current sweep with a voltage measurement at each point. Measurements are made at the end of the ton time.
+
The magnitude of the first pulse will be start amperes; the magnitude of the last pulse will be stop amperes. The magnitude of each pulse in between will be LogStepn amperes larger than the previous pulse, where:
LogStepn = (n - 1) * (LogStepSize), where n = [1, points]
+
SourceStepLeveln = antilog(LogStepn) * start
+
This function does not cause the specified smu to output a pulse train. It simply checks to see if all of the pulse dimensions are achievable, and if they are, assigns the indicated tag or index to the pulse train.
+
Example
+
+
+
+
ConfigPulseIMeasureVSweepLog(smua, 0,
+
1e-3, 0.01, 100, 10e-3, 100e-3,
+
10, smua.nvbuffer1, 5)
+
+
Set up a pulsed logarithmic sweep that uses System SourceMeter® instrument channel A. The pulsed sweep will start at 1 mA, end at 10 mA, and return to a 0 A bias level between pulses. Each pulsed step will be on for 10 ms, and then at the bias level for 100 ms. The voltage limit will be 100 V during the entire pulsed sweep. The pulse train will be comprised of 10 pulsed steps, and the pulse train will be assigned a tag index of 5.
f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff,
+
points, buffer, tag, sync_in, sync_out)
+
f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff,
+
points, buffer, tag, sync_in)
+
f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff,
+
points, buffer, tag)
+
+
+
+
f
+
+
A Boolean flag; this flag will be true when the pulse was successfully configured, false when errors were encountered
+
+
+
+
msg
+
+
A string message; if the f flag is false, msg will contain an error message; if it is true, msg will contain a string indicating successful configuration
+
+
+
+
smu
+
+
System SourceMeter® instrument channel (set to smua)
+
+
+
+
bias
+
+
Bias level in volts
+
+
+
+
start
+
+
Pulse sweep start level in volts
+
+
+
+
stop
+
+
Pulse sweep stop level in volts
+
+
+
+
limit
+
+
Current limit (for example, compliance) in amperes
+
+
+
+
ton
+
+
Pulse on time in seconds
+
+
+
+
toff
+
+
Pulse off time in seconds
+
+
+
+
points
+
+
Number of pulse-measure cycles
+
+
+
+
buffer
+
+
Reading buffer where pulsed measurements will be stored; if this is nil when the function is called, no measurements will be made when the pulse train is initiated
+
+
+
+
tag
+
+
Numeric identifier to be assigned to the defined pulse train
+
+
+
+
sync_in
+
+
Defines a digital I/O trigger input line; if programmed, the pulse train will wait for a trigger input before executing each pulse
+
+
+
+
sync_out
+
+
Defines a digital I/O trigger output line; if programmed, the pulse train will generate a trigger output immediately before the start of ton
+
+
+
+
sync_in_timeout
+
+
Specifies the length of time (in seconds) to wait for input trigger; default value is 10 s
+
+
+
+
sync_in_abort
+
+
Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or false
+
+
+
+
+
Details
+
Data for pulsed current measurements are stored in the reading buffer specified by the buffer input parameter.
+
This function configures a logarithmic pulsed voltage sweep with a current measurement at each point. Measurements are made at the end of the ton time.
+
The magnitude of the first pulse will be start volts; the magnitude of the last pulse will be stop volts. The magnitude of each pulse in between will be LogStepn volts larger than the previous pulse, where:
LogStepn = (n - 1) * (LogStepSize), where n = [1, points]
+
SourceStepLeveln = antilog(LogStepn) * start
+
This function does not cause the specified smu to output a pulse train. It simply checks to see if all of the pulse dimensions are achievable, and if they are, assigns the indicated tag or index to the pulse train.
+
Example
+
+
+
+
ConfigPulseVMeasureISweepLog(smua, 0,
+
10, 1000, 10e-3, 20e-3, 100e-3, 10,
+
smua.nvbuffer1, 6)
+
+
Set up a pulsed logarithmic sweep that will use System SourceMeter® instrument channel A. The pulsed sweep will start at 10 V, end at 1000 V, and return to a 0 V bias level between pulses. Each pulsed step will be on for 20 ms, and then at the bias level for 100 ms.
+
The current limit will be 10 mA during the entire pulsed sweep. The pulse train will be comprised of 10 pulsed steps, and the pulse train will be assigned a tag index of 6.
This KIPulse factory script function allows you to inspect the settings of the preconfigured pulse train assigned to tag.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
tbl = QueryPulseConfig(tag)
+
+
+
+
tag
+
+
Numeric identifier to be assigned to the defined pulse train
+
+
+
+
tbl
+
+
Returned table
+
+
+
+
+
Details
+
Once a pulse train has been configured and assigned to a tag, it is often desirable to inspect the settings of this preconfigured pulse train. The QueryPulseConfig() command can be used for this purpose.
+
This function will return a table containing the various settings associated with the tag input parameter.
+
+
+
+
+
+
+
Return values:
+
+
+
+
tostring()
+
+
A function that returns most elements in a string convenient for printing
+
+
+
+
tag
+
+
Identifying tag for this pulse train
+
+
+
+
smu
+
+
The SMU configured for pulsing
+
+
+
+
func
+
+
Pulse function:
+
smua.OUTPUT_DCAMPS or
+
smua.OUTPUT_DCVOLTS
+
+
+
+
bias
+
+
Pulse bias level
+
+
+
+
level
+
+
Pulse level for non sweeping pulses
+
+
+
+
start
+
+
Starting level for sweep pulses
+
+
+
+
stop
+
+
Ending level for sweep pulses
+
+
+
+
limit
+
+
Limit value
+
+
+
+
ton
+
+
On time in seconds
+
+
+
+
toff
+
+
Off time in seconds
+
+
+
+
points
+
+
The number of points in this pulse train
+
+
+
+
buf
+
+
Reference to buffer containing measurement data
+
+
+
+
sync_in
+
+
The sync_in digio line, if used
+
+
+
+
sync_out
+
+
The sync_out digio line, if used
+
+
+
+
sourcevalues
+
+
A table containing the source value for each point in the pulse train
+
+
+
+
+
Example
+
+
+
+
smua.reset()
+
+
smua.source.rangev = 500
+
smua.source.rangei = 0.1
+
smua.source.levelv = 0
+
+
smua.measure.rangev = 500
+
smua.measure.rangei = 0.1
+
smua.measure.nplc = 0.01
+
smua.measure.autozero = smua.AUTOZERO_ONCE
+
+
smua.nvbuffer1.clear()
+
smua.nvbuffer1.appendmode = 1
+
+
smua.source.output = smua.OUTPUT_ON
+
+
f1, msg1 = ConfigPulseVMeasureI(smua, 0,
+
300, 0.1, 5e-3, 0.2, 10,
+
smua.nvbuffer1, 1)
+
+
print(QueryPulseConfig(1).tostring())
+
+
Configure channel A to generate a pulse train, query configuration, and then display as a string. Channel A will pulse voltage from a bias level of 0 V to a pulse level of 300 V. The pulse level will be present for 5 ms, and the bias level for 200 ms with a 100 mA limit setting. A total of 10 pulses will be generated, and the measurement data will be stored in smua.nvbuffer1. This pulse train will be assigned to tag = 1.
The KIHighC factory script is made up of two functions: i_leakage_measure() and i_leakage_threshold(). Output is generally at a non-zero voltage prior to calling these functions. These functions can also be used to step the voltage to zero volts in order to measure the leakage current.
System SourceMeter® instrument channel (set to smua)
+
+
+
+
levelv
+
+
Voltage level to step to when this function is called
+
+
+
+
limiti
+
+
Current limit setting for the voltage step
+
+
+
+
sourcedelay
+
+
Delay to wait before lowering the current limit for measurement
+
+
+
+
measurei
+
+
Current limit (and measure range); note the current limit is lower at this level and because high-capacitance mode is active, the measure range will follow
+
+
+
+
measuredelay
+
+
Delay to wait after lowering the current limit before taking the measurement
+
+
+
+
+
Details
+
This function causes the smu to:
+
Change its current limit to limiti with a voltage output of levelv for sourcedelay time, and then changes its current limit to measurei (that also changes the measurement range to measurei) for measuredelay time
When measuredelay time expires, a measurement is taken and returned as imeas.
When measuring leakage current:
+
Charge the capacitor before calling this function (the instrument's output is usually at a nonzero voltage prior to calling this function; when measuring leakage, this function does not charge the capacitor).
Set levelv = 0
Example
+
+
+
+
smua.source.levelv = 500
+
smua.source.output = smua.OUTPUT_ON
+
delay(1)
+
imeas = i_leakage_measure(smua, 0, 20e-3,
+
500e-3, 10e-6, .1)
+
+
Charge the capacitor at 500 V for 1 second set by delay(1).
+
+
The parameters passed on to the i_leakage_measure() function in this example are:
+
smu = smua
+
levelv = 0 V
+
limiti = 20 mA
+
sourcedelay = 500 ms
+
measurei = 10 mA range
+
measuredelay = 100 ms
+
The levels and delays will depend on the value and type of capacitor used.
This KIHighC factory script function measures the current and compares it to a threshold until either the measured current drops below the threshold or the timeout expires.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
f = i_leakage_threshold(smu, levelv, limiti, sourcedelay, measurei, measuredelay, threshold, timeout)
+
+
+
+
f
+
+
A Boolean flag; this flag will be true when the current is below the threshold, false if threshold is not reached before timeout expires
+
+
+
+
smu
+
+
System SourceMeter® instrument channel (set to smua)
+
+
+
+
levelv
+
+
Voltage level to step to when this function is called
+
+
+
+
limiti
+
+
Current limit setting for the voltage step
+
+
+
+
sourcedelay
+
+
Delay to wait before lowering the current limit for measurement
+
+
+
+
measurei
+
+
Current limit (and measure range); note the current limit is lower at this level and because high-capacitance mode is active, the measure range will follow
+
+
+
+
measuredelay
+
+
Delay before the first measurement after measure range is changed
+
+
+
+
threshold
+
+
The specified current that establishes the test limit
+
+
+
+
timeout
+
+
Amount of time (in seconds) to wait for the current to drop to threshold after all the delays have occurred
+
+
+
+
+
Details
+
This function causes the smu to:
+
Change its current limit to limiti with a voltage output of levelv for sourcedelay time, and then changes its current limit to measurei (that also changes the measurement range to measurei) for measuredelay time
When measuredelay time expires, measurements are taken at a rate determined by the smuX.measure.nplc setting
The function returns true if threshold is reached; the function returns false if threshold is not reached before timeout expires.
+
When testing the leakage current threshold:
+
Charge the capacitor before calling this function (the instrument's output is usually at a non-zero voltage prior to calling this function; when measuring leakage, this function does not charge the capacitor).
If testing the device's leakage current threshold, set levelv = 0.
Example
+
+
+
+
smua.source.levelv = 500
+
smua.source.output = smua.OUTPUT_ON
+
delay(1)
+
pass = i_leakage_threshold(smua, 0, 20e-3,
+
500e-3, 10e-6, 100e-3, 1e-6, 5)
+
+
Charge the capacitor.
+
+
+
The parameters passed on to the i_threshold_measure() function in this example are:
+
smu = smua
+
levelv = 0 V
+
limiti = 20 mA
+
sourcedelay = 500 ms
+
measurei = 10 mA range
+
measuredelay = 100 ms
+
threshold = 1 mA
+
timeout = 5 s
+
The levels and delays will depend on the value and type of capacitor used.
+
Sets pass = true if the current is measured below 1 mA in less than 1 second.
A Lua table containing the calculated Gm values at each point
+
+
+
+
ibuf
+
+
A reading buffer containing the measured current at each point
+
+
+
+
vbuf
+
+
A reading buffer containing the measured voltage at each point
+
+
+
+
smu
+
+
System SourceMeter® instrument channel (set to smua)
+
+
+
+
start_v
+
+
Starting voltage level of the sweep
+
+
+
+
stop_v
+
+
Ending voltage level of the sweep
+
+
+
+
points
+
+
Number of measurements between start_v and stop_v (must be ³ 2)
+
+
+
+
+
Details
+
Output data includes transconductance values, reading buffer with measured currents, reading buffer with measured currents and voltages.
+
The gm_vsweep() function performs a linear voltage sweep, measuring voltage and current, and then calculating the transconductance (Gm) at each point using the central difference method. It can return an array of Gm values, a reading buffer with the measured currents, and a reading buffer with the measured voltages.
+
Example
+
+
+
+
gm_array = gm_vsweep(smua, 0, 10, 5)
+
+
gm_array, ibuf = gm_vsweep(smua, 0, 10, 5)
+
+
+
gm_array, ibuf, vbuf = gm_vsweep(smua, 0, 10, 5)
+
+
SMU A returns Gm values only.
+
+
SMU A returns Gm and reading buffer with measured currents.
+
+
SMU A returns Gm and reading buffers with measured currents and voltages.
A Lua table containing the calculated Gm values at each point
+
+
+
+
vbuf
+
+
A reading buffer containing the measured voltage at each point
+
+
+
+
ibuf
+
+
A reading buffer containing the measured current at each point
+
+
+
+
smu
+
+
System SourceMeter® instrument channel (set to smua)
+
+
+
+
start_i
+
+
Starting current level of the sweep
+
+
+
+
stop_i
+
+
Ending current level of the sweep
+
+
+
+
points
+
+
Number of measurements between start_i and stop_i (must be ³ 2)
+
+
+
+
+
Details
+
Output data includes transconductance values, reading buffer with measured voltages, reading buffer with measured voltages and currents.
+
If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.
+
The gm_isweep() function performs a linear current sweep, measuring voltage and current, and then calculating the transconductance (Gm) at each point using the central difference method. It can return an array of Gm values, a reading buffer with the measured voltages, and a reading buffer with the measured currents.
+
Example
+
+
+
+
gm_array = gm_isweep(smua, 0, 0.01, 20)
+
+
+
gm_array, vbuf = gm_isweep(smua, 0, 0.01, 20)
+
+
+
gm_array, vbuf, ibuf = gm_isweep(smua, 0,
+
0.01, 20)
+
+
Source‑measure unit (SMU) A returns Gm values only.
+
+
SMU A returns Gm and reading buffer with measured voltages.
+
+
SMU A returns Gm and reading buffers with measured voltages and currents.
This section contains an overview of the instrument commands organized into groups, with a brief description of each group. Each section contains links to the detailed command descriptions for each command in the command reference section of this documentation (see Commands).
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
Reading buffers capture measurements, ranges, instrument status, and output state of the Keithley Instruments Model 2657A. The Model 2657A has two dedicated reading buffers. You can use the dedicated reading buffers to acquire readings, or you can use the smua.makebuffer() function to create dynamic reading buffers.
+
You can access dedicated reading buffers from the front panel; both dedicated and dynamic reading buffers can be accessed over the remote command interface.
+
Each dedicated reading buffer in the Model 2657A can store over 60,000 readings with the timestamps and source values options enabled. To store over 140,000 readings internally, disable the timestamps and source values options.
+
You can save the dedicated reading buffers to internal nonvolatile memory in the instrument or to a USB flash drive.
+
Once you save the reading buffers to a USB flash drive, insert the USB flash drive into the USB port on your computer to view the data in any compatible data analysis application, or to transfer the data from the USB flash drive to your computer.
+
Reading buffers (other than the dedicated reading buffers) have fixed capacity and are not specifically limited to 60,000 or 140,000 readings.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
Function-based commands control actions or activities. A function-based command is not always directly related to instrument operation. For example, the bit.bitand() function will perform a logical AND operation on two numbers. Each function consists of a function name followed by a set of parentheses ( ). If the function does not have a parameter, the parentheses are left empty. If the function takes one or more parameters, they are placed between the parentheses and separated by commas.
+
+
Example 1
+
+
+
+
digio.writeport(15)
+
digio.writebit(3, 0)
+
reset()
+
digio.readport()
+
+
Sets digital I/O lines 1, 2, 3, and 4 high.
+
Sets line 3 to low (0).
+
Returns the instrument to its default settings.
+
Reads the digital I/O port.
+
+
+
+
+
Example 2
+
You can use the results of a function-based command directly or assign variables to the results for later access. The following code saves the value you enter from the front panel and prints it.
+
+
+
+
value = display.inputvalue("+0.00")
+
print(value)
+
+
If the operator enters 2.36 from the front panel, the resulting output is:
+
2.36000e+00
+
+
+
+
+
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This function resets commands to their default settings.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
reset()
+
reset(system)
+
+
+
+
system
+
+
true: If the node is the master, the entire system is reset
+
false: Only the local group is reset
+
+
+
+
+
Details
+
The reset() command in its simplest form resets the entire TSP‑enabled system, including the controlling node and all subordinate nodes.
+
If you want to reset a specific instrument, use either the localnode.reset() or node[X].reset() command. The localnode.reset() command is used for the local instrument. The node[X].reset() command is used to reset an instrument on a subordinate node.
+
When no value is specified for system, the default value is true.
+
Resetting the entire system using reset(true) is permitted only if the node is the master. If the node is not the master node, executing this command generates an error.
+
Example
+
+
+
+
reset(true)
+
+
If the node is the master node, the entire system is reset; if the node is not the master node, an error is generated.
This function sets the real-time clock (sets current time of the system).
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
settime(time)
+
+
+
+
time
+
+
The time in seconds since January 1, 1970 UTC
+
+
+
+
+
Details
+
This function sets the date and time of the instrument based on the time parameter (specified in UTC time). UTC time is specified as the number of seconds since Jan 1, 1970, UTC. You can use UTC time from a local time specification, or you can use UTC time from another source (for example, your computer).
+
To use the Lua os.time() function to generate a time value in UTC time, use the following format:
+
os.time({year = year, month = month, day = day, hour = hour, min = min, sec = sec})
+
Where:
+
+
+
year
+
+
= A full year (2006 or later)
+
+
+
+
month
+
+
= The desired month (1 to 12)
+
+
+
+
day
+
+
= The desired day (1 to 31)
+
+
+
+
hour
+
+
= The desired hour (00 to 23)
+
+
+
+
min
+
+
= The desired minute (00 to 59)
+
+
+
+
sec
+
+
= The desired second (00 to 59)
+
+
+
+
+
When you are using the os.time() function, make sure that you include the year, month, and day parameters, which are mandatory (the rest are optional). If the other parameters are not used, they default to noon for that day.
+
Set the time zone before calling the os.time() function.
+
Example
+
+
+
+
systemTime = os.time({year = 2010,
+
month = 3,
+
day = 31,
+
hour = 14,
+
min = 25})
+
settime(systemTime)
+
+
Sets the date and time to Mar 31, 2010 at 2:25 pm.
This function delays the execution of the commands that follow it.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
delay(seconds)
+
+
+
+
seconds
+
+
The number of seconds to delay, maximum 100,000
+
+
+
+
+
Details
+
You cannot set a delay for zero seconds.
+
The system delays execution of the commands for at least the specified number of seconds and fractional seconds. However, the processing time may cause the system to delay 5 µs to 10 µs (typical) more than the requested delay.
+
Example 1
+
+
+
+
beeper.beep(0.5, 2400)
+
delay(0.250)
+
beeper.beep(0.5, 2400)
+
+
Emit a double‑beep at 2400 Hz. The sequence is 0.5 s on, 0.25 s off, 0.5 s on.
+
+
+
+
+
Example 2
+
+
+
+
dataqueue.clear()
+
dataqueue.add(35)
+
timer.reset()
+
delay(0.5)
+
dt = timer.measure.t()
+
print("Delay time was " .. dt)
+
print(dataqueue.next())
+
+
Clear the data queue, add 35 to it, then delay 0.5 seconds before reading it.
+
+
Output:
+
Delay time was 0.500099
+
3.50000e+01
+
+
+
+
+
Also see
+
None
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This function creates an iterator for the user string catalog.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
for name in userstring.catalog() do body end
+
+
+
+
name
+
+
The name of the string; the key of the key-value pair
+
+
+
+
body
+
+
Code to execute in the body of the for loop
+
+
+
+
+
Details
+
The catalog provides access for userstring pairs, allowing you to manipulate all the key-value pairs in nonvolatile memory. The entries are enumerated in no particular order.
+
Example 1
+
+
+
+
for name in userstring.catalog() do
+
userstring.delete(name)
+
end
+
+
Deletes all user strings in nonvolatile memory.
+
+
+
+
+
Example 2
+
+
+
+
for name in userstring.catalog() do
+
print(name .. " = " ..
+
userstring.get(name))
+
end
+
+
Prints all userstring key‑value pairs.
+
+
Output:
+
product = Widgets
+
assetnumber = 236
+
contact = John Doe
+
The above output lists the user strings added in the example for the userstring.add() function. Notice the key-value pairs are not listed in the order they were added.
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2657A/1401.html b/WebHelpDocs/Commands_2657A/1401.html
new file mode 100644
index 0000000..1307fa0
--- /dev/null
+++ b/WebHelpDocs/Commands_2657A/1401.html
@@ -0,0 +1,41 @@
+
+
+ Digital I/O port
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Digital I/O port
+
The Model 2657A instruments have a digital input/output port that can be used to control external digital circuitry. For example, a handler that is used to perform binning operations can be used with a digital I/O port. The digital I/O port is a standard female DB-25 connector.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
Use the functions in this group to store and retrieve user-defined strings in nonvolatile memory. These strings are stored as key‑value pairs. You can use the userstring functions to store custom, instrument-specific information in the instrument, such as department number, asset number, or manufacturing plant location.
The connection ID to be used as a handle in all other tspnet function calls
+
+
+
+
ipAddress
+
+
IP address to which to connect
+
+
+
+
portNumber
+
+
Port number (default 5025)
+
+
+
+
initString
+
+
Initialization string to send to ipAddress
+
+
+
+
+
Details
+
This command connects a device to another device through the LAN interface. If the portNumber is 23, the interface uses the Telnet protocol and sets appropriate termination characters to communicate with the device.
+
If a portNumber and initString are provided, it is assumed that the remote device is not TSP‑enabled. The Model 2657A does not perform any extra processing, prompt handling, error handling, or sending of commands. Additionally, the tspnet.tsp.* commands cannot be used on devices that are not TSP‑enabled.
+
If neither a portNumber nor an initString is provided, the remote device is assumed to be a Keithley Instruments TSP‑enabled device. Depending on the state of the tspnet.tsp.abortonconnect attribute, the Model 2657A sends an abort command to the remote device on connection.
+
The Model 2657A also enables TSP prompts on the remote device and error management. The Model 2657A places remote errors from the TSP‑enabled device in its own error queue and prefaces these errors with Remote Error, followed by an error description.
+
Do not manually change either the prompt functionality (localnode.prompts) or show errors by changing localnode.showerrors on the remote TSP-enabled device, or subsequent tspnet.tsp.* commands using the connection may fail.
+
You can simultaneously connect to a maximum of 32 remote devices.
The second value decoded from the response message
+
+
+
+
valuen
+
+
The nth value decoded from the response message; there is one return value per format specifier in the format string
+
+
+
+
...
+
+
One or more values separated with commas
+
+
+
+
formatString
+
+
Format string for the output
+
+
+
+
+
Details
+
This command sends the command string to the remote instrument. A termination is added to the command string when it is sent to the remote instrument (tspnet.termination()). You can also specify a format string, which causes the command to wait for a response from the remote instrument. The Model 2657A decodes the response message according to the format specified in the format string and returns the message as return values from the function (see tspnet.read() for format specifiers).
+
When this command is sent to a TSP-enabled instrument, the Model 2657A suspends operation until a timeout error is generated or until the instrument responds, even if no format string is specified. The TSP prompt from the remote instrument is read and thrown away. The Model 2657A places any remotely generated errors into its error queue. When the optional format string is not specified, this command is equivalent to tspnet.write(), except that a termination is automatically added to the end of the command.
+
Example 1
+
+
+
+
tspnet.execute(instrumentID, "runScript()")
+
+
Command remote device to run script named runScript.
The second value decoded from the response message
+
+
+
+
valueN
+
+
The nth value decoded from the response message; there is one return value for each format specifier in the format string
+
+
+
+
...
+
+
One or more values separated with commas
+
+
+
+
connectionID
+
+
The connection ID returned from tspnet.connect()
+
+
+
+
formatString
+
+
Format string for the output, maximum of 10 specifiers
+
+
+
+
+
Details
+
This command reads available data from the remote instrument and returns responses for the specified number of arguments.
+
The format string can contain the following specifiers:
+
+
+
+
%[width]s
+
+
Read data until the specific length
+
+
+
+
%[max width]t
+
+
Read data until the specific length or delimited by punctuation
+
+
+
+
%[max width]n
+
+
Read data until a newline or carriage return
+
+
+
+
%d
+
+
Read a number (delimited by punctuation)
+
+
+
+
+
A maximum of 10 format specifiers can be used for a maximum of 10 return values.
+
If formatString is not provided, the command returns a string containing the data until a new line is reached. If no data is available, the Model 2657A pauses operation until the requested data is available or until a timeout error is generated. Use tspnet.timeout to specify the timeout period.
+
When reading from a TSP-enabled remote instrument, the Model 2657A removes Test Script Processor (TSP®) prompts and places any errors received from the remote instrument into its own error queue. The Model 2657A prefaces errors from the remote device with "Remote Error," and follows this with the error number and error description.
The number of bytes available to be read from the connection
+
+
+
+
connectionID
+
+
The connection ID returned from tspnet.connect()
+
+
+
+
+
Details
+
This command checks to see if any output data is available from the device. No data is read from the instrument. This allows TSP scripts to continue to run without waiting on a remote command to finish.
+
Example
+
+
+
+
ID = tspnet.connect("192.0.2.1")
+
tspnet.write(ID, "*idn?\r\n")
+
+
repeat bytes = tspnet.readavailable(ID) until bytes > 0
This command disconnects all remote instruments connected through TSP-Net. For TSP-enabled devices, this causes any commands or scripts running remotely to be terminated.
+
Also see
+
None
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This function sets the device line termination sequence.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
type = tspnet.termination(connectionID)
+
type = tspnet.termination(connectionID, termSequence)
+
+
+
+
type
+
+
+
An enumerated value indicating the termination type:
+
1 or tspnet.TERM_LF
4 or tspnet.TERM_CR
2 or tspnet.TERM_CRLF
3 or tspnet.TERM_LFCR
+
+
+
connectionID
+
+
The connection ID returned from tspnet.connect()
+
+
+
+
termSequence
+
+
The termination sequence
+
+
+
+
+
Details
+
This function sets and gets the termination character sequence that is used to indicate the end of a line for a TSP-Net connection.
+
Using the termSequence parameter sets the termination sequence. The present termination sequence is always returned.
+
For the termSequence parameter, use the same values listed in the table above for type. There are four possible combinations, all of which are made up of line feeds (LF or 0x10) and carriage returns (CR or 0x13). For TSP-enabled devices, the default is tspnet.TERM_LF. For devices that are not TSP‑enabled, the default is tspnet.TERM_CRLF.
+
Example
+
+
+
+
deviceID = tspnet.connect("192.0.2.1")
+
if deviceID then
+
tspnet.termination(deviceID, tspnet.TERM_LF)
+
end
+
+
Sets termination type for IP address 192.0.2.1 to TERM_LF.
This attribute contains the setting for abort on connect to a TSP-enabled instrument.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset Recall setup
+
+
Not saved
+
+
1 (enable)
+
+
+
+
+
Usage
+
tspnet.tsp.abortonconnect = value
+
value = tspnet.tsp.abortonconnect
+
+
+
+
value
+
+
1 (enable) or 0 (disable)
+
+
+
+
+
Details
+
This setting determines if the instrument sends an abort message when it attempts to connect to a TSP‑enabled instrument using the tspnet.connect() function.
+
When you send the abort command on an interface, it causes any other active interface on that instrument to close. If you do not send an abort command (or if tspnet.tsp.abortonconnect is set to 0) and another interface is active, connecting to a TSP‑enabled remote instrument results in a connection. However, the instrument will not respond to subsequent reads or executes because control of the instrument is not obtained until an abort command has been sent. See Communication interfaces.
+
Example
+
+
+
+
tspnet.tsp.abortonconnect = 0
+
+
Configure the instrument so that it does not send an abort command when connecting to a TSP‑enabled instrument.
This function writes a string to the remote instrument.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
tspnet.write(connectionID, inputString)
+
+
+
+
connectionID
+
+
The connection ID returned from tspnet.connect()
+
+
+
+
inputString
+
+
The string to be written
+
+
+
+
+
Details
+
The tspnet.write() function sends inputString to the remote instrument. It does not wait for command completion on the remote instrument.
+
The Model 2657A sends inputString to the remote instrument exactly as indicated. The inputString must contain any necessary new lines, termination, or other syntax elements needed to complete properly.
+
Because tspnet.write() does not process output from the remote instrument, do not send commands that generate too much output without processing the output. This command can stop executing if there is too much unprocessed output from previous commands.
+
Example
+
+
+
+
tspnet.write(myID, "runscript()\r\n")
+
+
Commands the remote instrument to execute a command or script named "runscript()" on a remote device identified in the system as myID.
Integer value used as a handle for other tspnet commands
+
+
+
+
name
+
+
The full name of the reading buffer name and synchronous table to copy
+
+
+
+
startIndex
+
+
Integer start value
+
+
+
+
endIndex
+
+
Integer end value
+
+
+
+
+
Details
+
This function is only appropriate for TSP-enabled instruments.
+
This function reads the data from a reading buffer on a remote instrument and returns an array of numbers or a string representing the data. The startIndex and endIndex parameters specify the portion of the reading buffer to read. If no index is specified, the entire buffer is copied.
+
The function will return a table if the table is an array of numbers; otherwise a comma‑delimited string is returned.
+
This command is limited to transferring 50,000 readings at a time.
+
Example
+
+
+
+
t = tspnet.tsp.rbtablecopy(testConnection,
+
"testRemotebuffername.readings", 1, 3)
+
print(t[1], t[2], t[3])
+
+
Copy the specified readings table for buffer items 1 through 3, then display the first three readings. Sample output:
+
4.56534e-01
+
4.52675e-01
+
4.57535e-01
+
+
+
+
+
Also see
+
None
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2657A/14126.html b/WebHelpDocs/Commands_2657A/14126.html
new file mode 100644
index 0000000..a03e064
--- /dev/null
+++ b/WebHelpDocs/Commands_2657A/14126.html
@@ -0,0 +1,88 @@
+
+
+ Status model
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Status model
+
The status model is a set of status registers and queues. You can use the following commands to manipulate and monitor these registers and queues to view and control various instrument events.
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2657A/14129.html b/WebHelpDocs/Commands_2657A/14129.html
new file mode 100644
index 0000000..1860b5e
--- /dev/null
+++ b/WebHelpDocs/Commands_2657A/14129.html
@@ -0,0 +1,92 @@
+
+
+ LAN and LXI
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
LAN and LXI
+
The LAN commands have options that allow you to review and configure network settings.
+
The lan.config.* commands allow you to configure LAN settings over the remote interface. Note that you must send lan.applysettings() for the configuration settings to take effect.
+
The lan.status.* commands help you determine the status of the LAN.
+
The lan.trigger[N].* commands allow you to set up and assert trigger events that are sent over the LAN.
+
Other LAN commands allow you to reset the LAN, restore defaults, check LXI domain information, and enable or disable the Nagle algorithm.
This function overwrites a bit field at a specified index position.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
result = bit.setfield(value, index, width, fieldValue)
+
+
+
+
result
+
+
Result of the bit manipulation
+
+
+
+
value
+
+
Specified number
+
+
+
+
index
+
+
One‑based bit position in value to set (1 to 32)
+
+
+
+
width
+
+
The number of bits to include in the field (1 to 32)
+
+
+
+
fieldValue
+
+
Value to write to the field
+
+
+
+
+
Details
+
This function returns result, which is value with a field of bits overwritten, starting at index. The index specifies the position of the least significant bit of value. The width bits starting at index are set to fieldValue.
+
The least significant bit of value is at index position 1; the most significant bit is at index position 32.
+
Before setting the field of bits, any fractional parts of value and fieldValue are truncated to form integers.
+
If fieldValue is wider than width, the most significant bits of the fieldValue that exceed the width are truncated. For example, if width is 4 bits and the binary value for fieldValue is 11110 (5 bits), the most significant bit of fieldValue is truncated and a binary value of 1110 is used.
+
Example
+
+
+
+
testResult = bit.setfield(15, 2, 3, 5)
+
+
+
print(testResult)
+
+
The binary equivalent of decimal 15 is 1111. After overwriting it with a decimal 5 (binary 101) at index position 2, the returned value is decimal 11 (binary 1011).
The resulting value of true or false based on the success of the function
+
+
+
+
value
+
+
The data item to add; value can be of any type
+
+
+
+
timeout
+
+
The maximum number of seconds to wait for space in the data queue
+
+
+
+
+
Details
+
You cannot use the timeout value when accessing the data queue from a remote node (you can only use the timeout value while adding data to the local data queue).
+
The timeout value is ignored if the data queue is not full.
+
The dataqueue.add() function returns false:
+
If the timeout expires before space is available in the data queue
If the data queue is full and a timeout value is not specified
If the value is a table, a duplicate of the table and any subtables is made. The duplicate table does not contain any references to the original table or to any subtables.
This attribute contains the number of items in the data queue.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Power cycle
+
+
Not saved
+
+
Not applicable
+
+
+
+
+
Usage
+
count= dataqueue.count
+
+
+
+
count
+
+
The number of items in the data queue
+
+
+
+
+
Details
+
The count gets updated as entries are added with dataqueue.add() and read from the data queue with dataqueue.next(). It is also updated when the dataqueue is cleared with dataqueue.clear().
+
A maximum of dataqueue.CAPACITY items can be stored at any one time in the data queue.
+
Example
+
+
+
+
MaxCount = dataqueue.CAPACITY
+
while dataqueue.count < MaxCount do
+
dataqueue.add(1)
+
end
+
print("There are " .. dataqueue.count
+
.. " items in the data queue")
+
dataqueue.clear()
+
print("There are " .. dataqueue.count
+
.. " items in the data queue")
+
+
Add items to the data queue until it is at capacity.
This function removes the next entry from the data queue.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
value = dataqueue.next()
+
value = dataqueue.next(timeout)
+
+
+
+
value
+
+
The next entry in the data queue
+
+
+
+
timeout
+
+
The number of seconds to wait for data in the queue
+
+
+
+
+
Details
+
If the data queue is empty, the function waits up to the timeout value.
+
If data is not available in the data queue before the timeout expires, the return value is nil.
+
The entries in the data queue are removed in first-in, first-out (FIFO) order.
+
If the value is a table, a duplicate of the original table and any subtables is made. The duplicate table does not contain any references to the original table or to any subtables.
+
Example
+
+
+
+
dataqueue.clear()
+
for i = 1, 10 do
+
dataqueue.add(i)
+
end
+
print("There are " .. dataqueue.count
+
.. " items in the data queue")
+
+
while dataqueue.count > 0 do
+
x = dataqueue.next()
+
print(x)
+
end
+
print("There are " .. dataqueue.count
+
.. " items in the data queue")
+
+
Clears the data queue, adds ten entries, then reads the entries from the data queue.
The digital I/O port of the Model 2657A can control external circuitry (such as a component handler for binning operations).
+
The I/O port has 14 lines. Each line can be at TTL logic state 1 (high) or 0 (low). See the pinout diagram in Digital I/O port for additional information.
+
There are commands to read and write to each individual bit, and commands to read and write to the entire port.
The present value of the input lines on the digital I/O port
+
+
+
+
+
Details
+
The binary equivalent of the returned value indicates the value of the input lines on the I/O port. The least significant bit (bit B1) of the binary number corresponds to line 1; bit B14 corresponds to line 14.
+
For example, a returned value of 170 has a binary equivalent of 000000010101010, which indicates that lines 2, 4, 6, and 8 are high (1), and the other 10 lines are low (0).
+
Example
+
+
+
+
data = digio.readport()
+
print(data)
+
+
Assume lines 2, 4, 6, and 8 are set high when the I/O port is read.
This function clears the trigger event on a digital I/O line.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
digio.trigger[N].clear()
+
+
+
+
N
+
+
Digital I/O trigger line (1 to 14)
+
+
+
+
+
Details
+
The event detector of a trigger recalls if a trigger event has been detected since the last digio.trigger[N].wait() command. This function clears the event detector of the specified trigger line, discards the previous history of the trigger line, and clears the digio.trigger[N].overrun attribute.
This constant identifies the trigger event generated by the digital I/O line N.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Constant
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
eventID = digio.trigger[N].EVENT_ID
+
+
+
+
eventID
+
+
The trigger event number
+
+
+
+
N
+
+
Digital I/O trigger line (1 to 14)
+
+
+
+
+
Details
+
To have another trigger object respond to trigger events generated by the trigger line, set the other object's stimulus attribute to the value of this constant.
This attribute sets the mode in which the trigger event detector and the output trigger generator operate on the given trigger line.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset Digital I/O trigger N reset Recall setup
+
+
Not saved
+
+
0 (digio.TRIG_BYPASS)
+
+
+
+
+
Usage
+
triggerMode = digio.trigger[N].mode
+
digio.trigger[N].mode = triggerMode
+
+
+
+
triggerMode
+
+
The trigger mode; see Details for values
+
+
+
+
N
+
+
Digital I/O trigger line (1 to 14)
+
+
+
+
+
Details
+
Set triggerMode to one of the following values:
+
+
+
+
+
+
+
+
Trigger mode values
+
+
+
+
triggerMode
+
+
Description
+
+
+
+
digio.TRIG_BYPASS or 0
+
+
Allows direct control of the line.
+
+
+
+
digio.TRIG_FALLING or 1
+
+
Detects falling‑edge triggers as input; asserts a TTL-low pulse for output.
+
+
+
+
digio.TRIG_RISING or 2
+
+
If the programmed state of the line is high, the digio.TRIG_RISING mode behavior is similar to digio.TRIG_RISINGA. If the programmed state of the line is low, the digio.TRIG_RISING mode behavior is similar to digio.TRIG_RISINGM. This setting should only be used if necessary for compatibility with other Keithley Instruments products.
+
+
+
+
digio.TRIG_EITHER or 3
+
+
Detects rising- or falling‑edge triggers as input. Asserts a TTL‑low pulse for output.
+
+
+
+
digio.TRIG_SYNCHRONOUSA or 4
+
+
Detects the falling‑edge input triggers and automatically latches and drives the trigger line low. Asserting the output trigger releases the latched line.
+
+
+
+
digio.TRIG_SYNCHRONOUS or 5
+
+
Detects the falling‑edge input triggers and automatically latches and drives the trigger line low. Asserts a TTL‑low pulse as an output trigger.
+
+
+
+
digio.TRIG_SYNCHRONOUSM or 6
+
+
Detects rising‑edge triggers as input. Asserts a TTL‑low pulse for output.
+
+
+
+
digio.TRIG_RISINGA or 7
+
+
Detects rising‑edge triggers as input. Asserts a TTL‑low pulse for output.
+
+
+
+
digio.TRIG_RISINGM or 8
+
+
Asserts a TTL-high pulse for output. Input edge detection is not possible in this mode.
+
+
+
+
+
When programmed to any mode except digio.TRIG_BYPASS, the output state of the I/O line is controlled by the trigger logic, and the user‑specified output state of the line is ignored.
+
Use of either digio.TRIG_SYNCHRONOUSA or digio.TRIG_SYNCHRONOUSM is preferred over digio.TRIG_SYNCHRONOUS, because digio.TRIG_SYNCHRONOUS is provided for compatibility with the digital I/O and TSP-Link triggering on other Keithley Instruments products.
+
To control the line state, set the mode to digio.TRIG_BYPASS and use the digio.writebit() and digio.writeport() commands.
+
Example
+
+
+
+
digio.trigger[4].mode = 2
+
+
Sets the trigger mode for I/O line 4 to digio.TRIG_RISING.
Use this attribute to read the event detector overrun status.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Instrument reset Digital I/O trigger N clear Digital I/O trigger N reset Recall setup
+
+
Not saved
+
+
Not applicable
+
+
+
+
+
Usage
+
overrun = digio.trigger[N].overrun
+
+
+
+
overrun
+
+
Trigger overrun state (true or false)
+
+
+
+
N
+
+
Digital I/O trigger line (1 to 14)
+
+
+
+
+
Details
+
If this is true, an event was ignored because the event detector was already in the detected state when the event occurred.
+
This is an indication of the state of the event detector built into the line itself. It does not indicate if an overrun occurred in any other part of the trigger model or in any other detector that is monitoring the event.
+
Example
+
+
+
+
overrun = digio.trigger[1].overrun
+
print(overrun)
+
+
If there is no trigger overrun, the following text is output:
This function releases an indefinite length or latched trigger.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
digio.trigger[N].release()
+
+
+
+
N
+
+
Digital I/O trigger line (1 to 14)
+
+
+
+
+
Details
+
Releases a trigger that was asserted with an indefinite pulse width time, as well as a trigger that was latched in response to receiving a synchronous mode trigger. Only the specified trigger line (N) is affected.
The value true if a trigger is detected, or false if no triggers are detected during the timeout period
+
+
+
+
N
+
+
Digital I/O trigger line (1 to 14)
+
+
+
+
timeout
+
+
Timeout in seconds
+
+
+
+
+
Details
+
This function pauses for up to timeout seconds for an input trigger. If one or more trigger events are detected since the last time digio.trigger[N].wait() or digio.trigger[N].clear() was called, this function returns a value immediately. After waiting for a trigger with this function, the event detector is automatically reset and ready to detect the next trigger. This is true regardless of the number of events detected.
+
Example
+
+
+
+
triggered = digio.trigger[4].wait(3)
+
print(triggered)
+
+
Waits up to three seconds for a trigger to be detected on trigger line 4, then outputs the results.
This function sets a digital I/O line high or low.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
digio.writebit(N, data)
+
+
+
+
N
+
+
Digital I/O trigger line (1 to 14)
+
+
+
+
data
+
+
The value to write to the bit:
+
0 (low)
Non‑zero (high)
+
+
+
+
Details
+
If the output line is write‑protected using the digio.writeprotect attribute, the command is ignored.
+
The reset() function does not affect the present state of the digital I/O lines.
+
Use the digio.writebit() and digio.writeport() commands to control the output state of the synchronization line when trigger operation is set to digio.TRIG_BYPASS.
+
The data must be zero (0) to clear the bit. Any value other than zero (0) sets the bit.
The binary representation of data indicates the output pattern to be written to the I/O port. For example, a data value of 170 has a binary equivalent of 00000010101010. Lines 2, 4, 6, and 8 are set high (1), and the other 10 lines are set low (0).
+
Write‑protected lines are not changed.
+
The reset() function does not affect the present states of the digital I/O lines.
+
Use the digio.writebit() and digio.writeport() commands to control the output state of the synchronization line when trigger operation is set to digio.TRIG_BYPASS.
+
Example
+
+
+
+
digio.writeport(255)
+
+
Sets digital I/O Lines 1 through 8 high (binary 00000011111111).
This attribute contains the write‑protect mask that protects bits from changes from the digio.writebit() and digio.writeport() functions.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset Recall setup
+
+
Saved setup
+
+
0
+
+
+
+
+
Usage
+
mask = digio.writeprotect
+
digio.writeprotect = mask
+
+
+
+
mask
+
+
Sets the value that specifies the bit pattern for write‑protect
+
+
+
+
+
Details
+
Bits that are set to one cause the corresponding line to be write‑protected.
+
The binary equivalent of mask indicates the mask to be set for the I/O port. For example, a mask value of 7 has a binary equivalent of 00000000000111. This mask write‑protects lines 1, 2, and 3.
This function switches to the user screen and then clears the display.
+
The display.clear(), display.setcursor(), and display.settext() functions are overlapped, nonblocking commands. That is, the script does not wait for one of these commands to complete. These nonblocking functions do not immediately update the display. For performance considerations, they update the physical display as soon as processing time becomes available.
This function reads the present position of the cursor on the front panel display.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
row, column, style = display.getcursor()
+
+
+
+
row
+
+
The row where the cursor is: 1 (top row); 2 (bottom row)
+
+
+
+
column
+
+
The column where the cursor is:
+
If the cursor is in the top row: 1 to 20
If the cursor is in the bottom row: 1 to 32
+
+
+
style
+
+
Visibility of the cursor: 0 (invisible cursor); 1 (blinking cursor)
+
+
+
+
+
Details
+
This function switches the display to the user screen (the text set by display.settext()), and then returns values to indicate the cursor's row and column position and cursor style.
+
Columns are numbered from left to right on the display.
+
Example 1
+
+
+
+
testRow, testColumn = display.getcursor()
+
print(testRow, testColumn)
+
+
This example reads the cursor position into local variables and prints them. Example output:
+
1.00000e+00 1.00000e+00
+
+
+
+
+
Example 2
+
+
+
+
print(display.getcursor())
+
+
This example prints the cursor position directly. In this example, the cursor is in row 1 at column 3, with an invisible cursor:
This function reads the text displayed on the instrument front panel.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
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)
+
+
+
+
text
+
+
The returned value, which contains the text that is presently displayed
+
+
+
+
embellished
+
+
Indicates type of returned text: false (simple text); true (text with embedded character codes)
+
+
+
+
row
+
+
Selects the row from which to read the text: 1 (row 1); 2 (row 2). If row is not included, both rows of text are read
+
+
+
+
columnStart
+
+
Selects the first column from which to read text; for row 1, the valid column numbers are 1 to 20; for row 2, the valid column numbers are 1 to 32; if nothing is selected, 1 is used
+
+
+
+
columnEnd
+
+
Selects the last column from which to read text; for row 1, the valid column numbers are 1 to 20; for row 2, the valid column numbers are 1 to 32; the default is 20 for row 1, and 32 for row 2
+
+
+
+
+
Details
+
Using the command without any parameters returns both lines of the display.
+
The $N character code is included in the returned value to show where the top line ends and the bottom line begins. This is not affected by the value of embellished.
+
When embellished is set to true, all other character codes are returned along with the message. When embellished is set to false, only the message and the $N character code is returned. For information on the embedded character codes, see display.settext().
+
The display is not switched to the user screen (the screen set using display.settext()). Text will be read from the active screen.
A string that defines how the input field is formatted; see Details for more information
+
+
+
+
default
+
+
The default value for the input value
+
+
+
+
minimum
+
+
The minimum input value
+
+
+
+
maximum
+
+
The maximum input value
+
+
+
+
+
Details
+
The format parameter uses zeros (0), the decimal point, polarity sign, and exponents to define how the input field is formatted. The format parameter can include the options shown in the following table.
+
+
+
+
Option
+
+
Description
+
+
Examples
+
+
+
+
E
+
+
Include the E to display the value exponentially
+
+
0.00000e+0
+
+
+
+
+
+
+
Allows operators to enter positive or negative values; if the "+" sign is not included, the operator cannot enter a negative value
+
+
+0.00
+
+
+
+
0
+
+
Defines the digit positions for the value; you can use up to six zeros (0)
+
+
+00.0000e+00
+
+
+
+
.
+
+
Include to have a decimal point appear in the value
+
+
+0.00
+
+
+
+
+
The default parameter is the value shown when the value is first displayed.
+
The minimum and maximum parameters can be used to limit the values that can be entered. When + is not selected for format, the minimum limit must be more than or equal to zero (0). When limits are used, you cannot enter values above or below these limits.
+
The input value is limited to ±1e37.
+
Before calling display.inputvalue(), you should send a message prompt to the operator using display.prompt(). Make sure to position the cursor where the edit field should appear.
+
After this command is sent, script execution pauses until you enter a value and press the ENTER key.
+
For positive and negative entry (plus sign (+) used for the value field and/or the exponent field), polarity of a nonzero value or exponent can be toggled by positioning the cursor on the polarity sign and turning the navigation wheel . Polarity will also toggle when using the navigation wheel to decrease or increase the value or exponent past zero. A zero (0) value or exponent (for example, +00) is always positive and cannot be toggled to negative polarity.
+
After executing this command and pressing the EXIT (LOCAL) key, the function returns nil.
+
Example
+
+
+
+
display.clear()
+
display.settext("Enter value between$N -0.10 and 2.00: ")
+
value = display.inputvalue("+0.00", 0.5, -0.1, 2.0)
+
print("Value entered = ", value)
+
+
+
+
+
Displays an editable field (+0.50) for operator input. The valid input range is -0.10 to +2.00, with a default of 0.50.
This function presents a menu on the front panel display.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
selection = display.menu(name, items)
+
+
+
+
selection
+
+
Name of the variable that holds the menu item selected
+
+
+
+
name
+
+
Menu name to display on the top line
+
+
+
+
items
+
+
Menu items to display on the bottom line
+
+
+
+
+
Details
+
The menu consists of the menu name string on the top line, and a selectable list of items on the bottom line. The menu items must be a single string with each item separated by whitespace. The name for the top line is limited to 20 characters.
+
After sending this command, script execution pauses for the operator to select a menu item. An item is selected by rotating the navigation wheel to place the blinking cursor on the item, and then pressing the navigation wheel (or the ENTER key). When an item is selected, the text of that selection is returned.
+
Pressing the EXIT (LOCAL) keywill not abort the script while the menu is displayed, but it will return nil. The script can be aborted by calling the exit function when nil is returned.
The active column position to set; row 1 has columns 1 to 20, row 2 has columns 1 to 32
+
+
+
+
style
+
+
Set the cursor to invisible (0, default) or blinking (1)
+
+
+
+
+
Details
+
Sending this command selects the user screen and then moves the cursor to the given location.
+
The display.clear(), display.setcursor(), and display.settext() functions are overlapped, nonblocking commands. That is, the script does not wait for one of these commands to complete. These nonblocking functions do not immediately update the display. For performance considerations, they update the physical display as soon as processing time becomes available.
+
An out‑of-range parameter for row sets the cursor to row 2. An out‑of‑range parameter for column sets the cursor to column 20 for row 1, or 32 for row 2.
+
An out‑of‑range parameter for style sets it to 0 (invisible).
+
A blinking cursor is only visible when it is positioned over displayed text. It cannot be seen when positioned over a space character.
+
Example
+
+
+
+
display.clear()
+
display.setcursor(1, 8)
+
display.settext("Hello")
+
display.setcursor(2, 14)
+
display.settext("World")
+
+
This example displays a message on the instrument front panel, approximately center. Note that the top line of text is larger than the bottom line of text.
+
The front panel of the instrument displays "Hello" on the top line and "World" on the second line.
Text message to be displayed, with optional character codes
+
+
+
+
+
Details
+
This function selects the user display screen and displays the given text.
+
After the instrument is turned on, the first time you use a display command to write to the display, the message "User Screen" is cleared. After the first write, you need to use display.clear() to clear the message.
+
The display.clear(), display.setcursor(), and display.settext() functions are overlapped, nonblocking commands. That is, the script does not wait for one of these commands to complete. These nonblocking functions do not immediately update the display. For performance considerations, they update the physical display as soon as processing time becomes available.
+
The text starts at the present cursor position. After the text is displayed, the cursor is after the last character in the display message.
+
Top line text does not wrap to the bottom line of the display automatically. Any text that does not fit on the current line is truncated. If the text is truncated, the cursor remains 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:
+
+
+
+
+
+
+
+
Display character codes
+
+
+
+
Character Code
+
+
Description
+
+
+
+
$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 intensity, nonblinking
+
+
+
+
$B
+
+
Sets text to blink
+
+
+
+
$D
+
+
Sets text to dim intensity
+
+
+
+
$F
+
+
Sets the text to background blink
+
+
+
+
$$
+
+
Escape sequence to display a single dollar symbol ($)
This function clears the front‑panel trigger event detector.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
display.trigger.clear()
+
Details
+
The trigger event detector remembers if an event has been detected since the last display.trigger.wait() call. This function clears the trigger’s event detector and discards the previous history of TRIG key presses.
+
This attribute also clears the display.trigger.overrun attribute.
This function waits for the TRIG key on the front panel to be pressed.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
triggered = display.trigger.wait(timeout)
+
+
+
+
triggered
+
+
true: Trigger was detected
+
false: The operation timed out
+
+
+
+
timeout
+
+
Timeout in seconds
+
+
+
+
+
Details
+
If the trigger key was previously pressed and one or more trigger events were detected, this function returns immediately.
+
After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.
+
Use the display.trigger.clear() call to clear the trigger event detector.
+
Example
+
+
+
+
triggered = display.trigger.wait(5)
+
print(triggered)
+
+
Waits up to five seconds for the TRIG key to be pressed. If TRIG is pressed within five seconds, the output is true. If not, the output is false.
This function reads the annunciators (indicators) that are presently turned on.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
annunciators = display.getannunciators()
+
+
+
+
annunciators
+
+
The bitmasked value that shows which indicators are turned on
+
+
+
+
+
Details
+
This function returns a bitmasked value showing which indicators are turned on. The 16‑bit binary equivalent of the returned value is the bitmask. The return value is a sum of set annunciators, based on the weighted value, as shown in the following table.
+
+
+
+
+
+
+
+
+
+
Annunciator (indicator) bitmasked values and equivalent constants
Indicates if a trigger event was ignored because the event detector was already in the detected state when the TRIG button was pressed.
+
Indicates the overrun state of the event detector built into the display.
+
This attribute does not indicate whether an overrun occurred in any other part of the trigger model or in any other detector that is monitoring the event.
+
Example
+
+
+
+
overrun = display.trigger.overrun
+
+
Sets the variable overrun equal to the present state of the event detector built into the display.
A string that defines how the input field is formatted; see Details for more information
+
+
+
+
units
+
+
Set the units text string for the top line (eight characters maximum); this indicates the units (for example, "V" or "A") for the value
+
+
+
+
help
+
+
Text string to display on the bottom line (32 characters maximum)
+
+
+
+
default
+
+
The value that is shown when the value is first displayed
+
+
+
+
minimum
+
+
The minimum input value that can be entered
+
+
+
+
maximum
+
+
The maximum input value that can be entered (must be more than minimum)
+
+
+
+
+
Details
+
This function creates 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 parameter uses zeros (0), the decimal point, polarity sign, and exponents to define how the input field is formatted.
+
The format parameter can include the options shown in the following table.
+
+
+
+
Option
+
+
Description
+
+
Examples
+
+
+
+
E
+
+
Include the E to display the value exponentially. Include a plus sign (+) for positive/negative exponent entry. Do not include the plus sign (+) to prevent negative value entry. 0 defines the digit positions for the exponent.
+
+
+
0.00000E+0
+
+
+
+
+
+
+
Allows operators to enter positive or negative values. If the plus sign (+) is not included, the operator cannot enter a negative value.
+
+
+0.00
+
+
+
+
0
+
+
Defines the digit positions for the value. You can use up to six zeros (0).
+
+
+00.0000E+00
+
+
+
+
.
+
+
The decimal point where needed for the value.
+
+
+0.00
+
+
+
+
+
The minimum and maximum parameters can be used to limit the values that can be entered. When a plus sign (+) is not selected for format, the minimum limit must be greater than or equal to zero (0). When limits are used, the operator cannot enter values above or below these limits.
+
The input value is limited to ±1e37.
+
After sending this command, script execution pauses for the operator to enter a value and press ENTER.
+
For positive and negative entry (plus sign (+) used for the value field and the exponent field), polarity of a nonzero value or exponent can be toggled by positioning the cursor on the polarity sign and turning the navigation wheel . Polarity will also toggle when using the navigation wheel to decrease or increase the value or exponent past zero. A zero value or exponent (for example, +00) is always positive and cannot be toggled to negative polarity.
+
After executing this command and pressing the EXIT (LOCAL) key, the value returns nil.
+
Example
+
+
+
+
value = display.prompt("0.00", "V", "Input 0 to +2V", 0.5, 0, 2)
+
print(value)
+
+
+
+
The above command prompts the operator to enter a voltage value. The valid input range is 0 to +2.00, with a default of 0.50:
This attribute contains the selected display screen.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset Recall setup
+
+
Saved setup
+
+
0 (display.SMUA)
+
+
+
+
+
Usage
+
displayID = display.screen
+
display.screen = displayID
+
+
+
+
displayID
+
+
One of the following values:
+
0 or display.SMUA: Displays source-measure and compliance limit
3 or display.USER: Displays the user screen
+
+
+
+
Details
+
Setting this attribute selects the display screen for the front panel. This performs the same action as pressing the DISPLAY key on the front panel. The text for the display screen is set by display.settext().
+
Read this attribute to determine which of the available display screens was last selected.
+
Example
+
+
+
+
display.screen = display.SMUA
+
+
Selects the source-measure and compliance limit display for the SMU.
When errors and events occur, the error and status messages are placed in the error queue. Use the error queue commands to request error and status message information.
This function returns all entries from the event log as a single string and removes them from the event log.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
logString = eventlog.all()
+
+
+
+
logString
+
+
A listing of all event log entries
+
+
+
+
+
Details
+
This function returns all events in the event log. Logged items are shown from oldest to newest. The response is a string that has the messages delimited with a new line character.
+
This function also clears the event log.
+
If there are no entries in the event log, this function returns the value nil.
+
Example
+
+
+
+
print(eventlog.all())
+
+
+
+
Get and print all entries from the event log and remove the entries from the log.
This function stops a script that is presently running.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
exit()
+
Details
+
Terminates script execution when called from a script that is being executed.
+
This command does not wait for overlapped commands to complete before terminating script execution. If overlapped commands are required to finish, use the waitcomplete() function before calling exit().
You can use the file I/O commands to open and close directories and files, write data, or to read a file on an installed USB flash drive. File I/O commands are organized into two groups:
+
Commands that reside in the fs and io table, for example: io.open(), io.close(), io.input(), and io.output(). Use these commands to manage file system directories; open and close file descriptors; and perform basic I/O operations on a pair of default files (one input and one output).
Commands that reside in the file descriptors (for example: fileVar:seek(), fileVar:write(), and fileVar:read()) operate exclusively on the file with which they are associated.
The root folder of the USB flash drive has the absolute path:
+
"/usb1/"
+
Both slash (/) and backslash (\) are supported as directory separators.
+
For basic information about navigation and directory listing of files on a flash drive, see File system navigation.
+
File descriptor commands for file I/O use a colon (:) to separate the command parts rather than a period (.), like the io commands.
+
File descriptors cannot be passed between nodes in a TSP-Link® system, so the io.open(), fileVar::read(), and fileVar::write commands are not accessible to the TSP-Link system. However, the default input and output files mentioned above allow for the execution of many file I/O operations without any reference to a file descriptor.
The fileVar:write() or io.write() functions buffer data, which may not be written immediately to the USB flash drive. Use this function to flush this data. Using this function removes the need to close a file after writing to it, allowing it to be left open to write more data. Data may be lost if the file is not closed or flushed before a script ends.
+
If there is going to be a time delay before more data is written to a file, and you want to keep the file open, flush the file after you write to it to prevent loss of data.
You can use the print(), printbuffer(), and printnumber() functions to query the instrument and generate response messages. The format attributes control how the data is formatted for the print functions used.
+
The localnode commands determine if generated errors are automatically sent and if prompts are generated.
This attribute sets the precision (number of digits) for all numbers printed with the ASCII format.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
No
+
+
Instrument reset Recall setup
+
+
Not saved
+
+
6
+
+
+
+
+
Usage
+
precision = format.asciiprecision
+
format.asciiprecision = precision
+
+
+
+
precision
+
+
A number representing the number of digits to be printed for numbers printed with the print(), printbuffer(), and printnumber() functions; must be a number between 1 and 16
+
+
+
+
+
Details
+
This attribute specifies the precision (number of digits) for numeric data printed with the print(), printbuffer(), and printnumber() functions. The format.asciiprecision attribute is only used with the ASCII format. The precision value must be a number between 1 and 16.
+
Note that the precision is the number of significant digits printed. There is always one digit to the left of the decimal point; be sure to include this digit when setting the precision.
This attribute sets the binary byte order for data printed using the printnumber() and printbuffer() functions.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset Recall setup
+
+
Not saved
+
+
1 (format.LITTLEENDIAN)
+
+
+
+
+
Usage
+
order= format.byteorder
+
format.byteorder = order
+
+
+
+
order
+
+
Byte order value as follows:
+
Most significant byte first: 0, format.NORMAL, format.NETWORK, or format.BIGENDIAN
Least significant byte first: 1, format.SWAPPED or format.LITTLEENDIAN
+
+
+
+
Details
+
This attribute selects the byte order in which data is written when printing data values with the printnumber() and printbuffer() functions. The byte order attribute is only used with the format.SREAL, format.REAL, format.REAL32, and format.REAL64 data formats.
+
format.NORMAL, format.BIGENDIAN, and format.NETWORK select the same byte order. format.SWAPPED and format.LITTLEENDIAN select the same byte order. Selecting which to use is a matter of preference.
+
Select the format.SWAPPED or format.LITTLEENDIAN byte order when sending data to a computer with a Microsoft Windows operating system.
+
Example
+
+
+
+
x = 1.23
+
format.data = format.REAL32
+
format.byteorder = format.LITTLEENDIAN
+
printnumber(x)
+
format.byteorder = format.BIGENDIAN
+
printnumber(x)
+
+
Output depends on the terminal program you use, but will look something like:
The precision of numeric values can be controlled with the format.asciiprecision attribute. The byte order of format.SREAL, format.REAL, format.REAL32, and format.REAL64 can be selected with the format.byteorder attribute.
+
REAL32 and SREAL select the same single precision format. REAL and REAL64 select the same double precision format. They are alternative identifiers. Selecting which to use is a matter of preference.
+
The IEEE Std 754 binary formats use four bytes each for single‑precision values and eight bytes each for double‑precision values.
+
When data is written with any of the binary formats, the response message starts with “#0” and ends with a new line. When data is written with the ASCII format, elements are separated with a comma and space.
+
Binary formats are not intended to be interpreted by humans.
+
Example
+
+
+
+
format.asciiprecision = 10
+
x = 3.14159265
+
format.data = format.ASCII
+
printnumber(x)
+
format.data = format.REAL64
+
printnumber(x)
+
+
Output a number represented by x in ASCII using a precision of 10, then output the same number in binary using double precision format.
This function creates a directory at the specified path.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
path = fs.mkdir(newPath)
+
+
+
+
path
+
+
The returned path of the new directory
+
+
+
+
newpath
+
+
Location (path) of where to create the new directory
+
+
+
+
+
Details
+
The directory path may be absolute or relative to the current working directory.
+
An error is logged to the error queue if the parent folder of the new directory does not exist, or if a file system entry already exists at the given path.
A new GPIB address takes effect when the command to change it is processed. If there are response messages in the output queue when this command is processed, they must be read at the new address.
+
If command messages are being queued (sent before this command has executed), the new settings may take effect in the middle of a subsequent command message, so care should be exercised when setting this attribute from the GPIB interface.
+
You should allow ample time for the command to be processed before attempting to communicate with the instrument again. After sending this command, make sure to use the new address to communicate with the instrument.
+
The GPIB address is stored in nonvolatile memory. The reset() function has no effect on the address.
You must use the io.flush() or io.close() functions to write data to the file system.
+
Data is not automatically written to a file when you use the io.write() function. The io.write() function buffers data; it may not be written to the USB drive immediately. Use the io.flush() function to immediately write buffered data to the drive.
+
This function only flushes the default output file.
+
Using this command removes the need to close a file after writing to it and allows it to be left open to write more data. Data may be lost if the file is not closed or flushed before an application ends. To prevent the loss of data if there is going to be a time delay before more data is written (and when you want to keep the file open and not close it), flush the file after writing to it.
Indicates whether an error was encountered while processing the function
+
+
+
+
path
+
+
The path of the file to open
+
+
+
+
mode
+
+
A string representing the intended access mode ("r" = read, "w" = write, and "a" = append)
+
+
+
+
+
Details
+
The path to the file to open may be absolute or relative to the current working directory. If you successfully open the file, errorMsg is nil and fileVar has the descriptor that can be used to access the file.
+
If an error is encountered, the command returns nil for fileVar and an error string.
This function writes data to the default output file.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
io.write()
+
io.write(data1)
+
io.write(data1, data2)
+
io.write(data1, ..., dataN)
+
+
+
+
data1
+
+
The data to be written
+
+
+
+
data2
+
+
The data to be written
+
+
+
+
dataN
+
+
The data to be written
+
+
+
+
...
+
+
One or more values separated by commas
+
+
+
+
+
Details
+
All data parameters must be either strings or numbers.
+
Data is not immediately written to a file when you use the io.write() function. The io.write() function buffers data; it may not be written to the USB drive immediately. Use the io.flush() function to immediately write buffered data to the drive.
This function re-initializes the LAN interface with new settings.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
lan.applysettings()
+
Details
+
Disconnects all existing LAN connections to the instrument and re-initializes the LAN with the current configuration settings.
+
This function initiates a background operation. LAN configuration could be a lengthy operation. Although the function returns immediately, the LAN initialization will continue to run in the background.
+
Even though the LAN configuration settings may not have changed since the LAN was last connected, new settings may take effect due to the dynamic nature of dynamic host configuration protocol (DHCP) or dynamic link local addressing (DLLA) configuration.
+
Re-initialization takes effect even if the configuration has not changed since the last time the instrument connected to the LAN.
+
Example
+
+
+
+
lan.applysettings()
+
+
Re-initialize the LAN interface with new settings.
+
+
+
+
+
Also see
+
None
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This function resets LAN settings to default values.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
lan.restoredefaults()
+
Details
+
The settings that are restored are shown in the following table.
+
+
+
+
+
+
+
Settings that are restored to default
+
+
+
+
Attribute
+
+
Default setting
+
+
+
+
lan.autoconnect
+
+
lan.ENABLE
+
+
+
+
lan.config.dns.address[N]
+
+
"0.0.0.0"
+
+
+
+
lan.config.dns.domain
+
+
""
+
+
+
+
lan.config.dns.dynamic
+
+
lan.ENABLE
+
+
+
+
lan.config.dns.verify
+
+
lan.ENABLE
+
+
+
+
lan.config.duplex
+
+
lan.FULL
+
+
+
+
lan.config.gateway
+
+
"0.0.0.0"
+
+
+
+
lan.config.ipaddress
+
+
"192.168.0.2"
+
+
+
+
lan.config.method
+
+
lan.AUTO
+
+
+
+
lan.config.speed
+
+
100
+
+
+
+
lan.config.subnetmask
+
+
"255.255.255.0"
+
+
+
+
lan.linktimeout
+
+
20 (seconds)
+
+
+
+
lan.lxidomain
+
+
0
+
+
+
+
lan.nagle
+
+
lan.DISABLE
+
+
+
+
lan.timedwait
+
+
20 (seconds)
+
+
+
+
+
The lan.restoredefaults() function does not reset the LAN password. The localnode.password attribute controls the web password, which can be reset separately.
This attribute contains the LAN timed-wait state interval.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
LAN restore defaults
+
+
Nonvolatile memory
+
+
20 (20 s)
+
+
+
+
+
Usage
+
timeout = lan.timedwait
+
lan.timedwait = timeout
+
+
+
+
timeout
+
+
The LAN timed-wait state interval in seconds
+
+
+
+
+
Details
+
This attribute controls the amount of time that resources are allocated to closed TCP connections. When a TCP connection is closed, the connection is put in a timed-wait state and resources remain allocated for the connection until the timed-wait state ends. During the timed-wait interval, the instrument processes delayed packets that arrive after the connection is closed.
+
Use this attribute to tailor the timed-wait state interval for the instrument.
This attribute is an array of DNS (domain name system) server addresses. These addresses take priority for DNS lookups and are consulted before any server addresses that are obtained using DHCP. This allows local DNS servers to be specified that take priority over DHCP‑configured global DNS servers.
+
You can specify up to two addresses. The address specified by 1 is consulted first for DNS lookups.
+
Unused entries will be returned as "0.0.0.0" when read. dnsAddress must be a string specifying the DNS server’s IP address in dotted decimal notation. To disable an entry, set its value to "0.0.0.0" or the empty string "".
+
Although only two address may be manually specified here, the instrument will use up to three DNS server addresses. If two are specified here, only one that is given by a DHCP server is used. If no entries are specified here, up to three addresses that are given by a DHCP server are used.
Dynamic DNS registration domain; use a string of 255 characters or less
+
+
+
+
+
Details
+
This attribute holds the domain to request during dynamic DNS registration. Dynamic DNS registration works with DHCP to register the domain specified in this attribute with the DNS server.
+
The length of the fully qualified host name (combined length of the domain and host name with separator characters) must be less than or equal to 255 characters. Although up to 255 characters are allowed, you must make sure the combined length is also no more than 255 characters.
+
Example
+
+
+
+
print(lan.config.dns.domain)
+
+
Outputs the present dynamic DNS domain. For example, if the domain is "Matrix", the response would be:
The dynamic DNS registration state. It may be one of the following values:
+
1 or lan.ENABLE: Enabled 0 or lan.DISABLE: Disabled
+
+
+
+
+
Details
+
Dynamic DNS registration works with DHCP to register the host name with the DNS server. The host name is specified in the lan.config.dns.hostname attribute.
+
Example
+
+
+
+
print(lan.config.dns.dynamic)
+
+
Outputs the dynamic registration state.
+
+
If dynamic DNS registration is enabled, the response is:
The host name to use for dynamic DNS registration; the host name must:
+
be a string of 15 characters or less
start with a letter
end with a letter or digit
contain only letters, digits, and hyphens
+
+
+
+
Details
+
This attribute holds the host name to request during dynamic DNS registration. Dynamic DNS registration works with DHCP to register the host name specified in this attribute with the DNS server.
+
The factory default value for hostName is "k‑<model number>‑<serial number>", where <model number> and <serial number> are replaced with the actual model number and serial number of the instrument (for example, "k‑2657A‑1234567"). Note that hyphens separate the characters of hostName.
+
The length of the fully qualified host name (combined length of the domain and host name with separator characters) must be less than or equal to 255 characters. Although up to 15 characters can be entered here, care must be taken to be sure the combined length is no more than 255 characters.
+
Setting this attribute to an empty string (in other words, setting this attribute to a string of length zero, or one consisting entirely of whitespace characters) will revert the host name to the factory default value.
LAN duplex setting can be one of the following values:
+
1 or lan.FULL: Selects full-duplex operation 0 or lan.HALF: Selects half-duplex operation
+
+
+
+
+
Details
+
This attribute does not indicate the actual setting currently in effect. Use the lan.status.duplex attribute to determine the current operating state of the LAN.
This attribute contains the LAN default gateway address.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
LAN restore defaults
+
+
Nonvolatile memory
+
+
"0.0.0.0"
+
+
+
+
+
Usage
+
gatewayAddress = lan.config.gateway
+
lan.config.gateway = gatewayAddress
+
+
+
+
gatewayAddress
+
+
LAN default gateway address; must be a string specifying the default gateway’s IP address in dotted decimal notation
+
+
+
+
+
Details
+
This attribute specifies the default gateway IP address to use when manual or DLLA configuration methods are used to configure the LAN. If DHCP is enabled, this setting is ignored.
+
This attribute does not indicate the actual setting currently in effect. Use the lan.status.gateway attribute to determine the current operating state of the LAN.
+
The IP address must be formatted in four groups of numbers each separated by a decimal.
+
Example
+
+
+
+
print(lan.config.gateway)
+
+
Outputs the default gateway address. For example, you might see the output:
LAN IP address; must be a string specifying the IP address in dotted decimal notation
+
+
+
+
+
Details
+
This attribute specifies the LAN IP address to use when the LAN is configured using the manual configuration method. This setting is ignored when DLLA or DHCP is used.
+
This attribute does not indicate the actual setting currently in effect. Use the lan.status.ipaddress attribute to determine the current operating state of the LAN.
This attribute contains the LAN settings configuration method.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
LAN restore defaults
+
+
Nonvolatile memory
+
+
0 (lan.AUTO)
+
+
+
+
+
Usage
+
method = lan.config.method
+
lan.config.method = method
+
+
+
+
method
+
+
The method for configuring LAN settings; it can be one of the following values:
+
0 or lan.AUTO: Selects automatic sequencing of configuration methods
+
1 or lan.MANUAL: Use only manually specified configuration settings
+
+
+
+
+
Details
+
This attribute controls how the LAN IP address, subnet mask, default gateway address, and DNS server addresses are determined.
+
When method is lan.AUTO, the instrument first attempts to configure the LAN settings using dynamic host configuration protocol (DHCP). If DHCP fails, it tries dynamic link local addressing (DLLA). If DLLA fails, it uses the manually specified settings.
+
When method is lan.MANUAL, only the manually specified settings are used. Neither DHCP nor DLLA are attempted.
This attribute contains the LAN speed used when restarting in manual configuration mode.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
LAN restore defaults
+
+
Nonvolatile memory
+
+
100 (100 Mbps)
+
+
+
+
+
Usage
+
speed = lan.config.speed
+
lan.config.speed = speed
+
+
+
+
speed
+
+
LAN speed setting in Mbps (10 or 100)
+
+
+
+
+
Details
+
This attribute does not indicate the actual setting currently in effect. Use the lan.status.speed attribute to determine the current operating state of the LAN.
+
This attribute stores the speed that will be used if the LAN is restarted for manual configuration operation.
+
The LAN speed is measured in megabits per second (Mbps).
LAN subnet mask value string that specifies the subnet mask in dotted decimal notation
+
+
+
+
+
Details
+
This attribute specifies the LAN subnet mask to use when the manual configuration method is used to configure the LAN. This setting is ignored when DLLA or DHCP is used.
+
This attribute does not indicate the actual setting currently in effect. Use the lan.status.subnetmask attribute to determine the current operating state of the LAN.
This attribute contains the DNS server IP addresses.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Not applicable
+
+
Not applicable
+
+
Not applicable
+
+
+
+
+
Usage
+
dnsAddress = lan.status.dns.address[N]
+
+
+
+
dnsAddress
+
+
DNS server IP address
+
+
+
+
N
+
+
Entry index (1, 2, or 3)
+
+
+
+
+
Details
+
This attribute is an array of DNS server addresses. The instrument can use up to three addresses.
+
Unused or disabled entries are returned as "0.0.0.0" when read. The dnsAddress returned is a string specifying the IP address of the DNS server in dotted decimal notation.
+
You can only specify two addresses manually. However, the instrument uses up to three DNS server addresses. If two are specified, only the one given by a DHCP server is used. If no entries are specified, up to three address given by a DHCP server are used.
+
The value of lan.status.dns.address[1] is referenced first for all DNS lookups. The values of lan.status.dns.address[2] and lan.status.dns.address[3] are referenced second and third, respectively.
This attribute contains the present DNS fully qualified host name.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Not applicable
+
+
Not applicable
+
+
Not applicable
+
+
+
+
+
Usage
+
hostName = lan.status.dns.name
+
+
+
+
hostName
+
+
Fully qualified DNS host name that can be used to connect to the instrument
+
+
+
+
+
Details
+
A fully qualified domain name (FQDN), sometimes referred to as an absolute domain name, is a domain name that specifies its exact location in the tree hierarchy of the Domain Name System (DNS).
+
A FQDN is the complete domain name for a specific computer or host on the LAN. The FQDN consists of two parts: the host name and the domain name.
+
If the DNS host name for an instrument is not found, this attribute stores the IP address in dotted decimal notation.
The MAC address is a character string representing the instrument's MAC address in hexadecimal notation. The string includes colons that separate the address octets (see Example).
+
Example
+
+
+
+
print(lan.status.macaddress)
+
+
Outputs the MAC address of the instrument, for example:
+
00:60:1A:00:00:57
+
+
+
+
+
Also see
+
None
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This attribute contains the LAN subnet mask that is presently in use by the LAN interface.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Not applicable
+
+
Not applicable
+
+
Not applicable
+
+
+
+
+
Usage
+
mask = lan.status.subnetmask
+
+
+
+
mask
+
+
A string specifying the subnet mask in dotted decimal notation
+
+
+
+
+
Details
+
Use this attribute to determine the present operating state of the LAN. This attribute will return the present LAN subnet mask value if the LAN is manually configured, or when DLLA or DHCP is used.
+
Example
+
+
+
+
print(lan.status.subnetmask)
+
+
Outputs the subnet mask of the instrument that is presently in use, such as:
This function clears the event detector for a trigger.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
lan.trigger[N].clear()
+
+
+
+
N
+
+
The LAN event number to clear (1 to 8)
+
+
+
+
+
Details
+
A trigger’s event detector remembers if an event has been detected since the last call. This function clears a trigger’s event detector and discards the previous history of the trigger packet.
+
This function clears all overruns associated with this LAN trigger.
This function prepares the event generator for outgoing trigger events.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
lan.trigger[N].connect()
+
+
+
+
N
+
+
The LAN event number (1 to 8)
+
+
+
+
+
Details
+
Prepares the event generator to send event messages. For TCP connections, this opens the TCP connection.
+
The event generator automatically disconnects when either the lan.trigger[N].protocol or lan.trigger[N].ipaddress attributes for this event are changed.
+
Example
+
+
+
+
lan.trigger[1].protocol = lan.MULTICAST
+
lan.trigger[1].connect()
+
lan.trigger[1].assert()
+
+
Set the protocol for LAN trigger 1 to be multicast when sending LAN triggers. Then, after connecting the LAN trigger, send a message on LAN trigger 1 by asserting it.
This attribute stores the LAN event connection state.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Not applicable
+
+
Not applicable
+
+
Not applicable
+
+
+
+
+
Usage
+
connected = lan.trigger[N].connected
+
+
+
+
connected
+
+
The LAN event connection state:
+
true: Connected
false: Not connected
+
+
+
N
+
+
The LAN event number (1 to 8)
+
+
+
+
+
Details
+
This read-only attribute is set to true when the LAN trigger is connected and ready to send trigger events following a successful lan.trigger[N].connect() command; if the LAN trigger is not ready to send trigger events, this value is false.
+
This attribute is also false when either lan.trigger[N].protocol or lan.trigger[N].ipaddress attributes are changed or the remote connection closes the connection.
+
Example
+
+
+
+
lan.trigger[1].protocol = lan.MULTICAST
+
print(lan.trigger[1].connected)
+
+
Outputs true if connected, or false if not connected.
This attribute sets the trigger operation and detection mode.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset LAN trigger N reset Recall setup
+
+
Not saved
+
+
0 (lan.TRIG_EITHER)
+
+
+
+
+
Usage
+
mode = lan.trigger[N].mode
+
lan.trigger[N].mode = mode
+
+
+
+
mode
+
+
A number representing the trigger mode (0 to 7); see the Details section for more information
+
+
+
+
N
+
+
A number representing the LAN event number (1 to 8)
+
+
+
+
+
Details
+
This attribute controls the mode in which the trigger event detector and the output trigger generator operate on the given trigger. These settings are intended to provide behavior similar to the digital I/O triggers.
+
+
+
+
+
+
+
+
+
Lan trigger mode values
+
+
+
+
Mode
+
+
Number
+
+
Trigger packets detected as input
+
+
LAN trigger packet generated for output with a…
+
+
+
+
lan.TRIG_EITHER
+
+
0
+
+
Rising or falling edge (positive or negative state)
+
+
negative state
+
+
+
+
lan.TRIG_FALLING
+
+
1
+
+
Falling edge (negative state)
+
+
negative state
+
+
+
+
lan.TRIG_RISING
+
+
2
+
+
Rising edge (positive state)
+
+
positive state
+
+
+
+
lan.TRIG_RISINGA
+
+
3
+
+
Rising edge (positive state)
+
+
positive state
+
+
+
+
lan.TRIG_RISINGM
+
+
4
+
+
Rising edge (positive state)
+
+
positive state
+
+
+
+
lan.TRIG_SYNCHRONOUS
+
+
5
+
+
Falling edge (negative state)
+
+
positive state
+
+
+
+
lan.TRIG_SYNCHRONOUSA
+
+
6
+
+
Falling edge (negative state)
+
+
positive state
+
+
+
+
lan.TRIG_SYNCHRONOUSM
+
+
7
+
+
Rising edge (positive state)
+
+
negative state
+
+
+
+
+
lan.TRIG_RISING and lan.TRIG_RISINGA are the same.
+
lan.TRIG_RISING and lan.TRIG_RISINGM are the same.
+
Use of either lan.TRIG_SYNCHRONOUSA or lan.TRIG_SYNCHRONOUSM over lan.TRIG_SYNCHRONOUS is preferred, as lan.TRIG_SYNCHRONOUS is provided for compatibility with other Keithley Instruments products.
+
Example
+
+
+
+
print(lan.trigger[1].mode)
+
+
Outputs the present LAN trigger mode of LAN event 1.
This attribute contains the event detector's overrun status.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
LAN trigger N clear LAN trigger N reset Instrument reset Recall setup
+
+
Not applicable
+
+
Not applicable
+
+
+
+
+
Usage
+
overrun = lan.trigger[N].overrun
+
+
+
+
overrun
+
+
The trigger overrun state for the specified LAN packet (true or false)
+
+
+
+
N
+
+
A number representing the LAN event number (1 to 8)
+
+
+
+
+
Details
+
This attribute indicates whether an event has been ignored because the event detector was already in the detected state when the event occurred.
+
This is an indication of the state of the event detector built into the synchronization line itself. It does not indicate if an overrun occurred in any other part of the trigger model, or in any other construct that is monitoring the event.
+
It also is not an indication of an output trigger overrun. Output trigger overrun indications are provided in the status model.
+
Example
+
+
+
+
overrun = lan.trigger[5].overrun
+
print(overrun)
+
+
Checks the overrun status of a trigger on LAN5 and outputs the value, such as:
This attribute sets the LAN protocol to use for sending trigger messages.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset LAN trigger N reset Recall setup
+
+
Not saved
+
+
0 (lan.TCP)
+
+
+
+
+
Usage
+
protocol = lan.trigger[N].protocol
+
lan.trigger[N].protocol = protocol
+
+
+
+
protocol
+
+
The protocol to use for the trigger's messages:
+
0 or lan.TCP
1 or lan.UDP
2 or lan.MULTICAST
+
+
+
N
+
+
A number representing the LAN event number (1 to 8)
+
+
+
+
+
Details
+
The LAN trigger listens for trigger messages on all supported protocols, but uses the designated protocol for sending outgoing messages. After changing this setting, lan.trigger[N].connect() must be called before outgoing event messages can be sent.
+
When the lan.MULTICAST protocol is selected, the lan.trigger[N].ipaddress attribute is ignored and event messages are sent to the multicast address 224.0.23.159.
+
Example
+
+
+
+
print(lan.trigger[1].protocol)
+
+
Get LAN protocol to use for sending trigger messages for LAN event 1.
Maximum amount of time in seconds to wait for the trigger event
+
+
+
+
+
Details
+
If one or more trigger events have been detected since the last time lan.trigger[N].wait() or lan.trigger[N].clear() was called, this function returns immediately.
+
After waiting for a LAN trigger event with this function, the event detector is automatically reset and rearmed regardless of the number of events detected.
+
Example
+
+
+
+
triggered = lan.trigger[5].wait(3)
+
+
Wait for a trigger with LAN packet 5 with a timeout of 3 seconds.
This attribute stores a user-defined description and mDNS service name of the instrument.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Not applicable
+
+
Nonvolatile memory
+
+
Instrument specific (see Details)
+
+
+
+
+
Usage
+
localnode.description = description
+
description = localnode.description
+
+
+
+
description
+
+
User-defined description and mDNS service name of the instrument; use a string of 63 characters or less
+
+
+
+
+
Details
+
This attribute stores a string that contains a description of the instrument. This value appears on instrument's LXI welcome page. The value of this attribute is also used as the instrument's mDNS service name.
+
This attribute's factory default value is "Keithley Instruments SMU <model number> - <serial number>", where <model number> and <serial number> are replaced with the actual model number and serial number of the instrument (for example, "Keithley Instruments SMU 2657A - 1349810"). Setting this attribute to an empty string (in other words, setting this attribute to a string of length zero, or one consisting entirely of whitespace characters) will revert the description to the factory default value.
+
When using this command from a remote node, localnode should be replaced with the node reference, for example node[5].description.
+
Example
+
+
+
+
description = "System in Lab 05"
+
localnode.description = description
+
+
Set description equal to "System in Lab 05".
+
+
+
+
+
Also see
+
None
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This function starts test scripts from a remote node.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes (see Details)
+
+
+
+
+
+
+
+
+
+
+
Usage
+
node[N].execute(scriptCode)
+
+
+
+
N
+
+
The node number of this instrument
+
+
+
+
scriptCode
+
+
A string containing the source code
+
+
+
+
+
Details
+
Only the remote master node can use the execute command to run a script on this node. This function does not run test scripts on the master node, only on this node when initiated by the master node.
+
This function may only be called when the group number of the node is different than the node of the master.
+
This function will not wait for the script to finish execution.
+
This function cannot be used from the local node. This command should only be used from a remote master when controlling this instrument over a TSP-link®.
+
Example 1
+
+
+
+
node[2].execute(sourcecode)
+
+
Runs script code on node 2. The code is in a string variable called sourcecode.
+
+
+
+
+
Example 2
+
+
+
+
node[3].execute("x = 5")
+
+
Runs script code in string constant ("x = 5") to set x
+
equal to 5 on node 3.
+
+
+
+
+
Example 3
+
+
+
+
node[32].execute(TestDut.source)
+
+
Runs the test script stored in the variable TestDut
+
(previously stored on the master node) on node 32.
This function returns the value of a global variable.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes (see Details)
+
+
+
+
+
+
+
+
+
+
+
Usage
+
value = node[N].getglobal(name)
+
+
+
+
value
+
+
The value of the variable
+
+
+
+
N
+
+
The node number of this instrument
+
+
+
+
name
+
+
The global variable name
+
+
+
+
+
Details
+
Use this function to have the remote master node retrieve the value of a global variable from this node's run-time environment.
+
Do not use this command to retrieve the value of a global variable from the local node (access the global variable directly). This command should only be used from a remote master when controlling this instrument over a TSP-link®.
+
Example
+
+
+
+
print(node[5].getglobal("test_val"))
+
+
Retrieves and outputs the value of the global variable named test_val from node 5.
This write-only attribute stores the password that is set for any remote interface. When password usage is enabled (localnode.passwordmode), you must supply this password to change the configuration or to control an instrument from a web page or other remote command interface.
+
The instrument continues to use the old password for all interactions until the command to change it executes. When changing the password, give the instrument time to execute the command before attempting to use the new password.
+
You cannot retrieve a lost password from any command interface.
+
The password can be reset by resetting the LAN from the front panel or by using the lan.reset() command.
+
When using this command from a remote node, localnode should be replaced with the node reference, for example node[5].password.
+
Example
+
+
+
+
localnode.password = "N3wpa55w0rd"
+
+
Changes the remote interface password to N3wpa55w0rd.
This attribute sets and reads the local node prompting state (enabled or disabled).
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Power cycle
+
+
Not saved
+
+
0 (disabled)
+
+
+
+
+
Usage
+
prompting = localnode.prompts
+
localnode.prompts = prompting
+
+
+
+
prompting
+
+
Prompting state (0 to disable or 1 to enable)
+
+
+
+
+
Details
+
The command messages do not generate prompts. The instrument generates prompts in response to command messages.
+
When the prompting mode is enabled (set to 1), the instrument generates prompts in response to command messages. There are three prompts that might be generated:
+
TSP> is the standard prompt. This prompt indicates that everything is normal and the command is done processing.
TSP? is issued if there are entries in the error queue when the prompt is issued. Like the TSP> prompt, it indicates the command is done processing. It does not mean the previous command generated an error, only that there are still errors in the queue when the command was done processing.
>>>> is the continuation prompt. This prompt is used when downloading scripts. When downloading scripts, many command messages must be sent as a group. The continuation prompt indicates that the instrument is expecting more messages as part of the current command.
When using this command from a remote node, localnode should be replaced with the node reference, for example, node[5].prompts.
+
Do not disable prompting when using Test Script Builder. Test Script Builder requires prompts and sets the prompting mode behind the scenes. If you disable prompting, using Test Script Builder causes the instrument to stop responding because it is waiting for the prompt that lets it know that the command is done executing.
This attribute enables and disables the generation of prompts for IEEE Std 488.2 common commands.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Power cycle
+
+
Not saved
+
+
1 (enabled)
+
+
+
+
+
Usage
+
prompting = localnode.prompts4882
+
localnode.prompts4882 = prompting
+
+
+
+
prompting
+
+
IEEE Std 488.2 prompting mode
+
+
+
+
+
Details
+
When set to 1, the IEEE Std 488.2 common commands generate prompts if prompting is enabled with the localnode.prompts attribute. If set to 1, limit the number of *trg commands sent to a running script to 50 regardless of the setting of the localnode.prompts attribute.
+
When set to 0, IEEE Std 488.2 common commands will not generate prompts. When using the *trg command with a script that executes trigger.wait() repeatedly, set localnode.prompts4882 to 0 to avoid problems associated with the command interface input queue filling.
+
This attribute resets to the default value each time the instrument power is cycled.
+
When using this command from a remote node, localnode should be replaced with the node reference, for example node[5].prompts4882.
This function sets the value of a global variable.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes (see Details)
+
+
+
+
+
+
+
+
+
+
+
Usage
+
node[N].setglobal(name, value)
+
+
+
+
N
+
+
The node number of this instrument
+
+
+
+
name
+
+
The global variable name to set
+
+
+
+
value
+
+
The value to assign to the variable
+
+
+
+
+
Details
+
From a remote node, use this function to assign the given value to a global variable.
+
Do not use this command to create or set the value of a global variable from the local node (set the global variable directly instead). This command should only be used from a remote master when controlling this instrument over a TSP-link®.
+
Example
+
+
+
+
node[3].setglobal("x", 5)
+
+
Sets the global variable x on node 3 to the value of 5.
String representing daylight savings offset from UTC
+
+
+
+
dstStart
+
+
String representing when daylight savings time starts
+
+
+
+
dstEnd
+
+
String representing when daylight savings time ends
+
+
+
+
+
Details
+
The time zone is only used when converting between local time and UTC time when using the os.time() and os.date() functions.
+
If only one parameter is given, the same time offset is used throughout the year. If four parameters are given, time is adjusted twice during the year for daylight savings time.
+
offset and dstOffset are strings of the form "[+|-]hh[:mm[:ss]]" that indicate how much time must be added to the local time to get UTC time: hh is a number between 0 and 23 that represents hours; mm is a number between 0 and 59 that represents minutes; ss is a number between 0 and 59 that represents seconds. The minutes and seconds fields are optional.
+
The UTC-5 time zone would be specified with the string "5" because UTC-5 is 5 hours behind UTC and one must add 5 hours to the local time to get UTC time. The time zone UTC4 would be specified as "-4" because UTC4 is 4 hours ahead of UTC and 4 hours must be subtracted from the local time to get UTC.
+
dstStart and dstEnd are strings of the form "MM.w.dw/hh[:mm[:ss]]" that indicate when daylight savings time begins and ends respectively: MM is a number between 1 and 12 that represents the month; w is a number between 1 and 5 that represents the week within the month; dw is a number between 0 and 6 that represents the day of the week (where 0 is Sunday). The rest of the fields represent the time of day that the change takes effect: hh represents hours; mm represents minutes; ss represents seconds. The minutes and seconds fields are optional. The week of the month and day of the week fields are not specific dates.
+
Example
+
+
+
+
settimezone("8", "1", "3.3.0/02", "11.2.0/02")
+
settimezone(offset)
+
+
Sets offset to equal +8 hours, +1 hour for DST, starts on Mar 14 at 2:00 a.m, ends on Nov 7 at 2:00 a.m.
This attribute sets whether or not the instrument automatically sends generated errors.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Power cycle
+
+
Not saved
+
+
0 (disabled)
+
+
+
+
+
Usage
+
errorMode = localnode.showerrors
+
localnode.showerrors = errorMode
+
+
+
+
errorMode
+
+
Enables (1) or disables (0) the show errors state
+
+
+
+
+
Details
+
If this attribute is set to 1, the instrument automatically sends any generated errors stored in the error queue, and then clears the queue. Errors are processed after executing a command message (just before issuing a prompt, if prompts are enabled).
+
If this attribute is set to 0, errors are left in the error queue and must be explicitly read or cleared.
+
When using this command from a remote node, localnode should be replaced with the node reference, for example, node[5].showerrors.
This function creates a function to get the value of an attribute.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
getter = makegetter(table, attributeName)
+
+
+
+
getter
+
+
The return value
+
+
+
+
table
+
+
Read‑only table where the attribute is located
+
+
+
+
attributeName
+
+
A string representing the name of the attribute
+
+
+
+
+
Details
+
This function is useful for aliasing attributes to improve execution speed. Calling the function created with makegetter() executes faster than accessing the attribute directly.
+
Creating a getter function is only useful if it is going to be called several times. Otherwise, the overhead of creating the getter function outweighs the overhead of accessing the attribute directly.
+
Example
+
+
+
+
getlevel = makegetter(smua.source, "levelv")
+
v = getlevel()
+
+
Creates a getter function called getlevel.
+
When getlevel() is called, it returns the value of smua.source.levelv.
This function creates a function that, when called, sets the value of an attribute.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
setter = makesetter(table, attributeName)
+
+
+
+
setter
+
+
Function that sets the value of the attribute
+
+
+
+
table
+
+
Read-only table where the attribute is located
+
+
+
+
attributeName
+
+
The string name of the attribute
+
+
+
+
+
Details
+
This function is useful for aliasing attributes to improve execution speed. Calling the setter function will execute faster than accessing the attribute directly.
+
Creating a setter function is only useful if it is going to be called several times. If you are not calling the setter function several times, it is more efficient to access the attribute directly.
+
Example
+
+
+
+
setlevel = makesetter(smua.source, "levelv")
+
for v = 1, 10 do
+
setlevel(v)
+
end
+
+
Creates a setter function called setlevel.
+
+
Using setlevel() in the loop sets the value of smua.source.levelv,
This function sets the operation complete status bit when all overlapped commands are completed.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
opc()
+
Details
+
This function causes the operation complete bit in the Standard Event Status Register to be set when all previously started local overlapped commands are complete.
+
Note that each node independently sets its operation complete bits in its own status model. Any nodes not actively performing overlapped commands will set their bits immediately. All remaining nodes will set their own bits as they complete their own overlapped commands.
The last table or reading buffer subtable to print
+
+
+
+
...
+
+
One or more tables or reading buffer subtables separated with commas
+
+
+
+
+
Details
+
The correct usage of this function for a buffer containing n elements is:
+
1 = startIndex = endIndex = n
+
Where n refers to the index of the last entry in the tables to be printed.
+
If endIndex< startIndex or n<startIndex, no data is printed. If startIndex = 1, 1 is used as startIndex. Ifn< endIndex,nis used as endIndex.
+
When any given reading buffers are used in overlapped commands that have not yet completed (at least to the desired index), this function outputs data as it becomes available.
+
When there are outstanding overlapped commands to acquire data, n refers to the index that the last entry in the table will have after all the measurements have completed.
+
If you pass a reading buffer instead of a reading buffer subtable, the default subtable for that reading buffer will be used.
+
This command generates a single response message that contains all data. The response message is stored in the output queue.
+
The format.data attribute controls the format of the response message.
+
Example
+
+
+
+
format.data = format.ASCII
+
format.asciiprecision = 6
+
printbuffer(1, rb1.n, rb1)
+
+
+
+
This assumes that rb1 is a valid reading buffer in the run-time environment. The use of rb1.n (bufferVar.n) indicates that the instrument should output all readings in the reading buffer. In this example, rb1.n equals 10.
Scripting helps you combine commands into a block of code that the instrument can run. Scripts help you communicate with the instrument efficiently. These commands describe how to create, load, modify, run, and exit scripts.
This function creates a script from a specified file.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
scriptVar = script.load(file)
+
scriptVar = script.load(file, name)
+
+
+
+
scriptVar
+
+
The created script. This is nil if an error is encountered
+
+
+
+
file
+
+
The path and file name of the script file to load
+
+
+
+
name
+
+
The name of the script to be created
+
+
+
+
+
Details
+
The file path may be absolute or relative to the current working directory. The root folder of the USB flash drive has the absolute path "/usb1/". Both the forward slash (/) and backslash (\) are supported as directory separators.
+
The file to be loaded must start with the loadscript or loadandrunscript keywords, contain the body of the script, and end with the endscript keyword.
+
Script naming:
+
If the name parameter is an empty string, or name is absent (or nil) and the script name cannot be extracted from the file, scriptVar is the only handle to the created script.
If name is given (and not nil), any script name embedded in the file is ignored.
If name conflicts with the name of an existing script in the script.user.scripts table, the existing script’s name attribute is set to an empty string before it is replaced in the script.user.scripts table by the new script.
If name is absent or nil, the command attempts to extract the name of the script from the file. Any conflict between the extracted name and that of an existing script in the scripts table generates an error. If the script name cannot be extracted, the created script's name attribute is initialized to the empty string, and must be set to a valid nonempty string before saving the script to nonvolatile memory.
The name of the variable that will reference the script
+
+
+
+
code
+
+
A string containing the body of the script
+
+
+
+
name
+
+
The name of the script
+
+
+
+
+
Details
+
The name parameter is the name that is added to the script.user.scripts table. If name is not given, an empty string will be used, and the script will be unnamed. If the name already exists in script.user.scripts, the existing script's name attribute is set to an empty string before it is replaced by the new script.
+
Note that name is the value that is used for the instrument front panel display. If this value is not defined, the script will not be available from the instrument front panel.
+
You must save the new script into nonvolatile memory to keep it when the instrument is turned off.
+
Example 1
+
+
+
+
myTest8 = script.new(
+
"display.clear() display.settext('Hello from myTest8')", "myTest8")
+
myTest8()
+
+
+
+
Creates a new script referenced by the variable myTest8 with the name "myTest8".
+
Runs the script. The instrument displays "Hello from myTest8".
+
+
+
+
+
Example 2
+
+
+
+
autoexec = script.new(
+
"display.clear() display.settext('Hello from autoexec')", 'autoexec')
+
+
+
+
Creates a new autoexec script that clears the display when the instrument is turned on and displays "Hello from autoexec".
This attribute configures the baud rate for the RS-232 port.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Not applicable
+
+
Nonvolatile memory
+
+
9600
+
+
+
+
+
Usage
+
baud = serial.baud
+
serial.baud = baud
+
+
+
+
baud
+
+
The baud rate (300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600 or 115200)
+
+
+
+
+
Details
+
A new baud rate setting takes effect when the command to change it is processed.
+
Allow ample time for the command to be processed before attempting to communicate with the instrument again. If possible, set the baud rate from one of the other command interfaces or from the front panel.
This attribute configures character width (data bits) for the RS-232 port.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Not applicable
+
+
Nonvolatile memory
+
+
8
+
+
+
+
+
Usage
+
bits = serial.databits
+
serial.databits = bits
+
+
+
+
bits
+
+
An integer representing the character width (7 or 8)
+
+
+
+
+
Details
+
A new data width setting takes effect when the command to change it is processed.
+
Allow ample time for the command to be processed before attempting to communicate with the instrument again. If possible, set the character width from one of the other command interfaces or from the front panel.
This attribute configures flow control for the RS-232 port.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Not applicable
+
+
Nonvolatile memory
+
+
"none" (serial.FLOW_NONE)
+
+
+
+
+
Usage
+
flow = serial.flowcontrol
+
serial.flowcontrol = flow
+
+
+
+
flow
+
+
A string representing flow control configuration; set to:
+
"none" or serial.FLOW_NONE (selects no flow control)
"hardware" or serial.FLOW_HARDWARE (selects hardware flow control)
+
+
+
+
Details
+
A new flow control setting takes effect when the command to change it is processed.
+
Allow ample time for the command to be processed before attempting to communicate with the instrument again. If possible, set the flow control from one of the other command interfaces or from the front panel.
This attribute configures parity for the RS-232 port.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Not applicable
+
+
Nonvolatile memory
+
+
"none" (serial.PARITY_NONE)
+
+
+
+
+
Usage
+
parity = serial.parity
+
serial.parity = parity
+
+
+
+
parity
+
+
Set parity to one of the following values:
+
Select no parity ("none" or serial.PARITY_NONE)
Select even parity ("even" or serial.PARITY_EVEN)
Select odd parity ("odd" or serial.PARITY_ODD)
+
+
+
+
Details
+
A new parity setting takes effect when the command to change it is processed.
+
Allow ample time for the command to be processed before attempting to communicate with the instrument again. If possible, set parity from one of the other command interfaces or from the front panel.
This function reads available characters (data) from the serial port.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
data = serial.read(maxchars)
+
+
+
+
data
+
+
A string consisting of all data read from the serial port
+
+
+
+
maxchars
+
+
An integer that specifies the maximum number of characters to read
+
+
+
+
+
Details
+
This function will read available characters from the serial port. It will not wait for new characters to arrive. As long as maxchars is less than 200 characters, all characters received by the serial port (before the serial.read() command is executed) are returned. If too many characters are received between calls to this function, the RS-232 buffers will overflow and some characters may be lost.
+
Call this function as many times as necessary to receive the required number of characters. For optimal performance, use a small delay between repeated calls to this function.
+
The data returned is the raw data stream read from the port. No characters, such as control characters or terminator characters, are interpreted nor will the data stream be altered.
+
This function cannot be used if the serial port is enabled as a command interface; a settings conflict error will be generated.
+
Example
+
+
+
+
data = serial.read(200)
+
+
print(data)
+
+
Read data from the serial port.
+
+
Output:
+
John Doe
+
The above output indicates that the string "John Doe" was read from the serial port.
This attribute specifies which saved setup to recall when the instrument is turned on.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Not applicable
+
+
Nonvolatile memory
+
+
0
+
+
+
+
+
Usage
+
N = setup.poweron
+
setup.poweron = N
+
+
+
+
N
+
+
An integer that specifies the setup to recall when the instrument power is turned on (0 to 5)
+
+
+
+
+
Details
+
When N = 0, the instrument uses the factory default setup when it is turned on. When N is set to 1 to 5, it uses the setup saved with setup.save().
+
Only setups stored in nonvolatile memory are available (you cannot recall a script from a USB flash drive with this command) . To save a script to be used when the instrument is powered on, you can create a configuration script and name it autoexec.
+
Example
+
+
+
+
setup.poweron = 0
+
+
Set the instrument to use the factory default setup when power is turned on.
This function recalls settings from a saved setup.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
setup.recall(id)
+
+
+
+
id
+
+
An integer or string specifying the location of the setup to recall:
+
Factory default setup (0)
User-saved setup in nonvolatile memory (1 to 5 )
User-saved setup on a USB flash drive ("/path/filename")
+
+
+
+
Details
+
When the id parameter is an integer (n), it is interpreted as the setup number to restore from the instrument's nonvolatile memory. When n = 0, the instrument recalls the factory default setup; when n = 1 to 5, the instrument recalls a user-saved setup from nonvolatile memory.
+
When the id parameter is a string, it is interpreted as the path and file name of the setup to restore from a file on a USB flash drive. The path may be absolute or relative to the current working directory.
+
Before a setup is recalled, an instrument reset is performed.
+
Example 1
+
+
+
+
setup.recall(1)
+
+
Recall the user-saved setup at location 1 .
+
+
+
+
+
Example 2
+
+
+
+
setup.recall("/usb1/KEITHLEY_30730.set")
+
+
Recall a user-saved setup stored in a file named KEITHLEY_30730 on a USB flash drive.
This function saves the present setup as a user-saved setup.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
setup.save(id)
+
+
+
+
id
+
+
An integer or string specifying where to save the user setup:
+
Save in nonvolatile memory (1 to 5)
Save as user-saved setup on a USB flash drive ("/path/filename")
+
+
+
+
When the id parameter is an integer (n), it is interpreted as the setup number to save to the instrument's nonvolatile memory.
+
When you save to a specified integer (1 to 5) in nonvolatile memory, the previous setup at that same location is overwritten.
+
When the id parameter is a string, it is interpreted as the path and file name of the location to save the present setup on a USB flash drive. The path may be absolute or relative to the current working directory.
+
+
Example
+
+
+
+
setup.save(5)
+
+
Saves the present setup to the internal memory of the instrument at location 5.
This function disables commands that change calibration settings.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
smuX.cal.lock()
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.cal.lock() specifies SMU channel A)
+
+
+
+
+
Details
+
This function disables calibration functions that can change calibration settings. The calibration constants must be written to nonvolatile memory, or a previous calibration set must be restored prior to locking calibration. Error code 5012, "Cal data not saved - save or restore before lock," will result if this function is called when the calibration state is smuX.CALSTATE_CALIBRATING.
This function loads a stored set of calibration constants.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
smuX.cal.restore()
+
smuX.cal.restore(calset)
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.cal.restore() applies to SMU channel A)
+
+
+
+
calset
+
+
The calibration set to be loaded. Set calset to one of the following values:
+
0 or smuX.CALSET_NOMINAL: A set of calibration constants that are uncalibrated, but set to nominal values to allow rudimentary functioning of the instrument
+
1 or smuX.CALSET_FACTORY: The calibration constants when the instrument left the factory
+
2 or smuX.CALSET_DEFAULT: The normal calibration set
+
3 or smuX.CALSET_PREVIOUS: The calibration set that was used before the last default set was overwritten
+
+
+
+
+
Details
+
This function will overwrite the current set of calibration constants with constants read from nonvolatile memory.
+
This function will be disabled until a successful call to smuX.cal.unlock() is made.
+
If calset is not specified, smuX.CALSET_DEFAULT will be used.
+
Example
+
+
+
+
smua.cal.restore()
+
+
Restores factory calibration constants for SMU channel A.
This function stores the active calibration constants to nonvolatile memory.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
smuX.cal.save()
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.cal.save() applies to SMU channel A)
+
+
+
+
+
Details
+
This function will store the active set of calibration constants to nonvolatile memory. The previous calibration constants (from the default calibration set) will be copied to the previous calibration set (smuX.CALSET_PREVIOUS) prior to overwriting the default calibration set.
+
This function will be disabled until a successful call to smuX.cal.unlock() is made. If any of the calibration constants have been changed, this function will be disabled unless the calibration date, the calibration due date, and the calibration adjust date have been assigned new values.
+
Example
+
+
+
+
smua.cal.save()
+
+
Stores calibration constants for SMU channel A in nonvolatile memory.
This attribute stores the date of the last calibration adjustment.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU cal. restore
+
+
SMU nonvolatile memory
+
+
Initially set to factory calibration date
+
+
+
+
+
Usage
+
adjustDate = smuX.cal.adjustdate
+
smuX.cal.adjustdate = adjustDate
+
+
+
+
adjustDate
+
+
Date of the last calibration adjustment
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.cal.adjustdate applies to SMU channel A)
+
+
+
+
+
Details
+
This attribute stores the adjustment date associated with the active calibration set. The adjustment date can be read at any time, but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function.
+
You cannot change the adjust date without first making a change to the calibration constants.
+
Once you change any calibration constants, you must set the adjustment date before being allowed to save the calibration data to the SMU's nonvolatile memory.
+
This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute will reflect the date stored with that set.
+
smuX.cal.adjustdate must be set to the date the adjustment was done using the UTC time and date. The date is stored as the number of seconds since UTC, 12:00 am Jan 1, 1970.
+
Due to the internal storage format, smuX.cal.adjustdate is only accurate to within a few minutes of the value set.
+
Example
+
+
+
+
smua.cal.adjustdate = os.time()
+
+
Sets the adjustment date for SMU channel A to the current time set on the instrument.
This attribute stores the calibration date of the active calibration set.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU cal. restore
+
+
SMU nonvolatile memory
+
+
Initially set to factory calibration date
+
+
+
+
+
Usage
+
calDate = smuX.cal.date
+
smuX.cal.date = calDate
+
+
+
+
calDate
+
+
The active calibration set's calibration date
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.cal.date applies to SMU channel A)
+
+
+
+
+
Details
+
This attribute stores the calibration date associated with the active calibration set. The calibration date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function.
+
This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute will reflect the date stored with that set.
+
smuX.cal.date must be set to the date the calibration was done using the UTC time and date. The date is stored as the number of seconds since UTC 12:00 am Jan 1, 1970.
+
Due to the internal storage format, smuX.cal.date is accurate to within a few minutes of the value set.
+
Example
+
+
+
+
smua.cal.date = os.time()
+
+
Sets calibration date for SMU channel A to the current time set on the instrument.
This attribute stores the calibration due date for the next calibration.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU cal. restore
+
+
SMU nonvolatile memory
+
+
0
+
+
+
+
+
Usage
+
calDue = smuX.cal.due
+
smuX.cal.due = calDue
+
+
+
+
calDue
+
+
Due date of next calibration (0 indicates that no date is set)
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.cal.due applies to SMU channel A)
+
+
+
+
+
Details
+
This attribute stores the calibration due date associated with the active calibration set. The calibration due date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function.
+
This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute will reflect the due date stored with that set.
+
smuX.cal.due must be set to the date the next calibration is required using the UTC time and date. The date is stored as the number of seconds since UTC 12:00 am Jan 1, 1970.
+
Due to the internal storage format, smuX.cal.due is only accurate to within a few minutes of the value set.
+
Example
+
+
+
+
smua.cal.due = os.time() + 365 * 24 * 60 * 60
+
+
Sets the SMU channel A calibration due date equal to one year from the current time set on the instrument.
The polarity to use for measurements. Set to one of the following values:
+
0 or smuX.CAL_AUTO: Automatic polarity detection
+
1 or smuX.CAL_POSITIVE: Measure with positive polarity calibration constants
+
2 or smuX.CAL_NEGATIVE: Measure with negative polarity calibration constants
+
+
+
+
X
+
+
SMU channel (for example, smua.cal.polarity applies to SMU channel A)
+
+
+
+
+
Details
+
This attribute controls which polarity calibration constants are used to make all subsequent measurements. This attribute does not affect the smuX.measure.calibrateY() or smuX.source.calibrateY() commands. The polarity for those commands are dictated by the range parameter given to the command. The measurement calibration commands require the measurements provided to have been made using the polarity being calibrated.
+
When making those measurements with calibration points far away from zero, the desired polarity constants are inherently used. When measuring near zero, it is possible for the measurement to be made using the calibration constants from either polarity without knowing which was used. Setting this attribute to positive or negative forces measurements to be made using the calibration constants for a given polarity rather than basing the choice on the raw measurement data.
+
This attribute can only be set to positive or negative when calibration is unlocked. This attribute will automatically be set to smuX.CAL_AUTO when calibration is locked.
+
Example
+
+
+
+
smua.cal.polarity = smua.CAL_POSITIVE
+
+
Selects positive calibration constants for all subsequent measurements on SMU channel A.
Source‑measure unit (SMU) channel (for example, smua.contact.calibratehi() applies to SMU channel A)
+
+
+
+
cp1Measured
+
+
The value measured by this SMU for calibration point 1
+
+
+
+
cp1Reference
+
+
The reference measurement for calibration point 1 as measured externally
+
+
+
+
cp2Measured
+
+
The value measured by this SMU for calibration point 2
+
+
+
+
cp2Reference
+
+
The reference measurement for calibration point 2 as measured externally
+
+
+
+
+
Details
+
Contact check measurement calibration does not require range information.
+
Typically, calibration points one and two will be near 0 W and 50 W, respectively.
+
All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the active calibration set. If not, corruption of the calibration constants may result.
+
The new calibration constants will be activated immediately but are not written to nonvolatile storage. Use smuX.cal.save() to save the new constants to nonvolatile storage. The active calibration constants will stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile storage with the smuX.cal.restore() function.
+
This function will be disabled until a successful call to smuX.cal.unlock() is made.
+
Example
+
+
+
+
-- Short SENSE LO and LO terminals
+
-- Short SENSE HI and HI terminals
+
-- Allow readings to settle, then get measurements
+
r0_hi, r0_lo = smua.contact.r()
+
+
-- Connect 50 OHM resistor between SENSE LO and LO
+
-- Connect 50 OHM resistor between SENSE HI and HI
+
-- Allow readings to settle, then get measurements
Source‑measure unit (SMU) channel (for example, smua.contact.calibratelo() applies to SMU channel A)
+
+
+
+
cp1Measured
+
+
The value measured by this SMU for calibration point 1
+
+
+
+
cp1Reference
+
+
The reference measurement for calibration point 1 as measured externally
+
+
+
+
cp2Measured
+
+
The value measured by this SMU for calibration point 2
+
+
+
+
cp2Reference
+
+
The reference measurement for calibration point 2 as measured externally
+
+
+
+
+
Details
+
Contact check measurement calibration does not require range information.
+
Typically, calibration points one and two will be near 0 W and 50 W, respectively.
+
All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the active calibration set. If not, corruption of the calibration constants may result.
+
The new calibration constants will be activated immediately but are not written to nonvolatile storage. Use smuX.cal.save() to save the new constants to nonvolatile storage. The active calibration constants will stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile storage with the smuX.cal.restore() function.
+
This function will be disabled until a successful call to smuX.cal.unlock() is made.
+
Example
+
+
+
+
-- Short SENSE LO and LO terminals
+
-- Short SENSE HI and HI terminals
+
-- Allow readings to settle, then get measurements
+
r0_hi, r0_lo = smua.contact.r()
+
+
-- Connect 50 OHM resistor between SENSE LO and LO
+
-- Connect 50 OHM resistor between SENSE HI and HI
+
-- Allow readings to settle, then get measurements
This function determines if contact resistance is lower than the threshold.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
smuX.contact.check()
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.contact.check() applies to SMU channel A)
+
+
+
+
+
Details
+
This function returns true if the contact resistance is below the threshold; this function returns false if it is above the threshold. The threshold value is set by the smuX.contact.threshold attribute.
+
Attempting to perform a contact check measurement when any of the following conditions exist will generate errors:
+
When output is on and any of the following:
+
SMU is a current source with current range set to less than 1 mA (error code 5065, "I range too low for contact check")
SMU is a voltage source with current limit set to less than 1 mA (error code 5050, "I limit too low for contact check")
When output is off and any of the following:
+
The output off mode is High-Z (error code 5048, "Contact check not valid with HIGH-Z OUTPUT off")
The output off mode is Normal with the smuX.source.offfunc attribute set to smuX.OUTPUT_DCVOLTS and the off current limit set to less than 1 mA (error code 5066, "source.offlimiti too low for contact check")
The output off mode is Normal with the smuX.source.offfunc attribute set to smuX.OUTPUT_DCAMPS and the source range is less than 1 mA (error code 5065, "I range too low for contact check")
Example
+
+
+
+
if not smua.contact.check() then
+
-- take action
+
end
+
+
Takes action if contact check on SMU channel A fails.
This function measures aggregate contact resistance.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
rhi, rlo = smuX.contact.r()
+
+
+
+
rhi
+
+
The measured aggregate contact resistance on the high/sense high side
+
+
+
+
rlo
+
+
The measured aggregate contact resistance on the low/sense low side
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.contact.r() applies to SMU channel A)
+
+
+
+
+
Details
+
Attempting to perform a contact resistance measurement when any of the following conditions exist will generate an error:
+
When output is on and any of the following:
+
SMU is a current source with current range set to less than 1 mA (error code 5065, "I range too low for contact check")
SMU is a voltage source with current limit set to less than 1 mA (error code 5050, "I limit too low for contact check")
When output is off and any of the following:
+
The output off mode is High-Z (error code 5048, "Contact check not valid with HIGH-Z OUTPUT off")
The output off mode is Normal with the smuX.source.offfunc attribute set to smuX.OUTPUT_DCVOLTS and the off current limit set to less than 1 mA (error code 5066, "source.offlimiti too low for contact check")
The output off mode is Normal with the smuX.source.offfunc attribute set to smuX.OUTPUT_DCAMPS and the source range is less than 1 mA (error code 5065, "I range too low for contact check")
Source‑measure unit (SMU) channel (for example, smua.makebuffer() applies to SMU channel A)
+
+
+
+
bufferSize
+
+
Maximum number of readings that can be stored
+
+
+
+
+
Details
+
Reading buffers can be created and allocated dynamically using this function. Use bufferSize to designate the number of readings the buffer can store.
+
Dynamically allocated reading buffers can be used interchangeably with the smuX.nvbufferY buffers.
+
A reading buffer can be deleted by setting all references to the reading buffer equal to nil, then running the garbage collector (see the collectgarbage() function in Standard libraries).
+
Example
+
+
+
+
mybuffer2 = smua.makebuffer(200)
+
+
Creates a 200 element reading buffer (mybuffer2)for SMU channel A .
This attribute stores the measurement autorange setting.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset SMU reset Recall setup
+
+
Saved setup
+
+
1 (smuX.AUTORANGE_ON)
+
+
+
+
+
Usage
+
autoRange = smuX.measure.autorangeY
+
smuX.measure.autorangeY = autoRange
+
+
+
+
autoRange
+
+
The state of the measurement autorange setting; set to one of the following values:
+
0 or smuX.AUTORANGE_OFF: Disabled
+
1 or smuX.AUTORANGE_ON: Enabled
+
2 or smuX.AUTORANGE_FOLLOW_LIMIT: Measure range automatically set to the limit range
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.measure.autorangev applies to SMU channel A)
+
+
+
+
Y
+
+
SMU measure function (v = voltage, i = current)
+
+
+
+
+
Details
+
This attribute indicates the measurement autorange state. Its value will be smuX.AUTORANGE_OFF when the SMU measure circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.
+
Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed range. The fixed range will be the present SMU measure range.
+
Setting this attribute to smuX.AUTORANGE_ON puts the SMU measure circuit into autorange mode. It will remain on its present measure range until the next measurement is requested.
+
Example
+
+
+
+
smua.measure.autorangev = 1
+
+
Enables voltage measurement autoranging for SMU channel A. Alternatively, the value 1 may be replaced with smua.AUTORANGE_ON.
This attribute sets the behavior of the source-measure unit's (SMU's) A/D internal reference measurements (autozero).
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset SMU reset Recall setup
+
+
Saved setup
+
+
2 (smuX.AUTOZERO_AUTO)
+
+
+
+
+
Usage
+
azMode = smuX.measure.autozero
+
smuX.measure.autozero = azMode
+
+
+
+
azMode
+
+
Indicates status of autozero; set to one of the following values:
+
0 or smuX.AUTOZERO_OFF: Autozero disabled
+
1 or smuX.AUTOZERO_ONCE: Performs autozero once, then disables autozero
+
2 or smuX.AUTOZERO_AUTO: Automatic checking of reference and zero measurements; an autozero is performed when needed
+
+
+
+
X
+
+
SMU channel (for example, smua.measure.autozero applies to SMU channel A)
+
+
+
+
+
Details
+
The integrating analog-to-digital converter (ADC) uses a ratiometric A/D conversion technique. To ensure the accuracy of readings, the instrument must periodically obtain fresh measurements of its internal ground and voltage reference. The time interval between updates to these reference measurements is determined by the integration aperture being used for measurements. Separate reference and zero measurements are used for each aperture.
+
By default, the instrument automatically checks these reference measurements whenever a signal measurement is made. If the reference measurements have expired when a signal measurement is made, the instrument will automatically take two more A/D conversions, one for the reference and one for the zero, before returning the result. Thus, occasionally, a measurement takes longer than normal.
+
This additional time can cause problems in sweeps and other test sequences in which measurement timing is critical. To avoid the extra time for the reference measurements in these situations, the smuX.measure.autozero attribute can be used to disable the automatic reference measurements. Keep in mind that disabling automatic reference measurements may allow the instrument to gradually drift out of specification.
+
To minimize the drift, a reference and zero measurement should be made just prior to the critical test sequence. The smuX.AUTOZERO_ONCE setting can be used to force a refresh of the reference and zero measurements used for the current aperture setting.
+
Autozero reference measurements for the last 10 used NPLC settings are stored in a reference cache. If an NPLC setting is selected and an entry for it is not in the cache, the oldest (least recently used) entry will be discarded to make room for the new entry.
+
The fast ADC (analog-to-digital converter) does not need or use the reference measurements associated with this attribute (only the integrating ADC). When this attribute is set to smuX.AUTOZERO_AUTO, the fast ADC will not require these reference measurements. However, if the fast ADC is selected, setting this attribute to smuX.AUTOZERO_ONCE will cause the integrating ADC to acquire a new set of reference measurements.
+
Example
+
+
+
+
smua.measure.autozero = 1
+
+
Performs autozero once for SMU channel A. Alternatively, the value 1 may be replaced with smua.AUTOZERO_ONCE.
Source‑measure unit (SMU) channel (for example, smua.measure.calibratev() applies to SMU channel A)
+
+
+
+
Y
+
+
SMU measurement function (v = voltage, i = current)
+
+
+
+
range
+
+
The measurement range to calibrate
+
+
+
+
cp1Measured
+
+
The value measured by this SMU for calibration point 1
+
+
+
+
cp1Reference
+
+
The reference measurement for calibration point 1 as measured externally
+
+
+
+
cp2Measured
+
+
The value measured by this SMU for calibration point 2
+
+
+
+
cp2Reference
+
+
The reference measurement for calibration point 2 as measured externally
+
+
+
+
+
Details
+
This function generates and activates new calibration constants for the given range. The positive and negative polarities of the instrument must be calibrated separately. Use a positive value for range to calibrate the positive polarity and a negative value for range to calibrate the negative polarity.
+
Typically the two calibration points used will be near zero for calibration point 1 and 90% of full scale for calibration point 2.
+
All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the active calibration set. Corruption of the calibration constants may result if this is not heeded.
+
The new calibration constants will be activated immediately but they will not be written to nonvolatile storage. Use smuX.cal.save() to commit the new constants to nonvolatile storage. The active calibration constants will stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile storage with the smuX.cal.restore() function.
+
This function will be disabled until a successful call to smuX.cal.unlock() is made.
SMU channel A calibrates voltage measurement using following values: 200 V calibration range, 1e-4 for +zero measurement reading, 1e-5 for +zero DMM measurement reading, 178.8 for +FS measurement reading, and 179.8 for the +FS DMM measurement reading.
This attribute sets the number of measurements performed when a measurement is requested.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset SMU reset Recall setup
+
+
Saved setup
+
+
1
+
+
+
+
+
Usage
+
count = smuX.measure.count
+
smuX.measure.count = count
+
+
+
+
count
+
+
Number of measurements
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.measure.count applies to SMU channel A)
+
+
+
+
+
Details
+
This attribute controls the number of measurements taken any time a measurement is requested. When using a reading buffer with a measure command, this attribute also controls the number of readings to be stored.
+
If smuX.measure.count is set to a value greater than 1, any measurement delay set by smuX.measure.delay will only occur before the first measurement, while the smuX.measure.interval controls the interval between successive measurements.
Set to your desired measurement delay value in seconds (for example, to specify an additional 10 ms measurement delay, set the value to 0.010)
+
You can also set it one of the following values:
+
0 or smuX.DELAY_OFF: No delay
+
-1 or smuX.DELAY_AUTO: Automatic delay value
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.measure.delay applies to SMU channel A)
+
+
+
+
+
Details
+
This attribute allows for additional delay (settling time) before taking a measurement. You can set mDelay to smuX.DELAY_OFF, smuX.DELAY_AUTO, or to a user-defined value (in seconds). A user‑defined value will set the delay used, regardless of range.
+
The smuX.DELAY_AUTO setting also causes a current range-dependent delay to be inserted when a current measurement is requested. This happens when a current measurement command is executed, when the measure action is being performed in a sweep, or after changing ranges during an autoranged measurement.
+
If smuX.measure.count is greater than 1, the measurement delay is only inserted before the first measurement.
This attribute sets the type of filter used for measurements when smuX.measure.filter.enable is enabled.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset SMU reset Recall setup
+
+
Saved setup
+
+
1 (smuX.FILTER_REPEAT_AVG)
+
+
+
+
+
Usage
+
filterType = smuX.measure.filter.type
+
smuX.measure.filter.type = filterType
+
+
+
+
filterType
+
+
The filter type to use when filtering is enabled. Set to one of the following values:
+
0 or smuX.FILTER_MOVING_AVG: Selects the moving average filter
+
1 or smuX.FILTER_REPEAT_AVG: Selects the repeat filter
+
2 or smuX.FILTER_MEDIAN: Selects the median filter
+
+
+
+
X
+
+
SMU channel (for example, smua.measure.filter.type applies to SMU Channel A)
+
+
+
+
+
Details
+
There are two averaging filter types and one median filter type available. For averaging filters, both repeating and moving filter types are available.
+
For the repeating filter (which is the power-on default), the stack (filter count) is filled, and the conversions are averaged to yield a reading. The stack is then cleared, and the process starts over.
+
The moving average filter uses a first-in, first-out stack. When the stack (filter count) becomes full, the measurement conversions are averaged, yielding a reading. For each subsequent conversion placed into the stack, the oldest conversion is discarded. The stack is re-averaged, yielding a new reading.
+
The median filter uses a first-in, first-out stack. When the stack (filter count) becomes full, the “middle-most” reading is returned. For each subsequent conversion placed into the stack, the oldest reading is discarded. The stack is then re-sorted, yielding a new reading. If the filter count is an even number, the reading returned is the average of the two middle readings.
+
Example
+
+
+
+
smua.measure.filter.type = 2
+
+
Selects the median filter for SMU channel A. Alternatively, the value 2 may be replaced with smua.FILTER_MEDIAN.
This attribute sets the interval between multiple measurements.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset SMU reset Recall setup
+
+
Saved setup
+
+
0 (0 s)
+
+
+
+
+
Usage
+
interval = smuX.measure.interval
+
smuX.measure.interval = interval
+
+
+
+
interval
+
+
The interval value (in seconds). Set to a value between 0 and 1
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.measure.interval applies to SMU channel A)
+
+
+
+
+
Details
+
This attribute sets the time interval between measurements when smuX.measure.count is set to a value greater than 1. The SMU will attempt to start each measurement when scheduled. If the SMU cannot keep up with the interval setting, measurements will be made as fast as possible.
+
If filtered measurements are being made, this interval is from the start of the first measurement for the filtered reading to the first measurement for a subsequent filtered reading. Extra measurements made to satisfy a filtered reading are not paced by this interval.
+
Example
+
+
+
+
smua.measure.interval = 0.5
+
+
Sets the measure interval for SMU channel A to 0.5.
This attribute sets the lowest measure range that will be used during autoranging.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset SMU reset Recall setup
+
+
Saved setup
+
+
Current: 1e‑9 (1 nA)
+
Voltage: 200 (200 V)
+
+
+
+
+
Usage
+
lowRange = smuX.measure.lowrangeY
+
smuX.measure.lowrangeY = lowRange
+
+
+
+
lowRange
+
+
The lowest voltage or current measure range used during autoranging
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.measure.lowrangev applies to SMU channel A)
+
+
+
+
Y
+
+
SMU measure function (v = voltage, i = current)
+
+
+
+
+
Details
+
This attribute is used with autoranging to put a lower bound on the range used. Since lower ranges generally require greater settling times, setting a lowest range limit might make measurements require less settling time.
+
If the instrument is set to autorange and it is on a range lower than the one specified, the range will be changed to the lowRange range value.
+
Example
+
+
+
+
smua.measure.lowrangei = 100e-9
+
+
Sets current low range for SMU channel A to 100 nA.
This attribute sets the integration aperture for measurements.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset SMU reset Recall setup
+
+
Saved setup
+
+
1.0
+
+
+
+
+
Usage
+
nplc = smuX.measure.nplc
+
smuX.measure.nplc = nplc
+
+
+
+
nplc
+
+
The integration aperture; set from 0.001 to 25
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.measure.nplc applies to SMU channel A)
+
+
+
+
+
Details
+
When making measurements, the SMU uses one of two types of analog‑to‑digital converters (ADC). This attribute controls the integration aperture for the integrating ADC. This attribute is not used when the fast ADC is selected.
+
The integration aperture is based on the number of power line cycles (NPLC), where 1 PLC for 60 Hz is 16.67 ms (1/60) and 1 PLC for 50 Hz is 20 ms (1/50).
+
Example
+
+
+
+
smua.measure.nplc = 0.5
+
+
Sets the integration time for SMU channel A to 0.5/60 seconds.
This function starts an asynchronous (background) measurement.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
smuX.measure.overlappedY(rbuffer)
+
smuX.measure.overlappediv(ibuffer, vbuffer)
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)
+
+
+
+
Y
+
+
SMU measurement type (v = voltage, i = current, r = resistance, p = power)
+
+
+
+
rbuffer
+
+
A reading buffer object where the readings will be stored
+
+
+
+
ibuffer
+
+
A reading buffer object where current readings will be stored
+
+
+
+
vbuffer
+
+
A reading buffer object where voltage readings will be stored
+
+
+
+
+
Details
+
This function will start a measurement and return immediately. The measurements, as they are performed, are stored in a reading buffer (along with any ancillary information also being acquired). If the instrument is configured to return multiple readings where one is requested, the readings will be available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.
+
The smuX.measure.overlappediv() function stores current readings in ibuffer and voltage readings in vbuffer.
+
This function is an overlapped command. Script execution will continue while the measurements are made in the background. Attempts to access result values that have not yet been generated will cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before continuing.
+
If a given reading buffer contains any data, it will be cleared prior to taking any measurements, unless the reading buffer has been configured to append data.
+
Example
+
+
+
+
smua.measure.overlappedv(smua.nvbuffer1)
+
+
Starts background voltage measurements for SMU channel A.
This attribute contains the positive full‑scale value of the measurement range for voltage or current.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset SMU reset Recall setup
+
+
Saved setup
+
+
Current: 120e-3 (120 mA)
+
Voltage: 200 (200 V)
+
+
+
+
+
Usage
+
rangeValue = smuX.measure.rangeY
+
smuX.measure.rangeY = rangeValue
+
+
+
+
rangeValue
+
+
Set to the maximum expected voltage or current to be measured
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)
+
+
+
+
Y
+
+
SMU measurement function (v = voltage, i = current)
+
+
+
+
+
Details
+
Reading this attribute returns the positive full-scale value of the measurement range that the SMU is currently using. Assigning a value to this attribute sets the SMU on a fixed range large enough to measure the assigned value. The instrument will select the best range for measuring a value of rangeValue.
+
This attribute is primarily intended to eliminate the time that is required by the automatic range selection performed by a measuring instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur.
+
If the source function is the same as the measurement function (for example, sourcing voltage and measuring voltage), the measurement range is locked to be the same as the source range. However, the setting for the measure range is retained. If the source function is changed (for example, from sourcing voltage to sourcing current), the retained measurement range will be used.
+
Explicitly setting a measure range will disable measure autoranging for that function. Autoranging is controlled separately for each source and measurement function: source voltage, source current, measure voltage and measure current. Autoranging is enabled for all four by default.
+
Changing the range while the output is off will not update the hardware settings, but querying will return the range setting that will be used once the output is turned on. Setting a range while the output is on will take effect immediately.
+
With measure autoranging enabled, the range will be changed only when a measurement is taken. Querying the range after a measurement will return the range selected for that measurement.
+
Example
+
+
+
+
smua.measure.rangev = 200
+
+
Selects the 200 V measurement range for SMU channel A.
Returned value of the last (or only) reading of the measurement process
+
+
+
+
X
+
+
Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)
+
+
+
+
Y
+
+
SMU measurement function (v = voltage, i = current, r = resistance, p = power)
+
+
+
+
readingBuffer
+
+
A reading buffer object where all readings will be stored
+
+
+
+
iReading
+
+
The last reading of the current measurement process
+
+
+
+
vReading
+
+
The last reading of the voltage measurement process
+
+
+
+
iReadingBuffer
+
+
A reading buffer object where current readings will be stored
+
+
+
+
vReadingBuffer
+
+
A reading buffer object where voltage readings will be stored
+
+
+
+
+
Details
+
This function (without specifying a reading buffer) will only make one measurement and return that measurement as reading. To use the additional information acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings will be available in readingBuffer, but only the last measurement will be returned as reading.
+
Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.
+
The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).
+
The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU will ignore the smuX.measure.count attribute and only make one measurement.
+
The readingBuffer will be cleared before taking any measurements unless the buffer is configured to append data.
+
Example
+
+
+
+
smua.measure.count = 10
+
smua.measure.v(smua.nvbuffer1)
+
+
Performs ten voltage measurements using SMU channel A and stores them in a buffer.
This attribute turns relative measurements on or off.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset SMU reset Recall setup
+
+
Not saved
+
+
0 (smuX.REL_OFF)
+
+
+
+
+
Usage
+
relEnable = smuX.measure.rel.enableY
+
smuX.measure.rel.enableY = relEnable
+
+
+
+
relEnable
+
+
Relative measurement control. Set relEnable to one of the following values:
+
0 or smuX.REL_OFF: Disables relative measurements
+
1 or smuX.REL_ON: Enables relative measurements
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)
+
+
+
+
Y
+
+
SMU measurement function (v = voltage, i = current, r = resistance, p = power)
+
+
+
+
+
Details
+
This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings will be offset by the relative offset value specified by smuX.measure.rel.levelY. Specifically, each returned measured relative reading will be the result of the following calculation:
+
Relative reading = Actual measured reading - Relative offset value
+
Example
+
+
+
+
smua.measure.rel.enablev = smua.REL_ON
+
+
Enables relative voltage measurements for SMU channel A.
This attribute sets the offset value for relative measurements.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset SMU reset Recall setup
+
+
Not saved
+
+
0
+
+
+
+
+
Usage
+
relValue = smuX.measure.rel.levelY
+
smuX.measure.rel.levelY = relValue
+
+
+
+
relValue
+
+
Relative measurement offset value
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)
+
+
+
+
Y
+
+
SMU measurement function (v = voltage, i = current, r = resistance, p = power)
+
+
+
+
+
Details
+
This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings will be offset by the value of this attribute. Specifically, each returned measured relative reading will be the result of the following calculation:
+
Relative reading = Actual measured reading - Relative offset value
+
Example
+
+
+
+
smua.measure.rel.levelv = smua.measure.v()
+
+
Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.
Source‑measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)
+
+
+
+
Y
+
+
SMU measurement function (v = voltage, i = current, r = resistance, p = power)
+
+
+
+
sourceValue
+
+
Source value to be set after the measurement is made
+
+
+
+
iReading
+
+
The current reading before stepping the source
+
+
+
+
vReading
+
+
The voltage reading before stepping the source
+
+
+
+
+
Details
+
The smuX.measureYandstep() function performs a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but performs two measurements simultaneously; one for current (i) and one for voltage (v).
+
Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.
+
The specified source value should be appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.
+
Both source and measure autorange must be disabled before using this function.
+
This function is provided for very fast execution of source-measure loops. The measurement will be made prior to stepping the source. Prior to using this function, and before any loop this function may be used in, set the source value to its initial level.
+
Example
+
+
+
+
local ivalues = {}
+
smua.source.rangev = 1500
+
smua.source.levelv = 0
+
smua.measure.rangei = 0.01
+
smua.source.output = smua.OUTPUT_ON
+
for index = 1, 10 do
+
ivalues[index] = smua.measureiandstep(index * 50)
+
end
+
ivalues[11] = smua.measure.i()
+
+
This use of the SMU channel A measure and step function measures current starting at a source value of 0 V. After each current measurement, the source is stepped 50 V for the next current measurement. The final source level is 500 V, where current is again measured.
This attribute contains the dedicated reading buffer.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Not applicable
+
+
See Details
+
+
Not applicable
+
+
+
+
+
Usage
+
bufferVar = smuX.nvbufferY
+
+
+
+
bufferVar
+
+
The dedicated reading buffer
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.nvbuffer1 applies to SMU channel A)
+
+
+
+
Y
+
+
SMU nonvolatile buffer (1 or 2)
+
+
+
+
+
Details
+
Each SMU channel contains two dedicated reading buffers: smuX.nvbuffer1 and smuX.nvbuffer2.
+
All routines that return measurements can also store them in either reading buffer. Overlapped measurements are always stored in a reading buffer. Synchronous measurements return either a single-point measurement or can be stored in a reading buffer if passed to the measurement command.
+
The dedicated reading buffers can be saved to internal nonvolatile memory (to retain data between power cycles) using the smuX.savebuffer() function.
+
Example
+
+
+
+
smua.measure.overlappedv(smua.nvbuffer1)
+
+
Store voltage readings from SMU channel A into SMU channel A dedicated reading buffer 1.
This attribute sets the state of the reading buffer's append mode.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Not applicable
+
+
See Details
+
+
0 (disabled)
+
+
+
+
+
Usage
+
state = bufferVar.appendmode
+
bufferVar.appendmode = state
+
+
+
+
state
+
+
The reading buffer append mode; set to one of the following:
+
0: Append mode off; new measure data overwrites the previous buffer content
1: Append mode on; appends new measure data to the present buffer content
+
+
+
bufferVar
+
+
The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer
+
+
+
+
+
Details
+
Assigning a value to this attribute enables or disables the buffer append mode. This value can only be changed with an empty buffer. Use bufferVar.clear() to empty the buffer.
+
For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.
+
If the append mode is set to 0, any stored readings in the buffer are cleared before new ones are stored. If append mode is set to 1, any stored readings remain in the buffer and new readings are added to the buffer after the stored readings.
+
With append mode on, the first new measurement is stored at rb[n+1], where n is the number of readings stored in buffer rb.
+
Example
+
+
+
+
buffer1.appendmode = 1
+
+
Append new readings to contents of the reading buffer named buffer1.
This attribute contains the timestamp of when the first reading was stored in the buffer.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Not applicable
+
+
See Details
+
+
0
+
+
+
+
+
Usage
+
basetime = bufferVar.basetimestamp
+
+
+
+
basetime
+
+
The timestamp of the first stored reading
+
+
+
+
bufferVar
+
+
The reading buffer; can be a dynamically allocated buffer (user‑defined), or a dedicated reading buffer (such as smua.nvbuffer1)
+
+
+
+
+
Details
+
This read-only attribute contains the timestamp (in seconds) of the first reading stored in a buffer (rb[1] stored in reading buffer rb). The timestamp is the number of seconds since 12:00 AM January 1, 1970 (UTC) that the measurement was performed and stored.
+
For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.
+
See the smuX.nvbufferY attribute for details on accessing dedicated reading buffers.
+
Example
+
+
+
+
basetime = smua.nvbuffer1.basetimestamp
+
+
+
print(basetime)
+
+
Read the timestamp for the first reading
+
stored in dedicated reading buffer 1.
+
Output: 1.2830e+09
+
The above output indicates that the timestamp is 1,283,000,000 seconds (which is Saturday, August 28, 2010 at 12:53:20 PM).
This attribute contains the capacity of the buffer.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Not applicable
+
+
See Details
+
+
Not applicable
+
+
+
+
+
Usage
+
bufferCapacity= bufferVar.capacity
+
+
+
+
bufferCapacity
+
+
The maximum number of readings the buffer can store
+
+
+
+
bufferVar
+
+
The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer
+
+
+
+
+
Details
+
This read-only attribute reads the number of readings that can be stored in the buffer.
+
For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.
+
The buffer's capacity does not change as readings fill the buffer. A dedicated reading buffer that only collects basic items can store over 140,000 readings. Turning on additional collection items, such as timestamps and source values, decreases the capacity of a dedicated reading buffer (for example, smua.nvbuffer1), but does not change the capacity of a user-defined dynamically allocated buffer. A user-defined dynamically allocated buffer has a fixed capacity that is set when the buffer is created.
+
See the smuX.nvbufferY attribute for details on accessing dedicated reading buffers. See the smuX.makebuffer() function for information on creating user-defined dynamically allocated reading buffers.
+
Example
+
+
+
+
bufferCapacity = smua.nvbuffer1.capacity
+
+
print(bufferCapacity)
+
+
Reads the capacity of dedicated reading buffer 1.
+
Output:
+
1.49789e+05
+
The above output indicates that the buffer can hold 149789 readings.
The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer
+
+
+
+
+
Details
+
This function clears all readings and associated recall attributes (for example, bufferVar.timestamps and bufferVar.statuses) from the specified buffer.
The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer
+
+
+
+
+
Details
+
This function clears all readings from the specified cache.
+
If you run successive operations that overwrite reading buffer data, the reading buffer may return stale cache data. This can happen when:
+
Initiating successive sweeps without reconfiguring the sweep measurements. Watch for this when running Lua code remotely on more than one node, because values in the reading buffer cache may change while the Lua code is running.
Overwriting data in the reading buffer by setting the bufferVar.fillmode attribute to smuX.FILL_WINDOW.
To avoid this, you can include explicit calls to the bufferVar.clearcache() function to remove stale values from the reading buffer cache.
+
Example
+
+
+
+
smua.nvbuffer1.clearcache()
+
+
Clears the reading buffer cache for dedicated reading buffer 1.
This attribute sets whether or not source values will be stored with the readings in the buffer.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Not applicable
+
+
See Details
+
+
0 (disabled)
+
+
+
+
+
Usage
+
state = bufferVar.collectsourcevalues
+
bufferVar.collectsourcevalues =state
+
+
+
+
state
+
+
Source value collection status; set to one of the following:
+
0: Source value collection disabled (off)
1: Source value collection enabled (on)
+
+
+
bufferVar
+
+
The reading buffer; can be a dynamically allocated buffer (user‑defined), or a dedicated reading buffer (such as smua.nvbuffer1)
+
+
+
+
+
Details
+
Assigning a value to this attribute enables or disables the storage of source values. Reading this attribute returns the state of source value collection. This value can only be changed with an empty buffer. Empty the buffer using the bufferVar.clear() function.
+
For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.
+
When on, source values will be stored with readings in the buffer. This requires four extra bytes of storage per reading. Turning on additional collection items, such as source values (this attribute) and timestamps, decreases the capacity of a dedicated reading buffer (for example, smua.nvbuffer1), but does not change the capacity of a user-defined dynamically allocated buffer.
+
Example
+
+
+
+
smua.nvbuffer1.collectsourcevalues = 1
+
+
Include source values with readings for dedicated reading buffer 1.
This attribute sets whether or not timestamp values will be stored with the readings in the buffer.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Not applicable
+
+
See Details
+
+
0 (disabled)
+
+
+
+
+
Usage
+
state = bufferVar.collecttimestamps
+
bufferVar.collecttimestamps = state
+
+
+
+
state
+
+
Timestamp value collection status; set to one of the following:
+
0: Timestamp value collection disabled (off)
1: Timestamp value collection enabled (on)
+
+
+
bufferVar
+
+
The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer
+
+
+
+
+
Details
+
Assigning a value to this attribute enables or disables the storage of timestamps. Reading this attribute returns the state of timestamp collection.
+
For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.
+
When on, timestamp values will be stored with readings in the buffer. This requires four extra bytes of storage per reading. Turning on additional collection items, such as timestamps (this attribute) and source values, decreases the capacity of a dedicated reading buffer (for example, smua.nvbuffer1), but does not change the capacity of a user-defined dynamically allocated buffer.
+
This value, off (0) or on (1), can only be changed when the buffer is empty. Empty the buffer using the bufferVar.clear() function.
+
Example
+
+
+
+
smua.nvbuffer1.collecttimestamps = 1
+
+
Include timestamps with readings for dedicated reading buffer 1.
This attribute contains the timestamp's resolution.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Not applicable
+
+
See Details
+
+
1e-6 (1 ms)
+
+
+
+
+
Usage
+
resolution = bufferVar.timestampresolution
+
+
+
+
resolution
+
+
Timestamp resolution in seconds
+
+
+
+
bufferVar
+
+
The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer
+
+
+
+
+
Details
+
Assigning a value to this attribute sets the resolution for the timestamps. Reading this attribute returns the timestamp resolution value. This value can only be changed with an empty buffer. Empty the buffer using the bufferVar.clear() function.
+
The finest timestamp resolution is 0.000001 seconds (1 µs). At this resolution, the reading buffer can store unique timestamps for up to 71 minutes. This value can be increased for very long tests.
+
The value specified when setting this attribute will be rounded to an even power of 2 µs.
+
For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.
+
Example
+
+
+
+
smua.nvbuffer1.timestampresolution = 0.000008
+
+
+
Sets the timestamp resolution of dedicated reading buffer 1 to 8 µs.
This attribute contains the state of the remote/local sense mode.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU reset Instrument reset Recall setup
+
+
Saved setup
+
+
0 (smuX.SENSE_LOCAL)
+
+
+
+
+
Usage
+
senseMode = smuX.sense
+
smuX.sense = senseMode
+
+
+
+
senseMode
+
+
The sense mode; set to one of the following:
+
0 or smuX.SENSE_LOCAL: Selects local sense (2-wire)
+
1 or smuX.SENSE_REMOTE: Selects remote sense (4-wire)
+
3 or smuX.SENSE_CALA: Selects calibration sense mode
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.sense applies to SMU channel A)
+
+
+
+
+
Details
+
Source-measure operations are performed using either 2-wire local sense connections or 4-wire remote sense connections. Writing to this attribute selects the sense mode.
+
The smuX.SENSE_CALA mode is only used for calibration and may only be selected when calibration is enabled.
+
The sense mode can be changed between local and remote while the output is on.
+
The calibration sense mode cannot be selected while the output is on.
+
Resetting the instrument selects the local sense mode.
This attribute contains the state of the source autorange control (on/off).
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU reset Instrument reset Recall setup
+
+
Saved setup
+
+
1 (smuX.AUTORANGE_ON)
+
+
+
+
+
Usage
+
sourceAutorange = smuX.source.autorangeY
+
smuX.source.autorangeY = sourceAutorange
+
+
+
+
sourceAutorange
+
+
The state of the source autorange control. Set to one of the following:
+
0 or smuX.AUTORANGE_OFF: Disables source autorange
+
1 or smuX.AUTORANGE_ON: Enables source autorange
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.source.autorangev applies to SMU channel A)
+
+
+
+
Y
+
+
SMU source function (v = voltage, i = current)
+
+
+
+
+
Details
+
This attribute indicates the source autorange state. Its value will be smuX.AUTORANGE_OFF when the SMU source circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.
+
Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed source range. The fixed range used will be the present SMU source circuit range.
+
Setting this attribute to smuX.AUTORANGE_ON puts the SMU source circuit into autorange mode. If the source output is on, the SMU will immediately change range to the range most appropriate for the value being sourced if that range is different from the present SMU range.
+
Autorange will disable if the source level is edited from the front panel. Setting the source range turns off autorange when set by using the smuX.source.rangeY attribute as well.
+
Resetting the instrument selects the smuX.AUTORANGE_ON.
This attribute contains the state of source compliance.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Not applicable
+
+
Not saved
+
+
Not applicable
+
+
+
+
+
Usage
+
compliance = smuX.source.compliance
+
+
+
+
compliance
+
+
The state of source compliance
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.source.compliance applies to SMU channel A)
+
+
+
+
+
Details
+
This read-only attribute contains the source compliance state (true or false).
+
true indicates that the limit function is in control of the source (source in compliance).
false indicates that the source function is in control of the output (source not in compliance).
Writing to this attribute will generate an error.
+
Reading this attribute also updates the status model and the front panel with generated compliance information. See Current Limit (ILMT) shown in the status model diagram for the Measurement event registers. The Voltage Limit (VLMT) is not shown in the status model diagram for the Measurement event registers, but is similar to the Current Limit (ILMT).
+
Example
+
+
+
+
compliance = smua.source.compliance
+
+
print(compliance)
+
+
Reads the source compliance state for SMU channel A.
+
Output: true
+
This output indicates that a configured limit has been reached (voltage, current, or power limit).
Set to your desired source delay value (for example, to specify an additional 10 ms source delay, set the value to 0.010)
+
Alternatively, you can set it one of the following values:
+
0 or smuX.DELAY_OFF: No delay
+
-1 or smuX.DELAY_AUTO: Automatic delay value
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.source.delay applies to SMU channel A)
+
+
+
+
+
Details
+
This attribute allows for additional delay (settling time) after an output step. Set sDelay to a user-defined value (in seconds). Alternatively, set sDelay to smuX.DELAY_OFF or smuX.DELAY_AUTO.
+
The smuX.DELAY_AUTO setting causes a range-dependent delay to be inserted when the source is changed. Range-dependent delays are based on the output settling time values of the Model 2657A specifications.
+
Example
+
+
+
+
smua.source.delay = smua.DELAY_AUTO
+
+
Sets the delay for SMU channel A to automatic (a range-dependent delay is inserted when ever the source is changed).
Source‑measure unit (SMU) channel (for example, smua.source.calibratev() applies to SMU channel A)
+
+
+
+
Y
+
+
SMU source function (v = voltage, i = current)
+
+
+
+
range
+
+
The measurement range to calibrate
+
+
+
+
cp1Expected
+
+
The source value programmed for calibration point 1
+
+
+
+
cp1Reference
+
+
The reference measurement for calibration point 1 as measured externally
+
+
+
+
cp2Expected
+
+
The source value programmed for calibration point 2
+
+
+
+
cp2Reference
+
+
The reference measurement for calibration point 2 as measured externally
+
+
+
+
+
Details
+
This function generates and activates new calibration constants for the given range.
+
The positive and negative polarities of the source must be calibrated separately. Use a positive value for range to calibrate the positive polarity and a negative value for range to calibrate the negative polarity. Do not use 0.0 for a negative calibration point as 0.0 is considered a positive number.
+
Typically, the two calibration points used will be near zero for calibration point 1 and 90% of full scale for calibration point 2. Full scale for calibration point 2 should be avoided if the SMU's source is substantially out of calibration.
+
The two reference measurements must be made with the source using the active calibration set. For example, source a value, measure it, and do not change the active calibration set before issuing this command.
+
The new calibration constants will be activated immediately but they will not be written to nonvolatile storage. Use smuX.cal.save() to commit the new constants to nonvolatile storage.
+
The active calibration constants will stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile storage with the smuX.cal.restore() function.
+
This function will be disabled until a successful call to smuX.cal.unlock() is made.
SMU channel A calibrates voltage source using the following values: calibrate the 200 V range, 1e-30 for +zero source output value, 1e-5 for +zero DMM measurement reading, 180 for +FS source output value, and 179.8 for the +FS DMM measurement reading.
This attribute sets the source function (V source or I source).
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU reset Instrument reset Recall setup
+
+
Saved setup
+
+
1 (smuX.OUTPUT_DCVOLTS)
+
+
+
+
+
Usage
+
sFunction = smuX.source.func
+
smuX.source.func = sFunction
+
+
+
+
sFunction
+
+
The source function. Set to one of the following values:
+
0 or smuX.OUTPUT_DCAMPS: Selects current source function
+
1 or smuX.OUTPUT_DCVOLTS: Selects voltage source function
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.source.func applies to SMU channel A)
+
+
+
+
+
Details
+
Reading this attribute indicates the output function of the source for the specified SMU channel. Setting this attribute configures the specified SMU channel as either a voltage source or a current source.
+
Example
+
+
+
+
smua.source.func = smua.OUTPUT_DCAMPS
+
+
Sets the source function of SMU channel A to be a current source.
The source value; set to one of the following values: Voltage: 0 V to ±3000 V
+
Current: 0 A to ±120 mA
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.source.levelv applies to SMU channel A)
+
+
+
+
Y
+
+
SMU source function (v = voltage, i = current)
+
+
+
+
+
Details
+
This attribute configures the output level of the voltage or current source.
+
If the source is configured as a voltage source and the output is on, the new smuX.source.levelv setting will be sourced immediately. If the output is off or the source is configured as a current source, the voltage level will be sourced when the source is configured as a voltage source and the output is turned on.
+
If the source is configured as a current source and the output is on, the new smuX.source.leveli setting will be sourced immediately. If the output is off or the source is configured as a voltage source, the current level will be sourced when the source is configured as a current source and the output is turned on.
+
The sign of sourceLevel dictates the polarity of the source. Positive values generate positive voltage or current from the high terminal of the source relative to the low terminal. Negative values generate negative voltage or current from the high terminal of the source relative to the low terminal.
+
The reset() function sets the source levels to 0 V and 0 A.
This attribute sets the lowest source range that will be used during autoranging.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU reset Instrument reset Recall setup
+
+
Saved setup
+
+
Current: 1e-9 (1 nA)
+
Voltage: 200 (200 V)
+
+
+
+
+
Usage
+
sourceRangeLow = smuX.source.lowrangeY
+
smuX.source.lowrangeY = sourceRangeLow
+
+
+
+
sourceRangeLow
+
+
Set to the lowest voltage (in volts) or current (in amperes) range to be used
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.source.lowrangev applies to SMU channel A)
+
+
+
+
Y
+
+
SMU source function (v = voltage, i = current)
+
+
+
+
+
Details
+
This attribute is used with source autoranging to put a lower bound on the range used. Lower ranges generally require greater settling times. By setting a low-range value, sourcing small values might be able to be made with less settling time.
+
If the instrument is set to autorange and it is on a range lower than the one specified by sourceRangeLow, the source range will be changed to the range specified by sourceRangeLow.
+
Example
+
+
+
+
smua.source.lowrangei = 1e-6
+
+
The lower boundary for current source autoranging is 1 mA.
This attribute sets the limit (current or voltage) used when the source‑measure unit (SMU) is in normal output-off mode.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU reset Instrument reset Recall setup
+
+
Saved setup
+
+
Current: 1e-3 (1 mA) Voltage: 40 (40 V)
+
+
+
+
+
Usage
+
sourceLimit = smuX.source.offlimitY
+
smuX.source.offlimitY = sourceLimit
+
+
+
+
sourceLimit
+
+
Set to the limit to be used when the SMU is in normal output-off mode
+
+
+
+
X
+
+
SMU channel (for example, smua.source.offlimiti applies to SMU channel A)
+
+
+
+
Y
+
+
SMU source function (v = voltage, i = current)
+
+
+
+
+
Details
+
Setting the current limit to lower than 1 mA may interfere with operation of the contact check function. See smuX.contact.check() and smuX.contact.r() for details.
+
Example
+
+
+
+
smua.source.offlimiti = 10e-3
+
+
Changes the normal output-off mode limit to 10 mA for SMU channel A.
The output-off setting; set to one of the following values:
+
0 or smuX.OUTPUT_NORMAL: Configures the source function according to smuX.source.offfunc attribute
+
1 or smuX.OUTPUT_ZERO: Configures source to output 0 V as smuX.OUTPUT_NORMAL with different compliance handling (see the Details below)
+
2 or smuX.OUTPUT_HIGH_Z: Opens the output relay when the output is turned off
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.source.offmode applies to SMU channel A)
+
+
+
+
+
Details
+
Reading this attribute gives the output-off mode of the source. Setting this attribute configures the SMU output-off mode.
+
The default sourceOffMode is smuX.OUTPUT_NORMAL. In this mode, the source function will be configured according to the smuX.source.offfunc attribute. The smuX.source.offfunc attribute controls whether the SMU is configured as a 0 V voltage source or a 0 A current source. When the SMU is operating as a 0 A current source, the smuX.source.offlimitv attribute sets the voltage limit, just as the smuX.source.offlimiti attribute sets the current limit when the SMU is operating as a 0 V voltage source.
+
When the sourceOffMode is set to smuX.OUTPUT_ZERO, the source will be configured to output 0 V just as smuX.OUTPUT_NORMAL mode with smuX.source.offfunc = smuX.OUTPUT_DCVOLTS. If the source function is voltage, the current limit will not be changed. If the source function is current, the current limit will be set to the current source level or 10 percent of the current source range, whichever is greater.
+
When offmode is set to smuX.OUTPUT_HIGH_Z, the SMU will open the output relay when the output is turned off.
+
Example
+
+
+
+
smua.source.offmode = smua.OUTPUT_HIGH_Z
+
+
Sets the output‑off mode for SMU channel A to open the output relay when the output is turned off.
This attribute sets source output state (on or off).
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU reset Instrument reset Recall setup
+
+
Not saved
+
+
0 (smuX.OUTPUT_OFF)
+
+
+
+
+
Usage
+
sourceOutput = smuX.source.output
+
smuX.source.output = sourceOutput
+
+
+
+
sourceOutput
+
+
The source's output state setting; set to one of the following values:
+
0 or smuX.OUTPUT_OFF: Turns off the source output
+
1 or smuX.OUTPUT_ON: Turns on the source output
+
2 or smuX.OUTPUT_HIGH_Z: Turns off the output in high Z mode (allows you to go to high Z mode without first setting the smuX.source.offmode attribute to smuX.OUTPUT_HIGH_Z)
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.source.output applies to SMU channel A)
+
+
+
+
+
Details
+
Reading this attribute gives the output state of the source. Setting this attribute will turn the output of the source on or off. The default for the source is off. When the output is turned on, the SMU will source either voltage or current as dictated by the smuX.source.func setting.
+
Setting this attribute equal to smuX.OUTPUT_HIGH_Z will cause the output to turn off and go to the High Z mode. If the smuX.source.output is then read it will return 0.
Set to the maximum expected voltage or current to be sourced
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)
+
+
+
+
Y
+
+
SMU source function (v = voltage, i = current)
+
+
+
+
+
Details
+
This attribute contains a value that sets the source‑measure unit (SMU) to a fixed range large enough to source the value. When read, the attribute contains the range the instrument is presently on when in autorange.
+
Assigning a value to this attribute sets the SMU to a fixed range large enough to source the assigned value. The instrument will select the best range for sourcing a value of rangeValue.
+
Reading this attribute returns the positive full-scale value of the source range the SMU is currently using. With source autoranging enabled, the output level controls the range. Querying the range after the level is set will return the range the unit chose as appropriate for that source level.
+
This attribute is primarily intended to eliminate the time required by the automatic range selection performed by a sourcing instrument. Because selecting a fixed range will prevent autoranging, an overrange condition can occur.
Set to the source settling mode. Set to one of the following values:
+
0 or smuX.SETTLE_SMOOTH: Turns off additional settling operations (default)
+
1 or smuX.SETTLE_FAST_RANGE: Instructs the source‑measure unit (SMU) to use a faster procedure when changing ranges
+
2 or smuX.SETTLE_FAST_POLARITY: Instructs the SMU to change polarity without going to zero
+
3 or smuX.SETTLE_DIRECT_IRANGE: Instructs the SMU to change the current range directly
+
128 or smuX.SETTLE_FAST_ALL: Enables all smuX.SETTLE_FAST_* operations
+
+
+
+
X
+
+
SMU channel (for example, smua.source.settling applies to SMU channel A)
+
+
+
+
+
Details
+
Using smuX.SETTLE_FAST_RANGE may cause the SMU to exceed the range change overshoot specification.
+
smuX.SETTLE_FAST_POLARITY does not go to zero when changing polarity and may create inconsistencies at the zero crossing.
+
smuX.SETTLE_DIRECT_IRANGE switches the SMU directly to the target range instead of the default “range-by-range” method. This option is mutually exclusive of any other smuX.SETTLE_FAST_* commands.
Set to the source sink mode. Set to one of the following values:
+
0 or smuX.DISABLE: Turns off sink mode
+
1 or smuX.ENABLE: Turns on sink mode
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.source.sink applies to SMU channel A)
+
+
+
+
+
Details
+
This attribute enables or disables sink mode. When enabled, sink mode reduces the source limit inaccuracy seen when operating in quadrants II and IV (quadrants I and III will show this source limit inaccuracy).
This attribute sets the arm count in the trigger model.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU reset Instrument reset Recall setup
+
+
Not saved
+
+
1
+
+
+
+
+
Usage
+
triggerArmCount = smuX.trigger.arm.count
+
smuX.trigger.arm.count = triggerArmCount
+
+
+
+
triggerArmCount
+
+
The arm count in the trigger model
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.trigger.arm.count applies to SMU channel A)
+
+
+
+
+
Details
+
During a sweep, the SMU iterates through the arm layer of the trigger model this many times. After performing this many iterations, the SMU returns to an idle state.
+
If this count is set to zero, the SMU stays in the trigger model indefinitely until aborted.
+
Example
+
+
+
+
smua.trigger.arm.count = 5
+
+
Sets the SMU channel A to iterate through the arm layer of the trigger model five times and then return to the idle state.
This function sets the arm event detector to the detected state.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
smuX.trigger.arm.set()
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.trigger.arm.set() applies to SMU channel A)
+
+
+
+
+
Details
+
The SMU will automatically clear all the event detectors when the smuX.trigger.initiate() function is executed. This function should be called after the sweep is initiated.
+
A common example of when this function can be used is when you want the SMU to immediately perform an action the first time through the trigger model even if a programmed trigger event does not occur.
+
This function can also be used to start actions on the SMU in case of a missed trigger event.
+
Example
+
+
+
+
smua.trigger.arm.set()
+
+
+
Sets the arm event detector to the detected state for SMU channel A.
This attribute selects the event that will cause the arm event detector to enter the detected state.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU reset Instrument reset Recall setup
+
+
Not saved
+
+
0
+
+
+
+
+
Usage
+
eventID = smuX.trigger.arm.stimulus
+
smuX.trigger.arm.stimulus = eventID
+
+
+
+
eventID
+
+
Event that triggers the arm detector
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.trigger.arm.stimulus applies to SMU channel A)
+
+
+
+
+
Details
+
Set this attribute to the event ID of any trigger event generator to wait for that event.
+
Set this attribute to zero to bypass waiting for events at the arm event detector (the SMU continues uninterrupted through the remote trigger model). Set eventID to one of the existing trigger event IDs shown in the following table.
+
+
+
+
+
+
+
Trigger event IDs*
+
+
+
+
Event ID
+
+
Event description
+
+
+
+
smua.trigger.SWEEPING_EVENT_ID
+
+
Occurs when the source‑measure unit (SMU) transitions from the idle state to the arm layer of the trigger model
+
+
+
+
smua.trigger.ARMED_EVENT_ID
+
+
Occurs when the SMU moves from the arm layer to the trigger layer of the trigger model
+
+
+
+
smua.trigger.SOURCE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a source action
+
+
+
+
smua.trigger.MEASURE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a measure action
+
+
+
+
smua.trigger.PULSE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a pulse
+
+
+
+
smua.trigger.SWEEP_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a sweep
+
+
+
+
smua.trigger.IDLE_EVENT_ID
+
+
Occurs when the SMU returns to the idle state
+
+
+
+
digio.trigger[N].EVENT_ID
+
+
Occurs when an edge is detected on a digital I/O line
+
+
+
+
tsplink.trigger[N].EVENT_ID
+
+
Occurs when an edge is detected on a TSP‑Link line
+
+
+
+
lan.trigger[N].EVENT_ID
+
+
Occurs when the appropriate LXI trigger packet is received on LAN trigger object N
+
+
+
+
display.trigger.EVENT_ID
+
+
Occurs when the TRIG key on the front panel is pressed
+
+
+
+
trigger.EVENT_ID
+
+
Occurs when a *TRG command is received on the remote interface
+
GPIB only: Occurs when a GET bus command is received
+
VXI-11 only: Occurs with the VXI-11 command device_trigger; reference the VXI-11 standard for additional details on the device trigger operation
+
+
+
+
trigger.blender[N].EVENT_ID
+
+
Occurs after a collection of events is detected
+
+
+
+
trigger.timer[N].EVENT_ID
+
+
Occurs when a delay expires
+
+
+
+
* Use the name of the trigger event ID to set the stimulus value rather than the numeric value. Using the name makes the code compatible for future upgrades (for example, if the numeric values must change when enhancements are added to the instrument).
+
+
+
+
+
Example
+
+
+
+
smua.trigger.arm.stimulus =
+
trigger.timer[1].EVENT_ID
+
+
An event on trigger timer 1 causes the arm event detector to enter the detected state.
This attribute turns automatic clearing of the event detectors on or off.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU reset Instrument reset Recall setup
+
+
Not saved
+
+
0 (smuX.DISABLE)
+
+
+
+
+
Usage
+
autoClear = smuX.trigger.autoclear
+
smuX.trigger.autoclear = autoClear
+
+
+
+
autoClear
+
+
Auto clear setting; set to one of the following values:
+
0 or smuX.DISABLE: Turns off automatic clearing of the event detectors
+
1 or smuX.ENABLE: Turns on automatic clearing of the event detectors
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.trigger.autoclear applies to SMU channel A)
+
+
+
+
+
Details
+
This attribute enables or disables automatic clearing of the trigger model state machine event detectors when the SMU transitions from the arm layer to the trigger layer.
+
Only the detected state of the event detectors will be cleared.
+
The overrun status of the event detectors is not automatically cleared when the SMU transitions from the arm layer to the trigger layer.
+
The event detectors are always cleared when a sweep is initiated.
This attribute sets the trigger count in the trigger model.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU reset Instrument reset Recall setup
+
+
Not saved
+
+
1
+
+
+
+
+
Usage
+
triggerCount = smuX.trigger.count
+
smuX.trigger.count = triggerCount
+
+
+
+
triggerCount
+
+
The trigger count is the number of times the source‑measure unit (SMU) will iterate in the trigger layer for any given sweep
+
+
+
+
X
+
+
SMU channel (for example, smua.trigger.count applies to SMU channel A)
+
+
+
+
+
Details
+
During a sweep, the SMU iterates through the trigger layer of the trigger model this many times. After performing this many iterations, the SMU returns to the arm layer.
+
If this count is set to zero (0), the SMU stays in the trigger model indefinitely until aborted.
This attribute enables or disables pulse mode sweeps.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU reset Instrument reset Recall setup
+
+
Not saved
+
+
1 (smuX.SOURCE_HOLD)
+
+
+
+
+
Usage
+
pulseAction = smuX.trigger.endpulse.action
+
smuX.trigger.endpulse.action = pulseAction
+
+
+
+
pulseAction
+
+
The pulse mode setting; set to one of the following values (see Details for definition):
+
0 or smuX.SOURCE_IDLE
+
1 or smuX.SOURCE_HOLD
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.trigger.endpulse.action applies to SMU channel A)
+
+
+
+
+
Details
+
When set to smuX.SOURCE_HOLD, this attribute disables pulse mode sweeps, holding the source level for the remainder of the step.
+
When set to smuX.SOURCE_IDLE, this attribute enables pulse mode sweeps, setting the source level to the programmed (idle) level at the end of the pulse.
+
Example
+
+
+
+
smua.trigger.endpulse.action = smua.SOURCE_IDLE
+
smua.trigger.endpulse.stimulus =
+
trigger.timer[1].EVENT_ID
+
+
Configure the end pulse action to achieve a pulse and configure trigger timer 1 to control the end of pulse.
This function sets the end pulse event detector to the detected state.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
smuX.trigger.endpulse.set()
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.trigger.endpulse.set() applies to SMU channel A)
+
+
+
+
+
Details
+
This function sets the end pulse event detector to the detected state.
+
The SMU automatically clears all the event detectors when the smuX.trigger.initiate() function is executed. This function should be called after the sweep is initiated. Make sure that if the event detectors are configured to clear automatically (because the smuX.trigger.autoclear attribute is set to smuX.ENABLE) that this command is issued after the SMU has entered the trigger layer.
This attribute defines which event will cause the end pulse event detector to enter the detected state.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU reset Instrument reset Recall setup
+
+
Not saved
+
+
0
+
+
+
+
+
Usage
+
eventID = smuX.trigger.endpulse.stimulus
+
smuX.trigger.endpulse.stimulus = eventID
+
+
+
+
eventID
+
+
Set to the event that triggers the end pulse source off action
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.trigger.endpulse.stimulus applies to SMU channel A)
+
+
+
+
+
Details
+
Set this attribute to the event ID of any trigger event generator to wait for that event. To bypass waiting for an event, set this attribute's value to 0. Set eventID to one of the existing trigger event IDs shown in the following table.
+
+
+
+
+
+
+
Trigger event IDs*
+
+
+
+
Event ID
+
+
Event description
+
+
+
+
smua.trigger.SWEEPING_EVENT_ID
+
+
Occurs when the source‑measure unit (SMU) transitions from the idle state to the arm layer of the trigger model
+
+
+
+
smua.trigger.ARMED_EVENT_ID
+
+
Occurs when the SMU moves from the arm layer to the trigger layer of the trigger model
+
+
+
+
smua.trigger.SOURCE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a source action
+
+
+
+
smua.trigger.MEASURE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a measure action
+
+
+
+
smua.trigger.PULSE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a pulse
+
+
+
+
smua.trigger.SWEEP_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a sweep
+
+
+
+
smua.trigger.IDLE_EVENT_ID
+
+
Occurs when the SMU returns to the idle state
+
+
+
+
digio.trigger[N].EVENT_ID
+
+
Occurs when an edge is detected on a digital I/O line
+
+
+
+
tsplink.trigger[N].EVENT_ID
+
+
Occurs when an edge is detected on a TSP‑Link line
+
+
+
+
lan.trigger[N].EVENT_ID
+
+
Occurs when the appropriate LXI trigger packet is received on LAN trigger object N
+
+
+
+
display.trigger.EVENT_ID
+
+
Occurs when the TRIG key on the front panel is pressed
+
+
+
+
trigger.EVENT_ID
+
+
Occurs when a *TRG command is received on the remote interface
+
GPIB only: Occurs when a GET bus command is received
+
VXI-11 only: Occurs with the VXI-11 command device_trigger; reference the VXI-11 standard for additional details on the device trigger operation
+
+
+
+
trigger.blender[N].EVENT_ID
+
+
Occurs after a collection of events is detected
+
+
+
+
trigger.timer[N].EVENT_ID
+
+
Occurs when a delay expires
+
+
+
+
* Use the name of the trigger event ID to set the stimulus value rather than the numeric value. Using the name makes the code compatible for future upgrades (for example, if the numeric values must change when enhancements are added to the instrument).
+
+
+
+
+
Example
+
+
+
+
smua.trigger.endpulse.action = smua.SOURCE_IDLE
+
smua.trigger.endpulse.stimulus =
+
trigger.timer[1].EVENT_ID
+
+
Configure the end pulse action to achieve a pulse and select the event trigger.timer[1].EVENT_ID that will cause the arm event detector to enter the detected state.
This attribute sets the action of the source at the end of a sweep.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU reset Instrument reset Recall setup
+
+
Not saved
+
+
0 (smuX.SOURCE_IDLE)
+
+
+
+
+
Usage
+
action = smuX.trigger.endsweep.action
+
smuX.trigger.endsweep.action = action
+
+
+
+
action
+
+
The source action at the end of a sweep; set to one of the following values:
+
0 or smuX.SOURCE_IDLE: Sets the source level to the programmed (idle) level at the end of the sweep
+
1 or smuX.SOURCE_HOLD: Sets the source level to stay at the level of the last step
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.trigger.endsweep.action applies to SMU channel A)
+
+
+
+
+
Details
+
Use this attribute to configure the source action at the end of the sweep. The SMU can be programmed to return to the idle source level or hold the last value of the sweep.
+
Example
+
+
+
+
smua.trigger.endsweep.action = smua.SOURCE_IDLE
+
+
Sets SMU channel A to return the source back to the idle source level at the end of a sweep.
Source‑measure unit (SMU) channel (for example, smua.trigger.initiate() applies to SMU channel A)
+
+
+
+
+
Details
+
This function causes the SMU to clear the four trigger model event detectors and enter its trigger model state machine (moves the SMU from the idle state into the arm layer).
+
To perform source actions during the sweep, before calling this function, it is necessary to configure and enable one of the sweep source actions: smuX.trigger.source.linearY(), smuX.trigger.source.listY(), smuX.trigger.source.logY()and the measure action smuX.trigger.measure.Y().
+
If you run this function more than once without reconfiguring the sweep measurements, the caches on the configured measurement reading buffers will hold stale data; use the bufferVar.clearcache() function to remove stale values from the reading buffer cache.
+
This function initiates an overlapped operation.
+
Example
+
+
+
+
smua.trigger.initiate()
+
+
+
Starts a preconfigured sweep and clears the event detectors for SMU channel A.
This attribute controls measurement actions during a sweep.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU reset Instrument reset Recall setup
+
+
Not saved
+
+
0 (smuX.DISABLE)
+
+
+
+
+
Usage
+
action = smuX.trigger.measure.action
+
smuX.trigger.measure.action = action
+
+
+
+
action
+
+
The sweep measure action; set to one of the following values:
+
0 or smuX.DISABLE: Do not make measurements during the sweep
+
1 or smuX.ENABLE: Make measurements during the sweep
+
2 or smuX.ASYNC: Make measurements during the sweep, but asynchronously
+
with the source area of the trigger model
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.trigger.measure.action applies to SMU channel A)
+
+
+
+
+
Details
+
With this attribute enabled (setting action to smuX.ENABLE or smuX.ASYNC), configure the measurement with one of the smuX.trigger.measure.Y() functions.
+
If this attribute is set to smuX.ASYNC:
+
Asynchronous sweep measurements can only be used with measure autoranging turned off. To turn measure autoranging off for all measurements during the sweep, set thesmuX.measure.autorangeY attribute to smuX.AUTORANGE_OFF.
If the integrating ADC is selected (smuX.measure.adc attribute is set to smuX.ADC_INTEGRATE), autozero must also be turned off. To turn off autozero, set the smuX.measure.autozero attribute to smuX.AUTOZERO_OFF or smuX.AUTOZERO_ONCE.
If either of the above items is incorrectly configured, the smuX.trigger.initiate() function will generate an error.
This function sets the measure event detector to the detected state.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
smuX.trigger.measure.set()
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.trigger.measure.set() applies to SMU channel A)
+
+
+
+
+
Details
+
This function is useful whenever you want the SMU to continue operation without waiting for a programmed trigger event. When called, this function immediately satisfies the event detector, allowing the SMU to continue through the trigger model.
+
A common example of when this function can be used is when you want the SMU to immediately perform an action the first time through the trigger model even if a programmed trigger event does not occur. Make sure that if the event detectors are configured to clear automatically (because the smuX.trigger.autoclear attribute is set to smuX.ENABLE) that this command is issued after the SMU has entered the trigger layer. This function can also be used to start actions on the SMU in case of a missed trigger event.
+
The SMU will automatically clear all event detectors when the smuX.trigger.initiate() function is executed. This function should be called after the sweep is initiated.
This attribute selects which event will cause the measure event detector to enter the detected state.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU reset Instrument reset Recall setup
+
+
Not saved
+
+
0
+
+
+
+
+
Usage
+
eventID = smuX.trigger.measure.stimulus
+
smuX.trigger.measure.stimulus = eventID
+
+
+
+
eventID
+
+
Event that triggers the measure detector
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.trigger.measure.stimulus applies to SMU channel A)
+
+
+
+
+
Details
+
Set this attribute to the event ID of any trigger event generator to wait for that event. When set, the SMU waits for the event at the measure event detector portion of the trigger model.
+
Set this attribute to zero to bypass waiting for an event (the SMU continues uninterrupted through the remote trigger model). Set eventID to one of the existing trigger event IDs shown in the following table.
+
+
+
+
+
+
+
Trigger event IDs*
+
+
+
+
Event ID
+
+
Event description
+
+
+
+
smua.trigger.SWEEPING_EVENT_ID
+
+
Occurs when the source‑measure unit (SMU) transitions from the idle state to the arm layer of the trigger model
+
+
+
+
smua.trigger.ARMED_EVENT_ID
+
+
Occurs when the SMU moves from the arm layer to the trigger layer of the trigger model
+
+
+
+
smua.trigger.SOURCE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a source action
+
+
+
+
smua.trigger.MEASURE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a measure action
+
+
+
+
smua.trigger.PULSE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a pulse
+
+
+
+
smua.trigger.SWEEP_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a sweep
+
+
+
+
smua.trigger.IDLE_EVENT_ID
+
+
Occurs when the SMU returns to the idle state
+
+
+
+
digio.trigger[N].EVENT_ID
+
+
Occurs when an edge is detected on a digital I/O line
+
+
+
+
tsplink.trigger[N].EVENT_ID
+
+
Occurs when an edge is detected on a TSP‑Link line
+
+
+
+
lan.trigger[N].EVENT_ID
+
+
Occurs when the appropriate LXI trigger packet is received on LAN trigger object N
+
+
+
+
display.trigger.EVENT_ID
+
+
Occurs when the TRIG key on the front panel is pressed
+
+
+
+
trigger.EVENT_ID
+
+
Occurs when a *TRG command is received on the remote interface
+
GPIB only: Occurs when a GET bus command is received
+
VXI-11 only: Occurs with the VXI-11 command device_trigger; reference the VXI-11 standard for additional details on the device trigger operation
+
+
+
+
trigger.blender[N].EVENT_ID
+
+
Occurs after a collection of events is detected
+
+
+
+
trigger.timer[N].EVENT_ID
+
+
Occurs when a delay expires
+
+
+
+
* Use the name of the trigger event ID to set the stimulus value rather than the numeric value. Using the name makes the code compatible for future upgrades (for example, if the numeric values must change when enhancements are added to the instrument).
This function configures the measurements that are to be made in a subsequent sweep.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
smuX.trigger.measure.Y(rbuffer)
+
smuX.trigger.measure.iv(ibuffer, vbuffer)
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)
+
+
+
+
Y
+
+
SMU measurement type (v = voltage, i = current, r = resistance, p = power)
+
+
+
+
rbuffer
+
+
A reading buffer object where the readings will be stored
+
+
+
+
ibuffer
+
+
A reading buffer object where current readings will be stored
+
+
+
+
vbuffer
+
+
A reading buffer object where voltage readings will be stored
+
+
+
+
+
Details
+
The measurements, as they are performed, are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings will be available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.
+
The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.
+
If a given reading buffer contains any data, it will be cleared prior to taking any measurements, unless the reading buffer has been configured to append data.
+
The SMU only retains the last call to any one of these functions and only that measure action will be performed.
+
After configuring the measurements to make with this function, remember to enable the measure action by setting smuX.trigger.measure.action = smuX.ENABLE.
+
Example
+
+
+
+
smua.trigger.measure.v(vbuffername)
+
smua.trigger.measure.action = smua.ENABLE
+
+
Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.
This constant contains the source complete event number.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Constant
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
eventID = smuX.trigger.SOURCE_COMPLETE_EVENT_ID
+
+
+
+
eventID
+
+
The source action complete event number
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.trigger.SOURCE_COMPLETE_EVENT_ID applies to SMU channel A)
+
+
+
+
+
Details
+
Set the stimulus of any trigger event detector to the value of this constant to have it respond to source complete events from this source‑measure unit (SMU).
This attribute enables or disables sweeping the source (on or off).
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU reset Instrument reset Recall setup
+
+
Not saved
+
+
0 (smuX.DISABLE)
+
+
+
+
+
Usage
+
action = smuX.trigger.source.action
+
smuX.trigger.source.action = action
+
+
+
+
action
+
+
Sweep source action. Set to one of the following values:
+
0 or smuX.DISABLE: Do not sweep the source
+
1 or smuX.ENABLE: Sweep the source
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.trigger.source.action applies to SMU channel A)
+
+
+
+
+
Details
+
This attribute is used to enable or disable source level changes during a sweep. In addition to enabling the action before initiating the sweep, make sure to configure it using smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY().
+
Example
+
+
+
+
smua.trigger.source.listv({3, 1, 4, 5, 2})
+
+
+
smua.trigger.source.action = smua.ENABLE
+
+
Configure list sweep for SMU channel A (sweep through
Source limit during triggered operation; set to the desired source limit during triggered operation or smuX.LIMIT_AUTO
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.trigger.source.limitv applies to SMU channel A)
+
+
+
+
Y
+
+
SMU output function (v = voltage, i = current)
+
+
+
+
+
Details
+
If this attribute is set to smuX.LIMIT_AUTO (or 0), the SMU will use the normal limit setting during sweeping. If this attribute is set to any other numeric value, the SMU will switch in this limit at the start of the source action and will switch back to the normal limit setting at the end of the end pulse action.
+
Normally, the limit range is automatically adjusted in accordance with the desired limit value. During sweeping, however, the limit range is fixed in order to avoid the delays associated with changing range. This fixed limit range is determined by the maximum limit value needed during the sweep; that is, the greater of either the normal limit value (as specified by smuX.source.limitY) or the sweep limit value (as specified by smuX.trigger.source.limitY). Note that the minimum limit value that can be enforced during the sweep is equal to 10 percent of the full scale value of the fixed limit range. If the smaller limit value (normal or sweep) falls below this 10% threshold, the 10 percent value will be enforced instead. Likewise, if the limit value were to fall below the 10 percent threshold as a result of power compliance, the 10 percent value will be enforced instead.
+
Example
+
+
+
+
smua.trigger.source.limitv = 500
+
+
Sets the voltage sweep limit of SMU channel A to 500 V.
Source‑measure unit (SMU) channel (for example, smua.trigger.source.linearv(0, 10, 11) applies to SMU channel A)
+
+
+
+
Y
+
+
SMU source function (v = voltage, i = current)
+
+
+
+
startValue
+
+
Source value of the first point
+
+
+
+
endValue
+
+
Source value of the last point
+
+
+
+
points
+
+
The number of points used to calculate the step size
+
+
+
+
+
Details
+
This function configures the source action to be a linear source sweep in a subsequent sweep. During the sweep, the source will generate a uniform series of ascending or descending voltage or current changes called steps. The number of source steps is one less than the number of sourced points.
+
The points parameter does not set the number of steps in a sweep, but rather is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source will restart at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU will satisfy the trigger count by restarting the sweep values from the beginning.
+
If the subsequent sweep has fewer points than specified in points, endValue will not be reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU will satisfy the trigger count and ignore the remaining source values.
+
In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep will return a stable value for the first measured point without penalizing remaining points in the sweep.
+
With linear sweeps it is acceptable to maintain a fixed source resolution over the entire sweep. To prevent source range changes during the sweep (especially when sweeping through 0.0), set the source range to a fixed range appropriate for the larger of either startValue or endValue.
+
The SMU will only store the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.
+
Source functions cannot be changed within a sweep.
+
After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.
+
Example
+
+
+
+
smua.trigger.source.linearv(0, 1000, 11)
+
+
+
Sweeps SMU channel A from 0 V to 1000 V in 100 V steps.
This function configures an array-based source sweep.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
smuX.trigger.source.listY(sweepList)
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.trigger.source.listv({5}) applies to SMU channel A)
+
+
+
+
Y
+
+
SMU source function (v = voltage, i = current)
+
+
+
+
sweepList
+
+
An array of source values
+
+
+
+
+
Details
+
This function configures the source action to be a list sweep in a subsequent sweep. During the sweep, the source will output the sequence of source values given in the sweepList array.
+
If the subsequent sweep has more points than specified in sweepList, the source will restart at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU will satisfy the trigger count by restarting the sweep values from the beginning.
+
If the subsequent sweep has fewer points than specified in sweepList, the extra values will be ignored. This means that if the trigger count is less than the number of source values configured, the SMU will satisfy the trigger count and ignore the remaining source values.
+
In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep will return a stable value for the first measured point without penalizing remaining points in the sweep.
+
The SMU will only store the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.
+
Source functions cannot be changed within a sweep.
+
After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.
+
Example
+
+
+
+
smua.trigger.source.listv({3, 1, 4, 5, 2})
+
+
+
Sweeps SMU channel A through 3 V, 1 V, 4 V, 5 V, and 2 V.
Source-measure unit (SMU) channel (for example, smua.trigger.source.logv(1, 10, 11, 0) applies to SMU channel A)
+
+
+
+
Y
+
+
SMU source function (v = voltage, i = current)
+
+
+
+
startValue
+
+
Source value of the first point
+
+
+
+
endValue
+
+
Source value of the last point
+
+
+
+
points
+
+
The number of points used to calculate the step size
+
+
+
+
asymptote
+
+
The asymptotic offset value
+
+
+
+
+
Details
+
This function configures the source action to be a geometric source sweep in a subsequent sweep. During the sweep, the source generates a geometric series of ascending or descending voltage or current changes called steps. Each step is larger or smaller than the previous step by a fixed proportion. The constant of proportionality is determined by the starting value, the ending value, the asymptote, and the number of steps in the sweep. The number of source steps is one less than the number of sourced points.
+
The points parameter does not set the number of steps in a sweep, but rather is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning.
+
If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.
+
In cases where the first sweep point is nonzero, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.
+
With logarithmic sweeps, it is usually necessary to allow the source to autorange to maintain good source accuracy when sweeping over more than one decade or across range boundaries.
+
The asymptote parameter can be used to customize the inflection and offset of the source value curve. This allows log sweeps to cross zero. Setting this parameter to zero provides a conventional logarithmic sweep. The asymptote value is the value that the curve has at either positive or negative infinity, depending on the direction of the sweep.
+
The asymptote value must not be equal to or between the starting and ending values. It must be outside the range defined by the starting and ending values.
+
The SMU stores only the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.
+
Source functions cannot be changed within a sweep.
+
After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.
+
Example
+
+
+
+
smua.trigger.source.logv(1, 10, 11, 0)
+
+
+
Sweeps SMU channel A from 1 V to 10 V in 10 steps with an asymptote of 0 V.
This function sets the source event detector to the detected state.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
smuX.trigger.source.set()
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.trigger.source.set() applies to SMU channel A)
+
+
+
+
+
Details
+
This function sets the source event detector to the detected state.
+
The SMU automatically clears all event detectors when the smuX.trigger.initiate() function is executed. This function should be called after the sweep is initiated. Make sure that if the event detectors are configured to clear automatically (because the smuX.trigger.autoclear attribute is set to smuX.ENABLE) that this command is issued after the SMU has entered the trigger layer.
This attribute defines which event causes the source event detector to enter the detected state.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU reset Instrument reset Recall setup
+
+
Not saved
+
+
0
+
+
+
+
+
Usage
+
eventID = smuX.trigger.source.stimulus
+
smuX.trigger.source.stimulus = eventID
+
+
+
+
eventID
+
+
Set to the event that triggers the end pulse source off action
+
+
+
+
X
+
+
Source‑measure (SMU) channel (for example, smua.trigger.source.stimulus applies to SMU channel A)
+
+
+
+
+
Details
+
Set this attribute to the event ID of any trigger event generator to wait for that event. When set, the SMU waits for the event at the source event detector portion of the trigger model. To bypass waiting for an event, set this attribute's value to zero (0). Set eventID to one of the existing trigger event IDs shown in the following table.
+
+
+
+
+
+
+
Trigger event IDs*
+
+
+
+
Event ID
+
+
Event description
+
+
+
+
smua.trigger.SWEEPING_EVENT_ID
+
+
Occurs when the source‑measure unit (SMU) transitions from the idle state to the arm layer of the trigger model
+
+
+
+
smua.trigger.ARMED_EVENT_ID
+
+
Occurs when the SMU moves from the arm layer to the trigger layer of the trigger model
+
+
+
+
smua.trigger.SOURCE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a source action
+
+
+
+
smua.trigger.MEASURE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a measure action
+
+
+
+
smua.trigger.PULSE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a pulse
+
+
+
+
smua.trigger.SWEEP_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a sweep
+
+
+
+
smua.trigger.IDLE_EVENT_ID
+
+
Occurs when the SMU returns to the idle state
+
+
+
+
digio.trigger[N].EVENT_ID
+
+
Occurs when an edge is detected on a digital I/O line
+
+
+
+
tsplink.trigger[N].EVENT_ID
+
+
Occurs when an edge is detected on a TSP‑Link line
+
+
+
+
lan.trigger[N].EVENT_ID
+
+
Occurs when the appropriate LXI trigger packet is received on LAN trigger object N
+
+
+
+
display.trigger.EVENT_ID
+
+
Occurs when the TRIG key on the front panel is pressed
+
+
+
+
trigger.EVENT_ID
+
+
Occurs when a *TRG command is received on the remote interface
+
GPIB only: Occurs when a GET bus command is received
+
VXI-11 only: Occurs with the VXI-11 command device_trigger; reference the VXI-11 standard for additional details on the device trigger operation
+
+
+
+
trigger.blender[N].EVENT_ID
+
+
Occurs after a collection of events is detected
+
+
+
+
trigger.timer[N].EVENT_ID
+
+
Occurs when a delay expires
+
+
+
+
* Use the name of the trigger event ID to set the stimulus value rather than the numeric value. Using the name makes the code compatible for future upgrades (for example, if the numeric values must change when enhancements are added to the instrument).
This function loads and runs a script on a remote TSP-enabled instrument.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
tspnet.tsp.runscript(connectionID, script)
+
tspnet.tsp.runscript(connectionID, name, script)
+
+
+
+
connectionID
+
+
Integer value used as an identifier for other tspnet commands
+
+
+
+
name
+
+
The name that is assigned to the script
+
+
+
+
script
+
+
The body of the script as a string
+
+
+
+
+
Details
+
This function is appropriate only for TSP-enabled instruments.
+
This function downloads a script to a remote instrument and runs it. It automatically adds the appropriate loadscript and endscript commands around the script, captures any errors, and reads back any prompts. No additional substitutions are done on the text.
+
The script is automatically loaded, compiled, and run.
+
Any output from previous commands is discarded.
+
This command does not wait for the script to complete.
+
If you do not want the script to do anything immediately, make sure the script only defines functions for later use. Use the tspnet.execute() function to execute those functions at a later time.
+
If no name is specified, the script will be loaded as the anonymous script.
+
Example
+
+
+
+
tspnet.tsp.runscript(myconnection, "mytest",
+
"print([[start]]) for d = 1, 10 do print([[work]]) end print([[end]])")
+
+
+
+
Load and run a script entitled mytest on the TSP‑enabled instrument connected with myconnection.
This attribute is the group number of a TSP‑Link node.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Not applicable
+
+
Not saved
+
+
0
+
+
+
+
+
Usage
+
groupNumber = tsplink.group
+
tsplink.group = groupNumber
+
+
+
+
groupNumber
+
+
The group number of the TSP-Link node (0 to 64)
+
+
+
+
+
Details
+
To remove the node from all groups, set the attribute value to 0.
+
When the node is turned off, the group number for that node changes to 0.
+
The master node can be assigned to any group. You can also include other nodes in the group that includes the master. Note that any nodes that are set to 0 are automatically included in the group that contains the master node, regardless of the group that is assigned to the master node.
+
Example
+
+
+
+
tsplink.group = 3
+
+
Assign the instrument to TSP-Link group number 3.
+
+
+
+
+
Also see
+
Using groups to manage nodes on TSP-Link network
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This attribute reads the node number assigned to the master node.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Not applicable
+
+
Not applicable
+
+
Not applicable
+
+
+
+
+
Usage
+
masterNodeNumber = tsplink.master
+
+
+
+
masterNodeNumber
+
+
The node number of the master node
+
+
+
+
+
Details
+
After doing a TSP-Link reset (tsplink.reset()), use this attribute to access the node number of the master in a set of instruments connected over TSP-Link.
+
Example
+
+
+
+
LinkMaster = tsplink.master
+
+
Store the TSP-Link master node number in a variable called LinkMaster.
This function reads the TSP-Link® synchronization lines as a digital I/O port.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
data = tsplink.readport()
+
+
+
+
data
+
+
Numeric value returned indicating which register bits are set
+
+
+
+
+
Details
+
The binary equivalent of the returned value indicates the input pattern on the I/O port. The least significant bit of the binary number corresponds to line 1 and bit B3 corresponds to line 3. For example, a returned value of 2 has a binary equivalent of 010. Line 2 is high (1), and the other 2 lines are low (0).
This function initializes (resets) all nodes (instruments) in the TSP‑Link system.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
nodesFound = tsplink.reset()
+
nodesFound = tsplink.reset(expectedNodes)
+
+
+
+
nodesFound
+
+
The number of nodes actually found on the system
+
+
+
+
expectedNodes
+
+
The number of nodes expected on the system (1 to 64)
+
+
+
+
+
Details
+
This function erases all knowledge of other nodes connected on the TSP-Link system and regenerates the system configuration. This function must be called at least once before any remote nodes can be accessed. If the node number for any instrument is changed, the TSP-Link nodes must be initialized again.
+
If expectedNodes is not given, this function generates an error if no other nodes are found on the TSP‑Link network.
+
If nodesFound is less than expectedNodes, an error is generated. Note that the node on which the command is running is counted as a node. For example, giving an expected node count of 1 will not generate any errors, even if there are no other nodes on the TSP-Link network.
+
Also returns the number of nodes found.
+
Example
+
+
+
+
nodesFound = tsplink.reset(2)
+
print("Nodes found = " .. nodesFound)
+
+
Perform a TSP-Link reset and indicate how many nodes are found.
+
Sample output if found 2 nodes: Nodes found = 2
+
Sample output if fewer nodes are found and if localnode.showerrors = 1: 1219, TSP-Link found fewer nodes than expected Nodes found = 1
This function clears the event detector for a trigger.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
tsplink.trigger[N].clear()
+
+
+
+
N
+
+
The trigger line (1 to 3)
+
+
+
+
+
Details
+
The event detector for a trigger recalls if a trigger event has been detected since the last tsplink.trigger[N].wait() call. This function clears a trigger event detector, discards the previous history of the trigger line, and clears the tsplink.trigger[N].overrun attribute.
This attribute defines the trigger operation and detection mode.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset Recall setup TSP-Link trigger N reset
+
+
Not saved
+
+
0 (tsplink.TRIG_BYPASS)
+
+
+
+
+
Usage
+
mode = tsplink.trigger[N].mode
+
tsplink.trigger[N].mode = mode
+
+
+
+
mode
+
+
The trigger mode
+
+
+
+
N
+
+
The trigger line (1 to 3)
+
+
+
+
+
Details
+
This attribute controls the mode in which the trigger event detector and the output trigger generator operate on the given trigger line.
+
The setting for mode can be one of the following values:
+
+
+
+
Mode
+
+
Number value
+
+
Description
+
+
+
+
tsplink.TRIG_BYPASS
+
+
0
+
+
Allows direct control of the line as a digital I/O line.
+
+
+
+
tsplink.TRIG_FALLING
+
+
1
+
+
Detects falling‑edge triggers as input. Asserts a TTL-low pulse for output.
+
+
+
+
tsplink.TRIG_RISING
+
+
2
+
+
If the programmed state of the line is high, the tsplink.TRIG_RISING mode behaves similar to tsplink.TRIG_RISINGA. If the programmed state of the line is low, the tsplink.TRIG_RISING mode behaves similar to tsplink.TRIG_RISINGM. Use tsplink.TRIG_RISINGA if the line is in the high output state. Use tsplink.TRIG_RISINGM if the line is in the low output state.
+
+
+
+
tsplink.TRIG_EITHER
+
+
3
+
+
Detects rising‑ or falling‑edge triggers as input. Asserts a TTL‑low pulse for output.
+
+
+
+
tsplink.TRIG_SYNCHRONOUSA
+
+
4
+
+
Detects the falling‑edge input triggers and automatically latches and drives the trigger line low.
+
+
+
+
tsplink.TRIG_SYNCHRONOUS
+
+
5
+
+
Detects the falling‑edge input triggers and automatically latches and drives the trigger line low. Asserts a TTL-low pulse as an output trigger.
+
+
+
+
tsplink.TRIG_SYNCHRONOUSM
+
+
6
+
+
Detects rising‑edge triggers as an input. Asserts a TTL‑low pulse for output.
+
+
+
+
tsplink.TRIG_RISINGA
+
+
7
+
+
Detects rising‑edge triggers as input. Asserts a TTL‑low pulse for output.
+
+
+
+
tsplink.TRIG_RISINGM
+
+
8
+
+
Edge detection as an input is not available. Generates a TTL‑high pulse as an output trigger.
+
+
+
+
+
+
When programmed to any other mode, the output state of the I/O line is controlled by the trigger logic, and the user-specified output state of the line is ignored.
+
When the trigger mode is set to tsplink.TRIG_RISING, the user‑specified output state of the line will be examined. If the output state selected when the mode is changed is high, the actual mode used will be tsplink.TRIG_RISINGA. If the output state selected when the mode is changed is low, the actual mode used will be tsplink.TRIG_RISINGM.
+
The custom variable mode stores the trigger mode as a numeric value when the attribute is read.
+
To control the line state, use the tsplink.TRIG_BYPASS mode with the tsplink.writebit() and the tsplink.writeport() commands.
+
Example
+
+
+
+
tsplink.trigger[3].mode = tsplink.TRIG_RISINGM
+
+
Sets the trigger mode for synchronization line 3 to tsplink.TRIG_RISINGM.
This function releases a latched trigger on the given TSP‑Link trigger line.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
tsplink.trigger[N].release()
+
+
+
+
N
+
+
The trigger line (1 to 3)
+
+
+
+
+
Details
+
Releases a trigger that was asserted with an indefinite pulse width, as well as a trigger that was latched in response to receiving a synchronous mode trigger.
Trigger detection indication; set to one of the following values:
+
true: A trigger is detected during the timeout period
+
false: A trigger is not detected during the timeout period
+
+
+
+
N
+
+
The trigger line (1 to 3)
+
+
+
+
timeout
+
+
The timeout value in seconds
+
+
+
+
+
Details
+
This function waits up to the timeout value for an input trigger. If one or more trigger events were detected since the last time tsplink.trigger[N].wait() or tsplink.trigger[N].clear() was called, this function returns immediately.
+
After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.
+
Example
+
+
+
+
triggered = tsplink.trigger[3].wait(10)
+
print(triggered)
+
+
+
Waits up to 10 seconds for a trigger on TSP-Link® line 3.
+
If false is returned, no trigger was detected during the 10-second timeout.
This function writes to all TSP‑Link synchronization lines.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
tsplink.writeport(data)
+
+
+
+
data
+
+
Value to write to the port (0 to 7)
+
+
+
+
+
Details
+
The binary representation of data indicates the output pattern that is written to the I/O port. For example, a data value of 2 has a binary equivalent of 010. Line 2 is set high (1), and the other two lines are set low (0).
+
Write‑protected lines are not changed.
+
The reset() function does not affect the present states of the trigger lines.
+
Use the tsplink.writebit() and tsplink.writeport() commands to control the output state of the synchronization line when trigger operation is set to tsplink.TRIG_BYPASS.
+
Example
+
+
+
+
tsplink.writeport(3)
+
+
Sets the synchronization lines 1 and 2 high (binary 011).
Do not depend on the output-off state to protect the user. The Model 2657A is provided with an interlock circuit that must be positively activated in order for the high voltage output to be enabled. The interlock helps facilitate safe operation of the equipment in a test system. Bypassing the interlock could expose the operator to hazardous voltages that could result in personal injury or death.
+
+
Carefully consider and configure the appropriate output-off state, source, and compliance levels before connecting the Model 2657A to a device that can deliver energy (for example, other voltage sources, batteries, capacitors, or solar cells). Program recommended instrument settings before making connections to the device. Failure to consider the output-off state, source, and compliance levels may result in damage to the instrument or to the device under test (DUT).
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This attribute selects whether the blender operates in OR mode or AND mode.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset Trigger blender N reset Recall setup
+
+
Not saved
+
+
false (AND mode)
+
+
+
+
+
Usage
+
orenable = trigger.blender[N].orenable
+
trigger.blender[N].orenable = orenable
+
+
+
+
orenable
+
+
The orenable mode:
+
true: OR mode
false: AND mode
+
+
+
N
+
+
The trigger blender (1 to 4)
+
+
+
+
+
Details
+
This attribute selects whether the blender waits for any one event (the “OR” mode) or waits for all selected events (the “AND” mode) before signaling an output event.
This attribute indicates whether or not an event was ignored because of the event detector state.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Instrument reset Trigger blender N clear Trigger blender N reset
+
+
Not applicable
+
+
Not applicable
+
+
+
+
+
Usage
+
overrun = trigger.blender[N].overrun
+
+
+
+
overrun
+
+
Trigger blender overrun state
+
+
+
+
N
+
+
The trigger event blender (1 to 4)
+
+
+
+
+
Details
+
Indicates if an event was ignored because the event detector was already in the detected state when the event occurred. This is an indication of the state of the event detector that is built into the event blender itself.
+
This attribute does not indicate if an overrun occurred in any other part of the trigger model or in any other trigger object that is monitoring the event. It also is not an indication of an action overrun.
This function waits for a blender trigger event to occur.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
triggered = trigger.blender[N].wait(timeout)
+
+
+
+
triggered
+
+
Trigger detection indication for blender
+
+
+
+
N
+
+
The trigger blender (1 to 4) on which to wait
+
+
+
+
timeout
+
+
Maximum amount of time in seconds to wait for the trigger blender event
+
+
+
+
+
Details
+
This function waits for an event blender trigger event. If one or more trigger events were detected since the last time trigger.blender[N].wait() or trigger.blender[N].clear() was called, this function returns immediately.
+
After detecting a trigger with this function, the event detector automatically resets and rearms. This is true regardless of the number of events detected.
This function clears the command interface trigger event detector.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
trigger.clear()
+
Details
+
The trigger event detector indicates if an event has been detected since the last trigger.wait() call. This function clears the trigger's event detector and discards the previous history of command interface trigger events.
This attribute indicates if an event was ignored because of the event detector state.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Instrument reset Recall setup Trigger timer N clear Trigger timer N reset
+
+
Not applicable
+
+
false
+
+
+
+
+
Usage
+
overrun = trigger.timer[N].overrun
+
+
+
+
overrun
+
+
Trigger overrun state
+
+
+
+
N
+
+
Trigger timer number (1 to 4)
+
+
+
+
+
Details
+
This attribute indicates if an event was ignored because the event detector was already in the detected state when the event occurred.
+
This is an indication of the state of the event detector built into the timer itself. It does not indicate if an overrun occurred in any other part of the trigger model or in any other construct that is monitoring the delay completion event. It also is not an indication of a delay overrun.
+
Example
+
+
+
+
print(trigger.timer[1].overrun)
+
+
If an event was ignored, the output is true.
+
If the event was not ignored, the output is false.
Maximum amount of time in seconds to wait for the trigger
+
+
+
+
+
Details
+
If one or more trigger events were detected since the last time trigger.timer[N].wait() or trigger.timer[N].clear() was called, this function returns immediately.
+
After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.
+
Example
+
+
+
+
triggered = trigger.timer[3].wait(10)
+
print(triggered)
+
+
Waits up to 10 seconds for a trigger on timer 3.
+
If false is returned, no trigger was detected during the 10-second timeout.
This function waits for a command interface trigger event.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
triggered = trigger.wait(timeout)
+
+
+
+
triggered
+
+
true: A trigger was detected during the timeout period
+
false: No triggers were detected during the timeout period
+
+
+
+
timeout
+
+
Maximum amount of time in seconds to wait for the trigger
+
+
+
+
+
Details
+
This function waits up to timeout seconds for a trigger on the active command interface. A command interface trigger occurs when:
+
A GPIB GET command is detected (GPIB only)
A VXI-11 device_trigger method is invoked (VXI-11 only)
A *TRG message is received
If one or more of these trigger events were previously detected, this function returns immediately.
+
After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.
+
Example
+
+
+
+
triggered = trigger.wait(10)
+
print(triggered)
+
+
Waits up to 10 seconds for a trigger.
+
If false is returned, no trigger was detected during the 10‑second timeout.
This attribute stores the status byte condition register.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Not applicable
+
+
Not saved
+
+
Not applicable
+
+
+
+
+
Usage
+
statusByte = status.condition
+
+
+
+
statusByte
+
+
The status byte; a zero (0) indicates no bits set; other values indicate various bit settings
+
+
+
+
+
Details
+
This attribute is used to read the status byte, which is returned as a numeric value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000 0001. This value indicates that bit B0 and bit B7 are set.
+
+
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
+
+
+
* Least significant bit ** Most significant bit
+
The returned value can indicate one or more status events occurred. When an enabled status event occurs, a summary bit is set in this register to indicate the event occurrence.
+
The individual bits of this register have the following meanings:
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
status.MEASUREMENT_SUMMARY_BIT
+
status.MSB
+
+
Set summary bit indicates that an enabled measurement event has occurred.
+
Bit B0 decimal value: 1
+
+
+
+
B1
+
+
status.SYSTEM_SUMMARY_BIT
+
status.SSB
+
+
Set summary bit indicates that an enabled system event has occurred.
+
Bit B1 decimal value: 2
+
+
+
+
B2
+
+
status.ERROR_AVAILABLE
+
status.EAV
+
+
Set summary bit indicates that an error or status message is present in the Error Queue.
+
Bit B2 decimal value: 4
+
+
+
+
B3
+
+
status.QUESTIONABLE_SUMMARY_BIT
+
status.QSB
+
+
Set summary bit indicates that an enabled questionable event has occurred.
+
Bit B3 decimal value: 8
+
+
+
+
B4
+
+
status.MESSAGE_AVAILABLE
+
status.MAV
+
+
Set summary bit indicates that a response message is present in the Output Queue.
+
Bit B4 decimal value: 16
+
+
+
+
B5
+
+
status.EVENT_SUMMARY_BIT
+
status.ESB
+
+
Set summary bit indicates that an enabled standard event has occurred.
+
Bit B5 decimal value: 32
+
+
+
+
B6
+
+
status.MASTER_SUMMARY_STATUS
+
status.MSS
+
+
Request Service (RQS)/Master Summary Status (MSS). Depending on how it is used, bit B6 of the status byte register is either the Request for Service (RQS) bit or the Master Summary Status (MSS) bit:
+
When using the GPIB or VXI-11 serial poll sequence of the Model 2657A to obtain the status byte (serial poll byte), B6 is the RQS bit. The set bit indicates that the Request Service (RQS) bit of the status byte (serial poll byte) is set and a serial poll (SRQ) has occurred.
When using the status.condition register command or the *STB? common command to read the status byte, B6 is the MSS bit. Set bit indicates that an enabled summary bit of the status byte register is set.
Bit B6 decimal value: 64
+
+
+
+
B7
+
+
status.OPERATION_SUMMARY_BIT
+
status.OSB
+
+
Set summary bit indicates that an enabled operation event has occurred.
+
Bit B7 decimal value: 128
+
+
+
+
+
In addition to the above constants, when more than one bit of the register is set, statusByte equals the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).
+
+
+
+
Bit
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
128
+
+
64
+
+
32
+
+
16
+
+
8
+
+
4
+
+
2
+
+
1
+
+
+
+
Weights
+
+
(27)
+
+
(26)
+
+
(25)
+
+
(24)
+
+
(23)
+
+
(22)
+
+
(21)
+
+
(20)
+
+
+
+
+
Example
+
+
+
+
statusByte = status.condition
+
print(statusByte)
+
+
Returns statusByte.
+
Sample output:
+
1.29000e+02
+
Converting this output (129) to its binary equivalent yields 1000 0001
+
Therefore, this output indicates that the set bits of the status byte condition register are presently B0 (MSS) and B7 (OSB).
The measurement event register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
+
Details
+
These attributes read or write the measurement event registers.
+
Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.
+
For example, assume value 257 is returned for the enable register. The binary equivalent is 0000 0001 0000 0001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
+
+
+
* Least significant bit ** Most significant bit
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
+
The individual bits of this register can be set to the following described values:
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
status.measurement.VOLTAGE_LIMIT
+
status.measurement.VLMT
+
+
Set bit is a summary of the status.measurement.voltage_limit register.
+
Bit B0 decimal value: 1
+
+
+
+
B1
+
+
status.measurement.CURRENT_LIMIT
+
status.measurement.ILMT
+
+
Set bit is a summary of the status.measurement.current_limit register.
+
Bit B1 decimal value: 2
+
+
+
+
B2
+
+
status.measurement.SINK_LIMIT
+
status.measurement.SLMT
+
+
Set bit is a summary of the status.measurement.sink_limit register.
+
Bit B2 decimal value: 4
+
+
+
+
B3
+
+
status.measurement.OVERVOLTAGE
+
status.measurement.OV
+
+
Set bit is a summary of the status.measurement.overvoltage register.
+
Bit B3 decimal value: 8
+
+
+
+
B4-B6
+
+
Not used
+
+
Not applicable
+
+
+
+
B7
+
+
status.measurement.READING_OVERFLOW
+
status.measurement.ROF
+
+
Set bit is a summary of the status.measurement.reading_overflow register.
+
Bit B7 decimal value: 128
+
+
+
+
B8
+
+
status.measurement.BUFFER_AVAILABLE
+
status.measurement.BAV
+
+
Set bit is a summary of the status.measurement.buffer_available register.
+
Bit B8 decimal value: 256
+
+
+
+
B9-B10
+
+
Not used
+
+
Not applicable
+
+
+
+
B11
+
+
status.measurement.INTERLOCK
+
status.measurement.INT
+
+
Set bit indicates that the interlock has been asserted.
+
Bit B11 decimal value: 2048
+
+
+
+
B12
+
+
Not used
+
+
Not applicable
+
+
+
+
B13
+
+
status.measurement.INSTRUMENT_SUMMARY
+
status.measurement.INST
+
+
Set bit indicates that a bit in the measurement instrument summary register is set.
+
Bit B13 decimal value: 8192
+
+
+
+
B14-B15
+
+
Not used
+
+
Not applicable
+
+
+
+
+
As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV.
+
In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).
The measurement event register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 2
+
+
+
+
+
Details
+
These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000 0000 0000 0010. This value indicates that bit B1 (SMUA) is set.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
Not used
+
+
Not applicable.
+
+
+
+
B1
+
+
status.measurement.buffer_available.SMUA
+
+
Set bit indicates that there is at least one reading stored in either or both of the dedicated reading buffers.
+
Bit B1 decimal value: 2
+
Binary value: 0000 0010
+
+
+
+
B2-B15
+
+
Not used
+
+
Not applicable.
+
+
+
+
+
As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.
+
In addition to the above constant, measurementRegister can be set to the decimal equivalent of the bit to set.
+
Example
+
+
+
+
status.measurement.buffer_available.enable =
+
status.measurement.buffer_available.SMUA
+
+
+
Sets the SMUA bit of the measurement event buffer available summary enable register.
The measurement event current limit summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 2
+
+
+
+
+
Details
+
These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000 0000 0000 0010. This value indicates that bit B1 (SMUA) is set.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
Not used
+
+
Not applicable.
+
+
+
+
B1
+
+
status.measurement.current_limit.SMUA
+
+
Set bit indicates that the current limit was exceeded.
+
Bit B1 decimal value: 2
+
Binary value: 0000 0010
+
+
+
+
B2-B15
+
+
Not used
+
+
Not applicable.
+
+
+
+
+
As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.
+
In addition to the above constant, measurementRegister can be set to the decimal equivalent of the bit to set.
+
Example
+
+
+
+
status.measurement.current_limit.enable =
+
status.measurement.current_limit.SMUA
+
+
Sets the SMUA bit of the measurement event current limit summary enable register.
The measurement event instrument summary register status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
+
Details
+
These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000 0000 0000 0010. This value indicates that bit B1 (SMUA) is set.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
Not used
+
+
Not applicable.
+
+
+
+
B1
+
+
status.measurement.instrument.SMUA
+
+
Set bit indicates one or more enabled bits of the measurement event SMU A summary register is set.
+
Bit B1 decimal value: 2
+
Binary value: 0000 0010
+
+
+
+
B2-B15
+
+
Not used
+
+
Not applicable.
+
+
+
+
+
As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.
+
In addition to the above constant, measurementRegister can be set to the decimal equivalent of the bit to set.
+
Example
+
+
+
+
status.measurement.instrument.enable =
+
status.measurement.instrument.SMUA
+
+
Sets the SMU A bit of the measurement event instrument summary enable register using a constant.
The instrument measurement status SMU X summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
X
+
+
Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)
+
+
+
+
+
Details
+
These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000 0001 0000 0001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
+
+
+
* Least significant bit ** Most significant bit
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
+
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0*
+
+
status.measurement.instrument.smuX.VOLTAGE_LIMIT
+
status.measurement.instrument.smuX.VLMT
+
+
Set bit indicates that the voltage limit was exceeded.
+
Bit B0 decimal value: 1
+
+
+
+
B1*
+
+
status.measurement.instrument.smuX.CURRENT_LIMIT
+
status.measurement.instrument.smuX.ILMT
+
+
Set bit indicates that the current limit was exceeded.
+
Bit B1 decimal value: 2
+
+
+
+
B2*
+
+
status.measurement.instrument.smuX.SINK_LIMIT
+
status.measurement.instrument.smuX.SLMT
+
+
Set bit indicates that a sink compliance condition has occurred.
+
Bit B2 decimal value: 4
+
+
+
+
B3*
+
+
status.measurement.instrument.smuX.OVERVOLTAGE
+
status.measurement.instrument.smuX.OV
+
+
Set bit indicates that an overvoltage condition has occurred.
Set bit indicates that there is at least one reading stored in either or both of the dedicated reading buffers.
+
Bit B8 decimal value: 256
+
+
+
+
B9-B15
+
+
Not used
+
+
Not applicable.
+
+
+
+
* This bit will be updated only when a measurement is taken or smuX.source.compliance is invoked.
+
+
+
+
+
As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable= status.measurement.instrument.smua.VLMT.
+
In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256).
+
+
+
+
Bit
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
128
+
+
64
+
+
32
+
+
16
+
+
8
+
+
4
+
+
2
+
+
1
+
+
+
+
Weights
+
+
(27)
+
+
(26)
+
+
(25)
+
+
(24)
+
+
(23)
+
+
(22)
+
+
(21)
+
+
(20)
+
+
+
+
+
+
+
+
Bit
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
32,768
+
+
16,384
+
+
8192
+
+
4096
+
+
2048
+
+
1024
+
+
512
+
+
256
+
+
+
+
Weights
+
+
(215)
+
+
(214)
+
+
(213)
+
+
(212)
+
+
(211)
+
+
(210)
+
+
(29)
+
+
(28)
+
+
+
+
+
Example
+
+
+
+
status.measurement.instrument.smua.enable =
+
status.measurement.instrument.smua.VLMT
+
+
Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.
The measurement reading overflow summary register status. A zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 2
+
+
+
+
+
Details
+
These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000 0000 0000 0010. This value indicates that bit B1 (SMUA) is set.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
Not used
+
+
Not applicable.
+
+
+
+
B1
+
+
status.measurement.reading_overflow.SMUA
+
+
Set bit indicates that an overflow reading has been detected.
+
Bit B1 decimal value: 2
+
Binary value: 0000 0010
+
+
+
+
B2-B15
+
+
Not used
+
+
Not applicable.
+
+
+
+
+
As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.
+
In addition to the above constant, measurementRegister can be set to the numeric equivalent of the bit to set.
+
Example
+
+
+
+
status.measurement.reading_overflow.enable =
+
status.measurement.reading_overflow.SMUA
+
+
Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.
The measurement voltage limit summary register status. A zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 2
+
+
+
+
+
Details
+
These attributes are used to read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
Not used
+
+
Not applicable.
+
+
+
+
B1
+
+
status.measurement.voltage_limit.SMUA
+
+
Set bit indicates that the voltage limit was exceeded.
+
Bit B1 decimal value: 2
+
Binary value: 0000 0010
+
+
+
+
B2-B15
+
+
Not used
+
+
Not applicable.
+
+
+
+
+
As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.
+
In addition to the above constant, measurementRegister can be set to the numeric equivalent of the bit to set.
+
Example
+
+
+
+
status.measurement.voltage_limit.enable =
+
status.measurement.voltage_limit.SMUA
+
+
Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.
This attribute stores the system node enable register.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
+
Usage
+
nodeEnableRegister = status.node_enable
+
status.node_enable = nodeEnableRegister
+
+
+
+
nodeEnableRegister
+
+
The system node enable register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
+
Details
+
This attribute is used to read or write to the system node enable register. Reading the system node enable register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, assume the value of 1.29000e+02 (which is 129) is returned for the system node enable register, the binary equivalent is 1000 0001. This value indicates that bit B0 and bit B7 are set.
+
+
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
**
+
+
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
+
+
+
* Least significant bit ** Most significant bit
+
Assigning a value to this attribute enables one or more status events. When an enabled status event occurs, a summary bit is set in the appropriate system summary register. The register and bit that is set depends on the TSP-Link node number assigned to this instrument.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
status.MEASUREMENT_SUMMARY_BIT status.MSB
+
+
Set summary bit indicates that an enabled measurement event has occurred.
+
Bit B0 decimal value: 1
+
+
+
+
B1
+
+
Not used
+
+
Not applicable.
+
+
+
+
B2
+
+
status.ERROR_AVAILABLE status.EAV
+
+
Set summary bit indicates that an error or status message is present in the Error Queue.
+
Bit B2 decimal value: 4
+
+
+
+
B3
+
+
status.QUESTIONABLE_SUMMARY_BIT status.QSB
+
+
Set summary bit indicates that an enabled questionable event has occurred.
+
Bit B3 decimal value: 8
+
+
+
+
B4
+
+
status.MESSAGE_AVAILABLE status.MAV
+
+
Set summary bit indicates that a response message is present in the Output Queue.
+
Bit B4 decimal value: 16
+
+
+
+
B5
+
+
status.EVENT_SUMMARY_BIT status.ESB
+
+
Set summary bit indicates that an enabled standard event has occurred.
+
Bit B5 decimal value: 32
+
+
+
+
B6
+
+
status.MASTER_SUMMARY_STATUS status.MSS
+
+
Set bit indicates that an enabled Master Summary Status (MSS) bit of the Status Byte Register is set.
+
Bit B6 decimal value: 64
+
+
+
+
B7
+
+
status.OPERATION_SUMMARY_BIT status.OSB
+
+
Set summary bit indicates that an enabled operation event has occurred.
+
Bit B7 decimal value: 128
+
+
+
+
+
As an example, to set the B0 bit of the system node enable register, set status.node_enable = status.MSB.
+
In addition to the above values, nodeEnableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set nodeEnableRegister to the sum of their decimal weights. For example, to set bits B0 and B7, set nodeEnableRegister to 129 (1 + 128).
+
+
+
+
Bit
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
128
+
+
64
+
+
32
+
+
16
+
+
8
+
+
4
+
+
2
+
+
1
+
+
+
+
Weights
+
+
(27)
+
+
(26)
+
+
(25)
+
+
(24)
+
+
(23)
+
+
(22)
+
+
(21)
+
+
(20)
+
+
+
+
+
Example 1
+
+
+
+
nodeEnableRegister = status.MSB + status.OSB
+
status.node_enable = nodeEnableRegister
+
+
Sets the MSB and OSB bits of the system node enable register using constants.
+
+
+
+
+
Example 2
+
+
+
+
-- decimal 129 = binary 10000001
+
nodeEnableRegister = 129
+
status.node_enable = nodeEnableRegister
+
+
Sets the MSB and OSB bits of the system node enable register using a decimal value.
This attribute stores the status node event register.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Not applicable
+
+
Not saved
+
+
0
+
+
+
+
+
Usage
+
nodeEventRegister = status.node_event
+
+
+
+
nodeEventRegister
+
+
The node event register's status; a zero (0) indicates no bits set; other values indicate various bit settings
+
+
+
+
+
Details
+
This attribute is used to read the status node event register, which is returned as a numeric value (reading this register returns a value). The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000 0001. This value indicates that bit B0 and bit B7 are set.
+
+
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
+
+
+
* Least significant bit ** Most significant bit
+
The returned value can indicate one or more status events occurred.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
status.MEASUREMENT_SUMMARY_BIT status.MSB
+
+
Set summary bit indicates that an enabled measurement event has occurred.
+
Bit B0 decimal value: 1
+
+
+
+
B1
+
+
Not used
+
+
Not applicable
+
+
+
+
B2
+
+
status.ERROR_AVAILABLE status.EAV
+
+
Set summary bit indicates that an error or status message is present in the Error Queue.
+
Bit B2 decimal value: 4
+
+
+
+
B3
+
+
status.QUESTIONABLE_SUMMARY_BIT status.QSB
+
+
Set summary bit indicates that an enabled questionable event has occurred.
+
Bit B3 decimal value: 8
+
+
+
+
B4
+
+
status.MESSAGE_AVAILABLE status.MAV
+
+
Set summary bit indicates that a response message is present in the Output Queue.
+
Bit B4 decimal value: 16
+
+
+
+
B5
+
+
status.EVENT_SUMMARY_BIT status.ESB
+
+
Set summary bit indicates that an enabled standard event has occurred.
+
Bit B5 decimal value: 32
+
+
+
+
B6
+
+
status.MASTER_SUMMARY_STATUS status.MSS
+
+
Set bit indicates that an enabled Master Summary Status (MSS) bit of the Status Byte register is set.
+
Bit B6 decimal value: 64
+
+
+
+
B7
+
+
status.OPERATION_SUMMARY_BIT status.OSB
+
+
Set summary bit indicates that an enabled operation event has occurred.
+
Bit B7 decimal value: 128
+
+
+
+
+
+
In addition to the above constants, nodeEventRegister can be set to the decimal equivalent of the bit(s) set. When more than one bit of the register is set, nodeEventRegister contains the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).
+
+
+
+
Bit
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
128
+
+
64
+
+
32
+
+
16
+
+
8
+
+
4
+
+
2
+
+
1
+
+
+
+
Weights
+
+
(27)
+
+
(26)
+
+
(25)
+
+
(24)
+
+
(23)
+
+
(22)
+
+
(21)
+
+
(20)
+
+
+
+
+
Example
+
+
+
+
nodeEventRegister = status.node_event
+
print(nodeEventRegister)
+
+
Reads the status node event register.
+
Sample output:
+
1.29000e+02
+
Converting this output (129) to its binary equivalent yields 1000 0001
+
Therefore, this output indicates that the set bits of the status byte condition register are presently B0 (MSB) and B7 (OSB).
These attributes manage the status model's operation status register set.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute
+
+
- -
+
+
- -
+
+
- -
+
+
- -
+
+
+
+
.condition (R)
+
+
Yes
+
+
Not applicable
+
+
Not saved
+
+
Not applicable
+
+
+
+
.enable (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.event (R)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.ntr (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.ptr (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
+
+
+
+
+
Usage
+
operationRegister = status.operation.condition
+
operationRegister = status.operation.enable
+
operationRegister = status.operation.event
+
operationRegister = status.operation.ntr
+
operationRegister = status.operation.ptr
+
status.operation.enable = operationRegister
+
status.operation.ntr = operationRegister
+
status.operation.ptr = operationRegister
+
+
+
+
operationRegister
+
+
The operation status register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
+
Details
+
These attributes read or write the operation status registers.
+
Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101 0000 0000 0000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
1
+
+
0
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
+
+
+
* Least significant bit ** Most significant bit
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
status.operation.CALIBRATING
+
status.operation.CAL
+
+
Set bit indicates that the summary bit of the status.operation.calibrating register has been set.
+
Bit B0 decimal value: 1
+
+
+
+
B1-B2
+
+
Not used
+
+
Not applicable
+
+
+
+
B3
+
+
status.operation.SWEEPING
+
status.operation.SWE
+
+
Set bit indicates that the summary bit from the status.operation.sweeping register is set.
+
Bit B3 decimal value: 8
+
+
+
+
B4
+
+
status.operation.MEASURING
+
status.operation.MEAS
+
+
Set bit indicates that the summary bit of the status.operation.measuring register is set.
+
Bit B4 decimal value: 16
+
+
+
+
B5-B9
+
+
Not used
+
+
Not applicable
+
+
+
+
B10
+
+
status.operation.TRIGGER_OVERRUN
+
status.operation.TRGOVR
+
+
Set bit indicates that the summary bit from the
+
status.operation.trigger_overrun register is set.
+
Bit B10 decimal value: 1024
+
+
+
+
B11
+
+
status.operation.REMOTE_SUMMARY
+
status.operation.REM
+
+
Set bit indicates that the summary bit of the status.operation.remote register is set.
+
Bit B11 decimal value: 2048
+
+
+
+
B12
+
+
status.operation.USER
+
+
Set bit indicates that the summary bit from the status.operation.user register is set.
+
Bit B12 decimal value: 4096
+
+
+
+
B13
+
+
status.operation.INSTRUMENT_SUMMARY
+
status.operation.INST
+
+
Set bit indicates that the summary bit from the status.operation.instrument register is set.
+
Bit B13 decimal value: 8192
+
+
+
+
B14
+
+
status.operation.PROGRAM_RUNNING
+
status.operation.PROG
+
+
Set bit indicates that a command or program is running.
+
Bit B14 decimal value: 16,384
+
+
+
+
B15
+
+
Not used
+
+
Not applicable
+
+
+
+
+
As an example, to set bit B12 of the operation status enable register, set status.operation.enable= status.operation.USER.
+
In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4096 + 16,384).
+
+
+
+
Bit
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
128
+
+
64
+
+
32
+
+
16
+
+
8
+
+
4
+
+
2
+
+
1
+
+
+
+
Weights
+
+
(27)
+
+
(26)
+
+
(25)
+
+
(24)
+
+
(23)
+
+
(22)
+
+
(21)
+
+
(20)
+
+
+
+
+
+
+
+
Bit
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
32,768
+
+
16,384
+
+
8,192
+
+
4,096
+
+
2,048
+
+
1024
+
+
512
+
+
256
+
+
+
+
Weights
+
+
(215)
+
+
(214)
+
+
(213)
+
+
(212)
+
+
(211)
+
+
(210)
+
+
(29)
+
+
(28)
+
+
+
+
+
+
Example 1
+
+
+
+
operationRegister = status.operation.USER +
+
status.operation.PROG
+
status.operation.enable = operationRegister
+
+
Sets the USER and PROG bits of the operation status enable register using constants.
+
+
+
+
+
Example 2
+
+
+
+
-- decimal 20480 = binary 0101 0000 0000 0000
+
operationRegister = 20480
+
status.operation.enable = operationRegister
+
+
Sets the USER and PROG bits of the operation status enable register using a decimal value.
The operation calibrating event register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 2
+
+
+
+
+
Details
+
These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
Not used
+
+
Not applicable.
+
+
+
+
B1
+
+
status.operation.calibrating.SMUA
+
+
Set bit indicates that SMU A is unlocked for calibration.
+
Bit B1 decimal value: 2
+
Binary value: 0000 0010
+
+
+
+
B2-B15
+
+
Not used
+
+
Not applicable.
+
+
+
+
+
As an example, to set bit B1 of the operation status calibration summary enable register, set status.operation.calibrating.enable = status.operation.calibrating.SMUA.
+
In addition to the above constant, operationRegister can be set to the decimal equivalent of the bit to set.
+
Example
+
+
+
+
status.operation.calibrating.enable =
+
status.operation.calibrating.SMUA
+
+
Sets the SMUA bit of the operation status calibration summary enable register using a constant.
The operation event register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
+
Details
+
These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000 0100 0000 0010. This value indicates that bit B1 and bit B10 are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
+
+
+
* Least significant bit ** Most significant bit
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
Not used
+
+
Not applicable.
+
+
+
+
B1
+
+
status.operation.instrument.SMUA
+
+
Set bit indicates one or more enabled bits for the operation status SMU A summary register is set.
+
Bit B1 decimal value: 2
+
+
+
+
B2-B9
+
+
Not used
+
+
Not applicable.
+
+
+
+
B10
+
+
status.operation.instrument.TRIGGER_BLENDER
+
status.operation.instrument.TRGBLND
+
+
Set bit indicates one or more enabled bits for the operation status trigger blender summary register is set.
+
Bit B10 decimal value: 1024.
+
+
+
+
B11
+
+
status.operation.instrument.TRIGGER_TIMER
+
status.operation.instrument.TRGTMR
+
+
Set bit indicates one or more enabled bits for the operation status trigger timer summary register is set.
+
Bit B11 decimal value: 2048
+
+
+
+
B12
+
+
status.operation.instrument.DIGITAL_IO
+
status.operation.instrument.DIGIO
+
+
Set bit indicates one or more enabled bits for the operation status digital I/O summary register is set.
+
Bit B12 decimal value: 4096
+
+
+
+
B13
+
+
status.operation.instrument.TSPLINK
+
+
Set bit indicates one or more enabled bits for the operation status TSP-Link summary register is set.
+
Bit B13 decimal value: 8192
+
+
+
+
B14
+
+
status.operation.instrument.LAN
+
+
Set bit indicates one or more enabled bits for the operation status LAN summary register is set.
+
Bit B14 decimal value: 16,384
+
+
+
+
B15
+
+
Not used
+
+
Not applicable.
+
+
+
+
+
As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable= status.operation.instrument.SMUA.
+
In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024).
The operation status digital I/O summary register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024
+
+
+
+
+
Details
+
These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0-B9
+
+
Not used
+
+
Not applicable
+
+
+
+
B10
+
+
status.operation.instrument.digio.TRIGGER_OVERRUN
+
status.operation.instrument.digio.TRGOVR
+
+
Set bit indicates an enabled bit in the Operation Status Digital I/O Overrun Register is set.
+
Bit B10 decimal value: 1024
+
Binary value: 0100 0000 0010
+
+
+
+
B11-B15
+
+
Not used
+
+
Not applicable
+
+
+
+
+
+
In addition to the above constant, operationRegister can be set to the decimal equivalent of the bit to set.
+
Example
+
+
+
+
status.operation.instrument.digio.enable =
+
status.operation.instrument.digio.TRGOVR
+
+
Sets the TRGOVR bit of the operation status digital I/O summary enable register using a constant.
The operation status digio I/O overrun register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
+
Details
+
These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000 0100 0000 0010. This value indicates that bit b1 and bit B10 are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
+
+
+
* Least significant bit ** Most significant bit
+
A set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.
+
In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024).
The operation status lan summary register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
+
Details
+
These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000 0100 0000 0010. This value indicates that bit B1 and bit B10 are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
+
+
+
* Least significant bit ** Most significant bit
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
status.operation.instrument.lan.CONNECTION
+
status.operation.instrument.lan.CON
+
+
Set bit indicates that the LAN cable is connected and a link has been detected.
+
Bit B0 decimal value: 1
+
+
+
+
B1
+
+
status.operation.instrument.lan.CONFIGURING
+
status.operation.instrument.lan.CONF
+
+
Set bit indicates the LAN is performing its configuration sequence.
+
Bit B1 decimal value: 2
+
+
+
+
B2-B9
+
+
Not used
+
+
Not available
+
+
+
+
B10
+
+
status.operation.instrument.lan.TRIGGER_OVERRUN
+
status.operation.instrument.lan.TRGOVR
+
+
Set bit indicates one or more enabled bits for the operation status LAN trigger overrun register is set.
+
Bit B10 decimal value: 1024
+
+
+
+
B11-B15
+
+
Not used
+
+
Not applicable
+
+
+
+
+
+
As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable= status.operation.instrument.lan.CON.
+
In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024).
The operation status lan trigger overrun register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
+
Details
+
These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000 0001 0000 0010. This value indicates that bit B1 and bit B8 are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
+
+
+
* Least significant bit ** Most significant bit
+
A set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.
+
In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256).
The operation status SMU X summary register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
X
+
+
Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel A)
+
+
+
+
+
Details
+
These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1025) is read as the value of the condition register, the binary equivalent is 0000 0100 0000 0010. This value indicates that bit B0 and bit B10 are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
+
+
+
* Least significant bit ** Most significant bit
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
status.operation.instrument.smuX.CALIBRATING
+
status.operation.instrument.smuX.CAL
+
+
Set bit indicates thatsmuX is unlocked for calibration.
+
Bit B0 decimal value: 1
+
+
+
+
B1-B2
+
+
Not used
+
+
Not applicable.
+
+
+
+
B3
+
+
status.operation.instrument.smuX.SWEEPING
+
status.operation.instrument.smuX.SWE
+
+
Set bit indicates thatsmuX is sweeping.
+
Bit B3 decimal value: 8
+
+
+
+
B4
+
+
status.operation.instrument.smuX.MEASURING
+
status.operation.instrument.smuX.MEAS
+
+
Bit will be set when taking an overlapped measurement, but it will not set when taking a normal synchronous measurement.
+
Bit B4 decimal value: 16
+
+
+
+
B5-B9
+
+
Not used
+
+
Not applicable.
+
+
+
+
B10
+
+
status.operation.instrument.smuX.TRIGGER_OVERRUN
+
status.operation.instrument.smuX.TRGOVR
+
+
Set bit indicates an enabled bit has been set in the operation status smu X trigger overrun event register.
+
Bit B10 decimal value: 1024
+
+
+
+
B11-B15
+
+
Not used
+
+
Not applicable.
+
+
+
+
+
+
As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable=status.operation.instrument.smua.CAL.
+
In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1025 (which is the sum of 1 + 1024).
+
+
+
+
Bit
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
128
+
+
64
+
+
32
+
+
16
+
+
8
+
+
4
+
+
2
+
+
1
+
+
+
+
Weights
+
+
(27)
+
+
(26)
+
+
(25)
+
+
(24)
+
+
(23)
+
+
(22)
+
+
(21)
+
+
(20)
+
+
+
+
+
+
+
+
+
Bit
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
32,768
+
+
16,384
+
+
8192
+
+
4096
+
+
2048
+
+
1024
+
+
512
+
+
256
+
+
+
+
Weights
+
+
(215)
+
+
(214)
+
+
(213)
+
+
(212)
+
+
(211)
+
+
(210)
+
+
(29)
+
+
(28)
+
+
+
+
+
Example
+
+
+
+
status.operation.instrument.smua.enable =
+
status.operation.instrument.smua.MEAS
+
+
Sets the MEAS bit of the operation status SMU A summary enable register using a constant.
The operation status SMU X trigger overrun register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
+
Details
+
These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000 0001 0010. This value indicates that bit B1 and bit B4 are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
0
+
+
1
+
+
0
+
+
+
+
+
* Least significant bit ** Most significant bit
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
Set bit indicates that the end pulse event detector of the SMU was already in the detected state when a trigger was received.
+
Bit B4 decimal value: 16
+
+
+
+
B5-B15
+
+
Not used
+
+
Not applicable.
+
+
+
+
+
+
As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable= status.operation.instrument.smua.trigger_overrun.ARM.
+
In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).
The operation status trigger blender summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024
+
+
+
+
+
Details
+
These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
Set bit indicates one or more enabled bits for operation status trigger blender overrun register is set.
+
Bit B10 decimal value: 1024
+
Binary value: 0100 0000 0000
+
+
+
+
B11-B15
+
+
Not used
+
+
Not applicable.
+
+
+
+
+
+
In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to 1024.
The operation status trigger blender overrun register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
+
Details
+
These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000 0001 0010. This value indicates that bit B1 and bit B4 are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
0
+
+
1
+
+
0
+
+
+
+
+
* Least significant bit ** Most significant bit
+
A set bit value indicates that the specified trigger blender generated an action overrun.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.
+
In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).
The operation status trigger timer summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024
+
+
+
+
+
Details
+
These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
Set bit indicates one or more enabled bits for the operation status trigger timer overrun register is set.
+
Bit B10 decimal value: 1024
+
Binary value: 0100 0000 0000
+
+
+
+
B11-B15
+
+
Not used
+
+
Not applicable
+
+
+
+
+
+
In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to 1024.
The operation status trigger timer trigger overrun register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
+
Details
+
These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000 0001 0010. This value indicates that bit B1 and bit B4 are set.
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
0
+
+
1
+
+
0
+
+
+
+
+
* Least significant bit ** Most significant bit
+
A set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.
+
In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16).
The operation status TSP-Link summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024
+
+
+
+
+
Details
+
These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
Set bit indicates one or more enabled bits for the operation status TSP-Link overrun register is set.
+
Bit B10 decimal value: 1024
+
Binary value: 0100 0000 0000
+
+
+
+
B11-B15
+
+
Not used
+
+
Not applicable
+
+
+
+
+
+
In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to 1024.
+
Example
+
+
+
+
status.operation.instrument.tsplink.enable = 1024
+
+
+
Sets the trigger overrun bit of the operation status TSP-Link summary enable register using a decimal value.
The operation status TSP-link overrun register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
+
Details
+
These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000 0000 0000 1010. This value indicates that bit B1 and bit B3 are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
1
+
+
0
+
+
+
+
+
* Least significant bit ** Most significant bit
+
A set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.
+
In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8).
The operation status measuring summary register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than zero (0) is 2
+
+
+
+
+
Details
+
These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
Not used
+
+
Not applicable.
+
+
+
+
B1
+
+
status.operation.measuring.SMUA
+
+
Bit will be set when taking an overlapped measurement, but it will not set when taking a normal synchronous measurement.
+
Bit B1 decimal value: 2
+
Binary value: 0000 0010
+
+
+
+
B2-B15
+
+
Not used
+
+
Not applicable.
+
+
+
+
+
+
In addition to the above constant, operationRegister can be set to the decimal equivalent of the bit to set.
+
Example
+
+
+
+
status.operation.measuring.enable =
+
status.operation.measuring.SMUA
+
+
Sets the SMUA bit of the operation status measuring summary enable register using a constant.
The operation status remote summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
+
Details
+
These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
Not used
+
+
Not applicable.
+
+
+
+
B1
+
+
status.operation.remote.COMMAND_AVAILABLE
+
status.operation.remote.CAV
+
+
Set bit indicates there is a command available in the execution queue.
+
Bit B1 decimal value: 2
+
Binary value: 0000 0000 0000 0010
+
+
+
+
B2-B10
+
+
Not used
+
+
Not applicable.
+
+
+
+
B11
+
+
status.operation.remote.PROMPTS_ENABLED
+
status.operation.remote.PRMPT
+
+
Set bit indicates command prompts are enabled.
+
Bit B11 decimal value: 2048
+
Binary value: 0000 0100 0000 0000
+
+
+
+
B12-B15
+
+
Not used
+
+
Not applicable.
+
+
+
+
+
+
As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.
+
In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B11, set operationRegister to 2050 (which is the sum of 2 + 2048).
+
Example
+
+
+
+
status.operation.remote.enable =
+
status.operation.remote.CAV
+
+
Sets the CAV bit of the operation status remote summary enable register using a constant.
The operation status sweeping summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than zero (0) is 2
+
+
+
+
+
Details
+
These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
Not used
+
+
Not applicable.
+
+
+
+
B1
+
+
status.operation.sweeping.SMUA
+
+
Set bit indicates that SMU A is sweeping.
+
Bit B1 decimal value: 2
+
Binary value: 0000 0010
+
+
+
+
B2-B5
+
+
Not used
+
+
Not applicable.
+
+
+
+
+
+
In addition to the above constant, operationRegister can be set to the decimal equivalent of the bit to set.
+
Example
+
+
+
+
status.operation.sweeping.enable =
+
status.operation.sweeping.SMUA
+
+
Sets the SMUA bit of the operation status sweeping summary enable register using a constant.
The operation status trigger overrun summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
+
Details
+
These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000 0100 0000 0010. This value indicates that bit B1 and bit B10 are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
+
+
+
* Least significant bit ** Most significant bit
+
+
The bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
Not used
+
+
Not applicable.
+
+
+
+
B1
+
+
status.operation.trigger_overrun.SMUA
+
+
Set bit indicates one of the enabled bits in the operation status SMU A trigger overrun event register is set.
+
Bit B1 decimal value: 2
+
+
+
+
B2-B9
+
+
Not used
+
+
Not applicable.
+
+
+
+
B10
+
+
status.operation.trigger_overrun.TRIGGER_BLENDER
+
status.operation.trigger_overrun.TRGBLND
+
+
Set bit indicates one of the enabled bits in the operation status trigger blender overrun event register is set.
+
Bit B10 decimal value: 1024
+
+
+
+
B11
+
+
status.operation.trigger_overrun.TRIGGER_TIMER
+
status.operation.trigger_overrun.TRGTMR
+
+
Set bit indicates one of the enabled bits in the operation status trigger timer overrun event register is set.
+
Bit B11 decimal value: 2048
+
+
+
+
B12
+
+
status.operation.trigger_overrun.DIGITAL_IO
+
status.operation.trigger_overrun.DIGIO
+
+
Set bit indicates one of the enabled bits in the operation status digital I/O overrun event register is set.
+
Bit B12 decimal value: 4096
+
+
+
+
B13
+
+
status.operation.trigger_overrun.TSPLINK
+
+
Set bit indicates one of the enabled bits in the operation status TSP-Link overrun event register is set.
+
Bit B13 decimal value: 8192
+
+
+
+
B14
+
+
status.operation.trigger_overrun.LAN
+
+
Set bit indicates one of the enabled bits in the operation status LAN trigger overrun event register is set.
+
Bit B14 decimal value: 16,384
+
+
+
+
B15
+
+
Not used
+
+
Not applicable.
+
+
+
+
+
+
As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.
+
In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1026 (which is the sum of 2 + 1024).
The operation status user register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
+
Details
+
These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000 0000 1000 0001. This value indicates that bits B0 and B7 are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
+
+
+
* Least significant bit ** Most significant bit
+
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
status.operation.user.BIT0
+
+
Bit B0 decimal value: 1
+
+
+
+
B1
+
+
status.operation.user.BIT1
+
+
Bit B1 decimal value: 2
+
+
+
+
B2
+
+
status.operation.user.BIT2
+
+
Bit B2 decimal value: 4
+
+
+
+
B3
+
+
status.operation.user.BIT3
+
+
Bit B3 decimal value: 8
+
+
+
+
B4
+
+
status.operation.user.BIT4
+
+
Bit B4 decimal value: 16
+
+
+
+
B5
+
+
status.operation.user.BIT5
+
+
Bit B5 decimal value: 32
+
+
+
+
B6
+
+
status.operation.user.BIT6
+
+
Bit B6 decimal value: 64
+
+
+
+
B7
+
+
status.operation.user.BIT7
+
+
Bit B7 decimal value: 128
+
+
+
+
B8
+
+
status.operation.user.BIT8
+
+
Bit B8 decimal value: 256
+
+
+
+
B9
+
+
status.operation.user.BIT9
+
+
Bit B9 decimal value: 512
+
+
+
+
B10
+
+
status.operation.user.BIT10
+
+
Bit B10 decimal value: 1024
+
+
+
+
B11
+
+
status.operation.user.BIT11
+
+
Bit B11 decimal value: 2048
+
+
+
+
B12
+
+
status.operation.user.BIT12
+
+
Bit B12 decimal value: 4096
+
+
+
+
B13
+
+
status.operation.user.BIT13
+
+
Bit B13 decimal value: 8192
+
+
+
+
B14
+
+
status.operation.user.BIT14
+
+
Bit B14 decimal value: 16,384
+
+
+
+
B15
+
+
Not used
+
+
Not applicable
+
+
+
+
+
As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable= status.operation.user.BIT0.
+
In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2048 + 16,384).
+
+
+
+
Bit
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
128
+
+
64
+
+
32
+
+
16
+
+
8
+
+
4
+
+
2
+
+
1
+
+
+
+
Weights
+
+
(27)
+
+
(26)
+
+
(25)
+
+
(24)
+
+
(23)
+
+
(22)
+
+
(21)
+
+
(20)
+
+
+
+
+
+
+
+
+
Bit
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
32,768
+
+
16,384
+
+
8192
+
+
4096
+
+
2048
+
+
1024
+
+
512
+
+
256
+
+
+
+
Weights
+
+
(215)
+
+
(214)
+
+
(213)
+
+
(212)
+
+
(211)
+
+
(210)
+
+
(29)
+
+
(28)
+
+
+
+
+
Example 1
+
+
+
+
operationRegister = status.operation.user.BIT11 +
+
status.operation.user.BIT14
+
status.operation.user.enable = operationRegister
+
+
Sets bits B11 and B14 of the operation status user enable register using constants.
+
+
+
+
+
Example 2
+
+
+
+
-- 18432 = binary 0100 1000 0000 0000
+
operationRegister = 18432
+
status.operation.enable = operationRegister
+
+
Sets bits B11 and B14 of the operation status user enable register using a decimal value.
These attributes manage the status model's questionable status register set.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute
+
+
- -
+
+
- -
+
+
- -
+
+
- -
+
+
+
+
.condition (R)
+
+
Yes
+
+
Not applicable
+
+
Not saved
+
+
Not applicable
+
+
+
+
.enable (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.event (R)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.ntr (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.ptr (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
13,056 (All bits set)
+
+
+
+
+
Usage
+
quesRegister = status.questionable.condition
+
quesRegister = status.questionable.enable
+
quesRegister = status.questionable.event
+
quesRegister = status.questionable.ntr
+
quesRegister = status.questionable.ptr
+
status.questionable.enable = quesRegister
+
status.questionable.ntr = quesRegister
+
status.questionable.ptr = quesRegister
+
+
+
+
quesRegister
+
+
The questionable status register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
+
Details
+
These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011 0000 0000 0000. This value indicates that bits B12 and B13 are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
1
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
+
+
+
* Least significant bit ** Most significant bit
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
An enabled bit in the questionable status instrument summary event register is set.
+
Bit B13 decimal value: 8192
+
+
+
+
B14-B15
+
+
Not used
+
+
Not available
+
+
+
+
+
As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.
+
In addition to the above constants, quesRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set quesRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set quesRegister to 12,288 (which is the sum of 4096 + 8192).
The questionable status calibration summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than zero (0) is 2
+
+
+
+
+
Details
+
These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
Not used
+
+
Not applicable.
+
+
+
+
B1
+
+
status.questionable.calibration.SMUA
+
+
Set bit indicates that the calibration constants stored in nonvolatile memory were corrupted and could not be loaded when the instrument powered up.
+
Bit B1 decimal value: 2
+
Binary value: 0000 0010
+
+
+
+
B2 to B15
+
+
Not used
+
+
Not applicable.
+
+
+
+
+
+
In addition to the above constant, questionableRegister can be set to the decimal equivalent of the bit to set.
+
Example
+
+
+
+
status.questionable.calibration.enable =
+
status.questionable.calibration.SMUA
+
+
Sets the SMUA bit of the questionable status calibration summary enable register using a constant.
The questionable status instrument summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 2
+
+
+
+
+
Details
+
These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
Not used
+
+
Not applicable
+
+
+
+
B1
+
+
status.questionable.instrument.SMUA
+
+
Set bit indicates one or more enabled bits in the questionable status SMU A summary event register are set.
+
Bit B1 decimal value: 2
+
Binary value: 0000 0010
+
+
+
+
B2 to B15
+
+
Not used
+
+
Not applicable.
+
+
+
+
+
In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set.
+
Example
+
+
+
+
status.questionable.instrument.enable =
+
status.questionable.instrument.SMUA
+
+
Sets the SMUA bit of the questionable status instrument summary enable register using a constant.
The questionable status SMU X summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
X
+
+
Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)
+
+
+
+
+
Details
+
These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000 0011 0000 0000. This value indicates that bit B8 and bit B9 are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
+
+
+
* Least significant bit ** Most significant bit
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
Set bit indicates that an over temperature condition was detected.
+
Bit B12 decimal value: 4096
+
+
+
+
B13-B15
+
+
Not used
+
+
Not applicable.
+
+
+
+
+
+
As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.
+
In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512).
+
+
+
+
Bit
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
128
+
+
64
+
+
32
+
+
16
+
+
8
+
+
4
+
+
2
+
+
1
+
+
+
+
Weights
+
+
(27)
+
+
(26)
+
+
(25)
+
+
(24)
+
+
(23)
+
+
(22)
+
+
(21)
+
+
(20)
+
+
+
+
+
+
+
+
+
Bit
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
32,768
+
+
16,384
+
+
8192
+
+
4096
+
+
2048
+
+
1024
+
+
512
+
+
256
+
+
+
+
Weights
+
+
(215)
+
+
(214)
+
+
(213)
+
+
(212)
+
+
(211)
+
+
(210)
+
+
(29)
+
+
(28)
+
+
+
+
+
Example
+
+
+
+
questionableRegister =
+
status.questionable.instrument.smua.CAL +
+
status.questionable.instrument.smua.UO
+
status.questionable.instrument.smua.enable =
+
questionableRegister
+
+
Sets bit B8 and bit B9 of the questionable status SMU A summary enable register using constants.
The questionable status over temperature summary register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 2
+
+
+
+
+
Details
+
These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
Not used
+
+
Not applicable.
+
+
+
+
B1
+
+
status.questionable.over_temperature.SMUA
+
+
Set bit indicates that an over temperature indication was detected.
+
Bit B1 decimal value: 2
+
Binary value: 0000 0010
+
+
+
+
B2-B15
+
+
Not used
+
+
Not applicable.
+
+
+
+
+
In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set.
+
+
Example
+
+
+
+
status.questionable.over_temperature.enable =
+
status.questionable.over_temperature.SMUA
+
+
Sets the SMU A bit in the questionable status over temperature summary enable register using a constant.
The questionable status unstable output summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 2
+
+
+
+
+
Details
+
These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
Not used
+
+
Not applicable.
+
+
+
+
B1
+
+
status.questionable.unstable_output.SMUA
+
+
Set bit indicates that an unstable output condition was detected.
+
Bit B1 decimal value: 2
+
Binary value: 0000 0010
+
+
+
+
B2-B15
+
+
Not used
+
+
Not applicable.
+
+
+
+
+
In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set.
+
+
Example
+
+
+
+
status.questionable.unstable_output.enable =
+
status.questionable.unstable_output.SMUA
+
+
Sets the SMU A bit in the questionable status unstable output summary enable register bit using a constant.
This function resets all bits in the system status model.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
status.reset()
+
Details
+
This function clears all status data structure registers (enable, event, NTR, and PTR) to their default values. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers.
These attributes manage the status model's standard event status register set.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute
+
+
- -
+
+
- -
+
+
- -
+
+
- -
+
+
+
+
.condition (R)
+
+
Yes
+
+
Not applicable
+
+
Not saved
+
+
Not applicable
+
+
+
+
.enable (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.event (R)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.ntr (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.ptr (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
253 (All bits set)
+
+
+
+
+
Usage
+
standardRegister = status.standard.condition
+
standardRegister = status.standard.enable
+
standardRegister = status.standard.event
+
standardRegister = status.standard.ntr
+
standardRegister = status.standard.ptr
+
status.standard.enable = standardRegister
+
status.standard.ntr = standardRegister
+
status.standard.ptr = standardRegister
+
+
+
+
standardRegister
+
+
The standard event status register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
+
Details
+
These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000 0000 1000 0001. This value indicates that bit B0 and bit B7 are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
+
+
+
* Least significant bit ** Most significant bit
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
Set bit indicates that all pending selected instrument operations are completed and the instrument is ready to accept new commands. The bit is set in response to an *OPC command. The opc() function can be used in place of the *OPC command.
+
Bit B0 decimal value: 1
+
+
+
+
B1
+
+
Not used
+
+
Not applicable
+
+
+
+
B2
+
+
status.standard.QUERY_ERROR status.standard.QYE
+
+
Set bit indicates that you attempted to read data from an empty Output Queue.
Set bit indicates that the instrument detected an error while trying to execute a command.
+
Bit B4 decimal value: 16
+
+
+
+
B5
+
+
status.standard.COMMAND_ERROR status.standard.CME
+
+
Set bit indicates that a command error has occurred. Command errors include:
+
IEEE Std 488.2 syntax error: Instrument received a message that does not follow the defined syntax of the IEEE Std 488.2 standard.
+
Semantic error: Instrument received a command that was misspelled or received an optional IEEE Std 488.2 command that is not implemented.
+
GET error: The instrument received a Group Execute Trigger (GET) inside a program message.
+
Bit B5 decimal value: 32
+
+
+
+
B6
+
+
status.standard.USER_REQUEST status.standard.URQ
+
+
Set bit indicates that the LOCAL key on the instrument front panel was pressed.
+
Bit B6 decimal value: 64
+
+
+
+
B7
+
+
status.standard.POWER_ON status.standard.PON
+
+
Set bit indicates that the instrument has been turned off and turned back on since the last time this register has been read.
+
Bit B7 decimal value: 128
+
+
+
+
B8-B15
+
+
Not used
+
+
Not applicable
+
+
+
+
+
As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.
+
In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).
+
+
+
+
Bit
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
128
+
+
64
+
+
32
+
+
16
+
+
8
+
+
4
+
+
2
+
+
1
+
+
+
+
Weights
+
+
(27)
+
+
(26)
+
+
(25)
+
+
(24)
+
+
(23)
+
+
(22)
+
+
(21)
+
+
(20)
+
+
+
+
+
Example 1
+
+
+
+
standardRegister = status.standard.OPC
+
+ status.standard.EXE
+
status.standard.enable = standardRegister
+
+
Sets the OPC and EXE bits of the standard event status enable register using constants.
+
+
+
+
+
Example 2
+
+
+
+
-- decimal 17 = binary 0001 0001
+
standardRegister = 17
+
status.standard.enable = standardRegister
+
+
Sets the OPC and EXE bits of the standard event status enable register using a decimal value.
These attributes manage the status model's TSP-Link® system summary register for nodes 1 through 14.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute
+
+
- -
+
+
- -
+
+
- -
+
+
- -
+
+
+
+
.condition (R)
+
+
Yes
+
+
Not applicable
+
+
Not saved
+
+
Not applicable
+
+
+
+
.enable (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.event (R)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.ntr (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.ptr (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
32,767 (All bits set)
+
+
+
+
+
Usage
+
enableRegister = status.system.condition
+
enableRegister = status.system.enable
+
enableRegister = status.system.event
+
enableRegister = status.system.ntr
+
enableRegister = status.system.ptr
+
status.system.enable = enableRegister
+
status.system.ntr = enableRegister
+
status.system.ptr = enableRegister
+
+
+
+
enableRegister
+
+
The system summary register's status; a zero (0) indicates no bits set; other values indicate various bit settings
+
+
+
+
+
Details
+
In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000 0000 1000 0001. This value indicates that bit B0 and bit B7 are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
+
+
+
* Least significant bit ** Most significant bit
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
status.system.EXTENSION_BIT status.system.EXT
+
+
Bit B0 decimal value: 1
+
+
+
+
B1
+
+
status.system.NODE1
+
+
Bit B1 decimal value: 2
+
+
+
+
B2
+
+
status.system.NODE2
+
+
Bit B2 decimal value: 4
+
+
+
+
B3
+
+
status.system.NODE3
+
+
Bit B3 decimal value: 8
+
+
+
+
B4
+
+
status.system.NODE4
+
+
Bit B4 decimal value: 16
+
+
+
+
B5
+
+
status.system.NODE5
+
+
Bit B5 decimal value: 32
+
+
+
+
B6
+
+
status.system.NODE6
+
+
Bit B6 decimal value: 64
+
+
+
+
B7
+
+
status.system.NODE7
+
+
Bit B7 decimal value: 128
+
+
+
+
B8
+
+
status.system.NODE8
+
+
Bit B8 decimal value: 256
+
+
+
+
B9
+
+
status.system.NODE9
+
+
Bit B9 decimal value: 512
+
+
+
+
B10
+
+
status.system.NODE10
+
+
Bit B10 decimal value: 1024
+
+
+
+
B11
+
+
status.system.NODE11
+
+
Bit B11 decimal value: 2048
+
+
+
+
B12
+
+
status.system.NODE12
+
+
Bit B12 decimal value: 4096
+
+
+
+
B13
+
+
status.system.NODE13
+
+
Bit B13 decimal value: 8192
+
+
+
+
B14
+
+
status.system.NODE14
+
+
Bit B14 decimal value: 16384
+
+
+
+
B15
+
+
Not used
+
+
Not applicable
+
+
+
+
+
+
As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.
+
In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2048 + 16,384).
+
+
+
+
Bit
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
128
+
+
64
+
+
32
+
+
16
+
+
8
+
+
4
+
+
2
+
+
1
+
+
+
+
Weights
+
+
(27)
+
+
(26)
+
+
(25)
+
+
(24)
+
+
(23)
+
+
(22)
+
+
(21)
+
+
(20)
+
+
+
+
+
+
+
+
Bit
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
32,768
+
+
16,384
+
+
8,192
+
+
4,096
+
+
2,048
+
+
1024
+
+
512
+
+
256
+
+
+
+
Weights
+
+
(215)
+
+
(214)
+
+
(213)
+
+
(212)
+
+
(211)
+
+
(210)
+
+
(29)
+
+
(28)
+
+
+
+
+
+
Example 1
+
+
+
+
enableRegister = status.system.NODE11 +
+
status.system.NODE14
+
status.system.enable = enableRegister
+
+
Sets bits B11 and B14 of the system summary enable register using constants.
+
+
+
+
+
Example 2
+
+
+
+
-- decimal 18432 = binary 0100 1000 0000 0000
+
enableRegister = 18432
+
status.system.enable = enableRegister
+
+
Sets bits B11 and B14 of the system summary enable register using a decimal value.
These attributes manage the status model's TSP-Link® system summary register for nodes 15 through 28.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute
+
+
- -
+
+
- -
+
+
- -
+
+
- -
+
+
+
+
.condition (R)
+
+
Yes
+
+
Not applicable
+
+
Not saved
+
+
Not applicable
+
+
+
+
.enable (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.event (R)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.ntr (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.ptr (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
32,767 (All bits set)
+
+
+
+
+
Usage
+
enableRegister = status.system2.condition
+
enableRegister = status.system2.enable
+
enableRegister = status.system2.event
+
enableRegister = status.system2.ntr
+
enableRegister = status.system2.ptr
+
status.system2.enable = enableRegister
+
status.system2.ntr = enableRegister
+
status.system2.ptr = enableRegister
+
+
+
+
enableRegister
+
+
The system summary 2 register's status; a zero (0) indicates no bits set; other values indicate various bit settings
+
+
+
+
+
Details
+
In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000 0000 1000 0001. This value indicates that bit B0 and bit B7 are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
+
+
+
* Least significant bit ** Most significant bit
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
status.system2.EXTENSION_BIT status.system2.EXT
+
+
Bit B0 decimal value: 1
+
+
+
+
B1
+
+
status.system2.NODE15
+
+
Bit B1 decimal value: 2
+
+
+
+
B2
+
+
status.system2.NODE16
+
+
Bit B2 decimal value: 4
+
+
+
+
B3
+
+
status.system2.NODE17
+
+
Bit B3 decimal value: 8
+
+
+
+
B4
+
+
status.system2.NODE18
+
+
Bit B4 decimal value: 16
+
+
+
+
B5
+
+
status.system2.NODE19
+
+
Bit B5 decimal value: 32
+
+
+
+
B6
+
+
status.system2.NODE20
+
+
Bit B6 decimal value: 64
+
+
+
+
B7
+
+
status.system2.NODE21
+
+
Bit B7 decimal value: 128
+
+
+
+
B8
+
+
status.system2.NODE22
+
+
Bit B8 decimal value: 256
+
+
+
+
B9
+
+
status.system2.NODE23
+
+
Bit B9 decimal value: 512
+
+
+
+
B10
+
+
status.system2.NODE24
+
+
Bit B10 decimal value: 1024
+
+
+
+
B11
+
+
status.system2.NODE25
+
+
Bit B11 decimal value: 2048
+
+
+
+
B12
+
+
status.system2.NODE26
+
+
Bit B12 decimal value: 4096
+
+
+
+
B13
+
+
status.system2.NODE27
+
+
Bit B13 decimal value: 8192
+
+
+
+
B14
+
+
status.system2.NODE28
+
+
Bit B14 decimal value: 16,384
+
+
+
+
B15
+
+
Not used
+
+
Not applicable
+
+
+
+
+
+
As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.
+
In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2048 + 16,384).
+
+
+
+
Bit
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
128
+
+
64
+
+
32
+
+
16
+
+
8
+
+
4
+
+
2
+
+
1
+
+
+
+
Weights
+
+
(27)
+
+
(26)
+
+
(25)
+
+
(24)
+
+
(23)
+
+
(22)
+
+
(21)
+
+
(20)
+
+
+
+
+
+
+
+
Bit
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
32,768
+
+
16,384
+
+
8,192
+
+
4,096
+
+
2,048
+
+
1024
+
+
512
+
+
256
+
+
+
+
Weights
+
+
(215)
+
+
(214)
+
+
(213)
+
+
(212)
+
+
(211)
+
+
(210)
+
+
(29)
+
+
(28)
+
+
+
+
+
+
Example 1
+
+
+
+
enableRegister = status.system2.NODE25 +
+
status.system2.NODE28
+
status.system2.enable = enableRegister
+
+
Sets bits B11 and B14 of the system summary 2 enable register using constants.
+
+
+
+
+
Example 2
+
+
+
+
-- decimal 18432 = binary 0100 1000 0000 0000
+
enableRegister = 18432
+
status.system2.enable = enableRegister
+
+
Sets bits B11 and B14 of the system summary 2 enable register using a decimal value.
These attributes manage the status model's TSP-Link® system summary register for nodes 29 through 42.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute
+
+
- -
+
+
- -
+
+
- -
+
+
- -
+
+
+
+
.condition (R)
+
+
Yes
+
+
Not applicable
+
+
Not saved
+
+
Not applicable
+
+
+
+
.enable (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.event (R)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.ntr (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.ptr (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
32,767 (All bits set)
+
+
+
+
+
Usage
+
enableRegister = status.system3.condition
+
enableRegister = status.system3.enable
+
enableRegister = status.system3.event
+
enableRegister = status.system3.ntr
+
enableRegister = status.system3.ptr
+
status.system3.enable = enableRegister
+
status.system3.ntr = enableRegister
+
status.system3.ptr = enableRegister
+
+
+
+
enableRegister
+
+
The system summary 3 register's status; a zero (0) indicates no bits set; other values indicate various bit settings
+
+
+
+
+
Details
+
In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000 0000 1000 0001. This value indicates that bit B0 and bit B7 are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
+
+
+
* Least significant bit ** Most significant bit
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
status.system3.EXTENSION_BIT status.system3.EXT
+
+
Bit B0 decimal value: 1
+
+
+
+
B1
+
+
status.system3.NODE29
+
+
Bit B1 decimal value: 2
+
+
+
+
B2
+
+
status.system3.NODE30
+
+
Bit B2 decimal value: 4
+
+
+
+
B3
+
+
status.system3.NODE31
+
+
Bit B3 decimal value: 8
+
+
+
+
B4
+
+
status.system3.NODE32
+
+
Bit B4 decimal value: 16
+
+
+
+
B5
+
+
status.system3.NODE33
+
+
Bit B5 decimal value: 32
+
+
+
+
B6
+
+
status.system3.NODE34
+
+
Bit B6 decimal value: 64
+
+
+
+
B7
+
+
status.system3.NODE35
+
+
Bit B7 decimal value: 128
+
+
+
+
B8
+
+
status.system3.NODE36
+
+
Bit B8 decimal value: 256
+
+
+
+
B9
+
+
status.system3.NODE37
+
+
Bit B9 decimal value: 512
+
+
+
+
B10
+
+
status.system3.NODE38
+
+
Bit B10 decimal value: 1024
+
+
+
+
B11
+
+
status.system3.NODE39
+
+
Bit B11 decimal value: 2048
+
+
+
+
B12
+
+
status.system3.NODE40
+
+
Bit B12 decimal value: 4096
+
+
+
+
B13
+
+
status.system3.NODE41
+
+
Bit B13 decimal value: 8192
+
+
+
+
B14
+
+
status.system3.NODE42
+
+
Bit B14 decimal value: 16,384
+
+
+
+
B15
+
+
Not used
+
+
Not applicable
+
+
+
+
+
+
As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.
+
In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2048 + 16,384).
+
+
+
+
Bit
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
128
+
+
64
+
+
32
+
+
16
+
+
8
+
+
4
+
+
2
+
+
1
+
+
+
+
Weights
+
+
(27)
+
+
(26)
+
+
(25)
+
+
(24)
+
+
(23)
+
+
(22)
+
+
(21)
+
+
(20)
+
+
+
+
+
+
+
+
Bit
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
32,768
+
+
16,384
+
+
8,192
+
+
4,096
+
+
2,048
+
+
1024
+
+
512
+
+
256
+
+
+
+
Weights
+
+
(215)
+
+
(214)
+
+
(213)
+
+
(212)
+
+
(211)
+
+
(210)
+
+
(29)
+
+
(28)
+
+
+
+
+
+
Example 1
+
+
+
+
enableRegister = status.system3.NODE39 +
+
status.system3.NODE42
+
status.system3.enable = enableRegister
+
+
Sets bits B11 and B14 of the system summary 3 enable register using constants.
+
+
+
+
+
Example 2
+
+
+
+
-- decimal 18432 = binary 0100 1000 0000 0000
+
enableRegister = 18432
+
status.system3.enable = enableRegister
+
+
Sets bits B11 and B14 of the system summary 3 enable register using a decimal value.
These attributes manage the status model's TSP-Link® system summary register for nodes 43 through 56.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute
+
+
- -
+
+
- -
+
+
- -
+
+
- -
+
+
+
+
.condition (R)
+
+
Yes
+
+
Not applicable
+
+
Not saved
+
+
Not applicable
+
+
+
+
.enable (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.event (R)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.ntr (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.ptr (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
32,767 (All bits set)
+
+
+
+
+
Usage
+
enableRegister = status.system4.condition
+
enableRegister = status.system4.enable
+
enableRegister = status.system4.event
+
enableRegister = status.system4.ntr
+
enableRegister = status.system4.ptr
+
status.system4.enable = enableRegister
+
status.system4.ntr = enableRegister
+
status.system4.ptr = enableRegister
+
+
+
+
enableRegister
+
+
The system summary 4 register's status; a zero (0) indicates no bits set; other values indicate various bit settings
+
+
+
+
+
Details
+
In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000 0000 1000 0001. This value indicates that bit B0 and bit B7 are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
+
+
+
* Least significant bit ** Most significant bit
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
status.system4.EXTENSION_BIT status.system4.EXT
+
+
Bit B0 decimal value: 1
+
+
+
+
B1
+
+
status.system4.NODE43
+
+
Bit B1 decimal value: 2
+
+
+
+
B2
+
+
status.system4.NODE44
+
+
Bit B2 decimal value: 4
+
+
+
+
B3
+
+
status.system4.NODE45
+
+
Bit B3 decimal value: 8
+
+
+
+
B4
+
+
status.system4.NODE46
+
+
Bit B4 decimal value: 16
+
+
+
+
B5
+
+
status.system4.NODE47
+
+
Bit B5 decimal value: 32
+
+
+
+
B6
+
+
status.system4.NODE48
+
+
Bit B6 decimal value: 64
+
+
+
+
B7
+
+
status.system4.NODE49
+
+
Bit B7 decimal value: 128
+
+
+
+
B8
+
+
status.system4.NODE50
+
+
Bit B8 decimal value: 256
+
+
+
+
B9
+
+
status.system4.NODE51
+
+
Bit B9 decimal value: 512
+
+
+
+
B10
+
+
status.system4.NODE52
+
+
Bit B10 decimal value: 1024
+
+
+
+
B11
+
+
status.system4.NODE53
+
+
Bit B11 decimal value: 2048
+
+
+
+
B12
+
+
status.system4.NODE54
+
+
Bit B12 decimal value: 4096
+
+
+
+
B13
+
+
status.system4.NODE55
+
+
Bit B13 decimal value: 8192
+
+
+
+
B14
+
+
status.system4.NODE56
+
+
Bit B14 decimal value: 16,384
+
+
+
+
B15
+
+
Not used
+
+
Not applicable
+
+
+
+
+
+
As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.
+
In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2048 + 16,384).
+
+
+
+
Bit
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
128
+
+
64
+
+
32
+
+
16
+
+
8
+
+
4
+
+
2
+
+
1
+
+
+
+
Weights
+
+
(27)
+
+
(26)
+
+
(25)
+
+
(24)
+
+
(23)
+
+
(22)
+
+
(21)
+
+
(20)
+
+
+
+
+
+
+
+
Bit
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
32,768
+
+
16,384
+
+
8,192
+
+
4,096
+
+
2,048
+
+
1024
+
+
512
+
+
256
+
+
+
+
Weights
+
+
(215)
+
+
(214)
+
+
(213)
+
+
(212)
+
+
(211)
+
+
(210)
+
+
(29)
+
+
(28)
+
+
+
+
+
+
Example 1
+
+
+
+
enableRegister = status.system4.NODE53 +
+
status.system4.NODE56
+
status.system2.enable = enableRegister
+
+
Sets bit B11 and bit B14 of the system summary 4 enable register using constants.
+
+
+
+
+
Example 2
+
+
+
+
-- decimal 18432 = binary 0100 1000 0000 0000
+
enableRegister = 18432
+
status.system4.enable = enableRegister
+
+
Sets bit B11 and bit B14 of the system summary 4 enable register using a decimal value.
These attributes manage the status model's TSP-Link® system summary register for nodes 57 through 64.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute
+
+
- -
+
+
- -
+
+
- -
+
+
- -
+
+
+
+
.condition (R)
+
+
Yes
+
+
Not applicable
+
+
Not saved
+
+
Not applicable
+
+
+
+
.enable (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.event (R)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.ntr (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
.ptr (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
510 (All bits set)
+
+
+
+
+
Usage
+
enableRegister = status.system5.condition
+
enableRegister = status.system5.enable
+
enableRegister = status.system5.event
+
enableRegister = status.system5.ntr
+
enableRegister = status.system5.ptr
+
status.system5.enable = enableRegister
+
status.system5.ntr = enableRegister
+
status.system5.ptr = enableRegister
+
+
+
+
enableRegister
+
+
The system summary 5 register's status; a zero (0) indicates no bits set; other values indicate various bit settings
+
+
+
+
+
Details
+
In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000 0000 1000 0010. This value indicates that bit B1 and bit B7 are set.
+
+
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
0
+
+
+
+
+
* Least significant bit ** Most significant bit
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
Not used
+
+
Not applicable
+
+
+
+
B1
+
+
status.system5.NODE57
+
+
Bit B1 decimal value: 2
+
+
+
+
B2
+
+
status.system5.NODE58
+
+
Bit B2 decimal value: 4
+
+
+
+
B3
+
+
status.system5.NODE59
+
+
Bit B3 decimal value: 8
+
+
+
+
B4
+
+
status.system5.NODE60
+
+
Bit B4 decimal value: 16
+
+
+
+
B5
+
+
status.system5.NODE61
+
+
Bit B5 decimal value: 32
+
+
+
+
B6
+
+
status.system5.NODE62
+
+
Bit B6 decimal value: 64
+
+
+
+
B7
+
+
status.system5.NODE63
+
+
Bit B7 decimal value: 128
+
+
+
+
B8
+
+
status.system5.NODE64
+
+
Bit B8 decimal value: 256
+
+
+
+
B9-B15
+
+
Not used
+
+
Not applicable
+
+
+
+
+
+
As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.
+
In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).
+
+
+
+
Bit
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
128
+
+
64
+
+
32
+
+
16
+
+
8
+
+
4
+
+
2
+
+
1
+
+
+
+
Weights
+
+
(27)
+
+
(26)
+
+
(25)
+
+
(24)
+
+
(23)
+
+
(22)
+
+
(21)
+
+
(20)
+
+
+
+
+
+
+
+
Bit
+
+
B15
+
+
B14
+
+
B13
+
+
B12
+
+
B11
+
+
B10
+
+
B9
+
+
B8
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
32,768
+
+
16,384
+
+
8,192
+
+
4,096
+
+
2,048
+
+
1024
+
+
512
+
+
256
+
+
+
+
Weights
+
+
(215)
+
+
(214)
+
+
(213)
+
+
(212)
+
+
(211)
+
+
(210)
+
+
(29)
+
+
(28)
+
+
+
+
+
+
Example 1
+
+
+
+
enableRegister = status.system5.NODE57 +
+
status.system5.NODE60
+
status.system2.enable = enableRegister
+
+
Sets bits B1 and B4 of the system summary 5 enable register using constants.
+
+
+
+
+
Example 2
+
+
+
+
-- decimal 18 = binary 0000 0000 0001 0010
+
enableRegister = 18
+
status.system5.enable = enableRegister
+
+
Sets bits B1 and B4 of the system summary 5 enable register using a decimal value.
These steps remove a script from nonvolatile memory. To completely remove a script from the instrument, there are additional steps you must take. See Delete user scripts from the instrument.
+
You can delete the script from nonvolatile memory by sending either of the following commands:
+
script.delete("name")
script.user.delete("name")
Where: name is the user-defined name of the script.
+
To delete a script from nonvolatile memory using TSB Embedded:
+
In TSB Embedded, select the script from the User Scripts list.
Click Delete. There is no confirmation message.
Example: Delete a user script from nonvolatile memory
+
+
+
+
script.delete("test8")
+
+
Delete a user script named test8 from nonvolatile memory.
+
+
+
+
+
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This function restores a script that was removed from the run-time environment.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
script.restore(name)
+
+
+
+
name
+
+
The name of the script to be restored
+
+
+
+
+
Details
+
This command copies the script from nonvolatile memory back into the run-time environment, and it creates a global variable with the same name as the name of the script.
+
Example
+
+
+
+
script.restore("test9")
+
+
Restores a script named "test9" from nonvolatile memory.
This attribute controls the autorun state of a script.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
No
+
+
Not applicable
+
+
See Details
+
+
See Details
+
+
+
+
+
Usage
+
scriptVar.autorun = state
+
state = scriptVar.autorun
+
+
+
+
scriptVar
+
+
The name of the variable that references the script
+
+
+
+
state
+
+
Whether or not the script runs automatically when powered on:
+
"yes" (script runs automatically)
"no" (script does not run automatically)
+
+
+
+
Details
+
Autorun scripts run automatically when the instrument is turned on. You can set any number of scripts to autorun.
+
The run order for autorun scripts is arbitrary, so make sure the run order is not important.
+
The default value for scriptVar.autorun depends on how the script was loaded. The default is "no" if the script was loaded with loadscript or script.new(). It is "yes" for scripts loaded with loadandrunscript or script.newautorun().
+
Make sure to save the script in nonvolatile memory after setting the autorun attribute so that the instrument will retain the setting.
+
Example
+
+
+
+
test5.autorun = "yes"
+
test5.save()
+
+
Assume a script named "test5" is in the run-time environment.
+
The next time the instrument is turned on, "test5" script automatically loads and runs.
+
+
+
+
+
Also see
+
None
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This function returns an iterator that can be used in a for loop to iterate over all the scripts stored in nonvolatile memory.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
for name in script.user.catalog() do body end
+
+
+
+
name
+
+
String representing the name of the script
+
+
+
+
body
+
+
Code that implements the body of the for loop to process the names in the catalog
+
+
+
+
+
Details
+
Accessing the catalog of scripts stored in nonvolatile memory allows you to process all scripts in nonvolatile memory. The entries will be enumerated in no particular order.
+
Each time the body of the function executes, name takes on the name of one of the scripts stored in nonvolatile memory. The for loop repeats until all scripts have been iterated.
+
Example
+
+
+
+
for name in script.user.catalog() do
+
print(name)
+
end
+
+
Retrieve the catalog listing for user scripts.
+
+
+
+
+
Also see
+
None
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This function saves the script to nonvolatile memory or to a USB flash drive.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
scriptVar.save()
+
scriptVar.save(filename)
+
+
+
+
scriptVar
+
+
The name of variable that references the script
+
+
+
+
filename
+
+
The file name to use when saving the script to a USB flash drive
+
+
+
+
+
Details
+
The scriptVar.save() function only saves a script to nonvolatile memory or a USB flash drive.
+
If no filename is given, the script will be saved to internal nonvolatile memory. Only a named script (the script's name attribute is not an empty string) can be saved to internal nonvolatile memory. If a filename is given, the script will be saved to the USB flash drive.
+
You are not required to add the file extension, but if you would like to, the only allowed extension is .tsp (see Example 2).
+
Example 1
+
+
+
+
test8.save()
+
+
Saves the script referenced by the variable test8 to nonvolatile memory.
+
+
+
+
+
Example 2
+
+
+
+
test8.save("/usb1/myScript.tsp")
+
+
Saves the script referenced by the variable test8 to a file named myScript.tsp on your flash drive.
The name of the variable that references the script that contains the source code
+
+
+
+
code
+
+
The body of the script
+
+
+
+
+
Details
+
The loadscript or loadandrunscript and endscript keywords are not included in the source code.
+
The body of the script is a single string with lines separated by the new line character.
+
The instrument automatically keeps the source for all scripts loaded on the instrument. To free up memory or to obfuscate the code, assign nil to the source attribute of the script. Although this attribute is writable, it can only be set to the nil value.
+
Example
+
+
+
+
test7 = script.new("display.clear() display.settext('Hello from my test')", "")
+
print(test7.source)
+
+
+
+
+
The above example creates a script called "test7" that displays a message on the front panel.
+
Retrieve the source code.
+
Output:
+
display.clear() display.settext('Hello from my test')
Keithley Instruments Test Script Processor (TSP®) enabled instruments operate like conventional instruments by responding to a sequence of commands sent by the controller. You can send individual commands to the TSP-enabled instrument the same way you would using any other instrument.
+
Unlike conventional instruments, TSP-enabled instruments can execute automated test sequences independently, without a controller. You can load a series of remote commands into the instrument and store these commands as a script that can be run later by sending a single command message to the instrument. You do not have to choose between using “conventional” control or “script” control. You can combine these forms of instrument control in the way that works best for your particular test application.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2657A/17030.html b/WebHelpDocs/Commands_2657A/17030.html
new file mode 100644
index 0000000..c3dba76
--- /dev/null
+++ b/WebHelpDocs/Commands_2657A/17030.html
@@ -0,0 +1,64 @@
+
+
+ Retrieve source code one line at a time
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Retrieve source code one line at a time
+
To retrieve the source code one line at a time, send the scriptVar.list() command. When this command is received, the instrument sends the entire script. Each line of the script is sent as a separate response message. The output includes the loadscript or loadandrunscript and endscript keywords.
+
After retrieving the source code, you can modify and save the command lines as a user script under the same name or a new name.
+
To retrieve the source code of a script one line at a time, send the command:
+
scriptVar.list()
+
Where scriptVar is the name of the script.
+
To retrieve the commands in the anonymous script, use script.anonymous.list().
+
Example: Retrieve source code one line at a time
+
+
+
+
test.list()
+
+
Retrieve the source of a script named "test".
+
The output will look similar to:
+
loadscript
+
display.clear()
+
display.settext("This is a test")
+
print("This is a test")
+
endscript
+
+
+
+
+
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This function retrieves the key code for the last pressed key.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
keyCode = display.getlastkey()
+
+
+
+
keyCode
+
+
A returned value that represents the last front-panel key pressed; see Details for more information
+
+
+
+
+
Details
+
A history of the key code for the last pressed front‑panel key is maintained by the instrument. When the instrument is turned on, or when it is transitioning from local to remote operation, the key code is set to 0 (display.KEY_NONE).
+
Pressing the EXIT (LOCAL) key normally aborts a script. To use this function with the EXIT (LOCAL) key, display.locallockout must be used.
+
The table below lists the keyCode value for each front‑panel action.
+
+
+
+
+
+
+
+
+
+
+
Key codes
+
+
+
+
Value
+
+
Key list
+
+
+
+
Value
+
+
Key list
+
+
+
+
0
+
+
display.KEY_NONE
+
+
+
+
82
+
+
display.KEY_ENTER
+
+
+
+
65
+
+
display.KEY_RANGEUP
+
+
+
+
85
+
+
display.KEY_RECALL
+
+
+
+
68
+
+
display.KEY_MENU
+
+
+
+
86
+
+
display.KEY_MEASA
+
+
+
+
69
+
+
display.KEY_MODEA
+
+
+
+
87
+
+
display.KEY_DIGITSA
+
+
+
+
70
+
+
display.KEY_RELA
+
+
+
+
92
+
+
display.KEY_TRIG
+
+
+
+
71
+
+
display.KEY_RUN
+
+
+
+
93
+
+
display.KEY_LIMITA
+
+
+
+
72
+
+
display.KEY_DISPLAY
+
+
+
+
94
+
+
display.KEY_SPEEDA
+
+
+
+
73
+
+
display.KEY_AUTO
+
+
+
+
95
+
+
display.KEY_LOAD
+
+
+
+
75
+
+
display.KEY_EXIT
+
+
+
+
97
+
+
display.WHEEL_ENTER
+
+
+
+
77
+
+
display.KEY_FILTERA
+
+
+
+
103
+
+
display.KEY_RIGHT
+
+
+
+
78
+
+
display.KEY_STORE
+
+
+
+
104
+
+
display.KEY_LEFT
+
+
+
+
79
+
+
display.KEY_SRCA
+
+
+
+
107
+
+
display.WHEEL_LEFT
+
+
+
+
80
+
+
display.KEY_CONFIG
+
+
+
+
114
+
+
display.WHEEL_RIGHT
+
+
+
+
81
+
+
display.KEY_RANGEDOWN
+
+
+
+
+
+
+
+
+
+
+
+
When using this function, use built-in constants such as display.KEY_RIGHT (rather than the numeric value of 103). This will allow for better forward compatibility with firmware revisions.
+
The OUTPUT ON/OFF control cannot be tracked by this function.
+
Example
+
+
+
+
key = display.getlastkey()
+
print(key)
+
+
On the front panel, press the MENU key and then send the code to the left. This retrieves the key code for the last pressed key.
This function sends a code that simulates the action of a front panel control.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
display.sendkey(keyCode)
+
+
+
+
keyCode
+
+
A parameter that specifies the key to virtually press; see Details for more information
+
+
+
+
+
Details
+
This command simulates the pressing of a front panel key or navigation wheel, or the turning the navigation wheel one click to the left or right.
+
+
+
+
+
+
+
+
+
+
Key codes
+
+
+
+
Value
+
+
Key list
+
+
+
+
Value
+
+
Key list
+
+
+
+
0
+
+
display.KEY_NONE
+
+
+
+
82
+
+
display.KEY_ENTER
+
+
+
+
65
+
+
display.KEY_RANGEUP
+
+
+
+
85
+
+
display.KEY_RECALL
+
+
+
+
68
+
+
display.KEY_MENU
+
+
+
+
86
+
+
display.KEY_MEASA
+
+
+
+
69
+
+
display.KEY_MODEA
+
+
+
+
87
+
+
display.KEY_DIGITSA
+
+
+
+
70
+
+
display.KEY_RELA
+
+
+
+
88
+
+
display.KEY_OUTPUTA
+
+
+
+
71
+
+
display.KEY_RUN
+
+
+
+
92
+
+
display.KEY_TRIG
+
+
+
+
72
+
+
display.KEY_DISPLAY
+
+
+
+
93
+
+
display.KEY_LIMITA
+
+
+
+
73
+
+
display.KEY_AUTO
+
+
+
+
94
+
+
display.KEY_SPEEDA
+
+
+
+
75
+
+
display.KEY_EXIT
+
+
+
+
95
+
+
display.KEY_LOAD
+
+
+
+
77
+
+
display.KEY_FILTERA
+
+
+
+
97
+
+
display.WHEEL_ENTER
+
+
+
+
78
+
+
display.KEY_STORE
+
+
+
+
103
+
+
display.KEY_RIGHT
+
+
+
+
79
+
+
display.KEY_SRCA
+
+
+
+
104
+
+
display.KEY_LEFT
+
+
+
+
80
+
+
display.KEY_CONFIG
+
+
+
+
107
+
+
display.WHEEL_LEFT
+
+
+
+
81
+
+
display.KEY_RANGEDOWN
+
+
+
+
114
+
+
display.WHEEL_RIGHT
+
+
+
+
+
+
When using this function, use built-in constants such as display.KEY_RIGHT (rather than the numeric value of 103). This will allow for better forward compatibility with firmware revisions.
+
Example
+
+
+
+
display.sendkey(display.KEY_RUN)
+
+
Simulates pressing the RUN key.
+
+
+
+
+
Also see
+
Front panel
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This attribute enables or disables the reading buffer cache (on or off).
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Not applicable
+
+
Not saved
+
+
1 (enabled)
+
+
+
+
+
Usage
+
cacheMode = bufferVar.cachemode
+
bufferVar.cachemode = cacheMode
+
+
+
+
cacheMode
+
+
The reading buffer cache mode; set to one of the following:
+
0: Cache mode disabled (off)
1: Cache mode enabled (on)
+
+
+
bufferVar
+
+
The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer
+
+
+
+
+
Details
+
Assigning a value to this attribute enables or disables the reading buffer cache. When enabled, the reading buffer cache improves access speed to reading buffer data.
+
If you run successive operations that overwrite reading buffer data, the reading buffer may return stale cache data. This can happen when initiating successive sweeps without reconfiguring the sweep measurements or when overwriting data in the reading buffer by setting the bufferVar.fillmode attribute to smuX.FILL_WINDOW. To avoid this, make sure that you include commands that automatically invalidate the cache as needed (for example, explicit calls to the bufferVar.clearcache() function) or disable the cache using this attribute (bufferVar.cachemode).
+
Example
+
+
+
+
smua.nvbuffer1.cachemode = 1
+
+
Enables reading buffer cache of dedicated reading buffer 1.
The compliance limit value; set to one of the following values: Voltage compliance: 0 V to 3030 V
+
Current compliance: 0 A to 121.2 mA
+
Set power compliance in watts: 0 W (minumum). Specifying a 0 disables power limit
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)
+
+
+
+
Y
+
+
SMU function (v = voltage, i = current, p = power)
+
+
+
+
+
Details
+
Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU will always choose (autorange) the source range for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.
+
This attribute should be set in the test sequence before the turning the source on.
+
Using a limit value of 0 will result in an error code 1102, "Parameter too small," for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU will adjust the source limit where appropriate to limit the output to the specified power. The SMU will use the lower of the programmed compliance value (the compliance level that would be used if power compliance were disabled) or the limit calculated from the power compliance setting.
+
Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.
+
Example
+
+
+
+
smua.source.limitv = 30
+
+
Sets voltage source compliance of SMU channel A to 30 V.
The severity level (0, 10, 20, 30, or 40); see Details for more information
+
+
+
+
errorNode
+
+
The node number where the error originated
+
+
+
+
+
Details
+
Entries are stored in a first-in, first-out (FIFO) queue. This functions reads the oldest entry and removes it from the queue.
+
Error codes and messages are listed in the Error summary list.
+
If there are no entries in the queue, code 0, "Queue is Empty" is returned.
+
Returned severity levels are described in the following table.
+
+
+
+
+
+
+
+
+
Severity level descriptions
+
+
+
+
Number
+
+
Level
+
+
Description
+
+
+
+
0
+
+
Informational
+
+
Indicates that there are no entries in the queue.
+
+
+
+
10
+
+
Informational
+
+
Indicates a status message or minor error.
+
+
+
+
20
+
+
Recoverable
+
+
Indicates possible invalid user input; operation continues but action should be taken to correct the error.
+
+
+
+
30
+
+
Serious
+
+
Indicates a serious error that may require technical assistance, such as corrupted data.
+
+
+
+
40
+
+
Fatal
+
+
Indicates that the Model 2657A is nonoperational and requires service. Contact information for service is provided at the front of this manual. Examples: “Bad SMU AFPGA image size,” “SMU is unresponsive,” and “Communication Timeout with DFPGA.”
+
+
+
+
+
In an expanded system, each TSP‑Link enabled instrument is assigned a node number.The variable errorNode stores the node number where the error originated.
+
Example
+
+
+
+
errorcode, message = errorqueue.next()
+
print(errorcode, message)
+
+
Reads the oldest entry in the error queue. The output below indicates that the queue is empty.
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2657A/17268.html b/WebHelpDocs/Commands_2657A/17268.html
new file mode 100644
index 0000000..80c8ee8
--- /dev/null
+++ b/WebHelpDocs/Commands_2657A/17268.html
@@ -0,0 +1,42 @@
+
+
+ Controlling the instrument by sending individual command messages
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Controlling the instrument by sending individual command messages
+
The simplest method of controlling an instrument through the communication interface is to send it a message that contains remote commands. You can use a test program that resides on a computer (the controller) to sequence the actions of the instrument.
+
Remote commands can be function-based or attribute-based. Function-based commands are commands that control actions or activities. Attribute-based commands define characteristics of an instrument feature or operation.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This attribute stores the service request (SRQ) enable register.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Status reset
+
+
Not saved
+
+
0
+
+
+
+
+
Usage
+
requestSRQEnableRegister = status.request_enable
+
status.request_enable = requestSRQEnableRegister
+
+
+
+
requestSRQEnableRegister
+
+
The service request (SRQ) enable register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings
+
+
+
+
+
Details
+
This attribute is used to read or write to the service request enable register. Reading the service request enable register returns a value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000 0001. This value indicates that bit B0 and bit B7 are set.
+
+
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
+
+
+
* Least significant bit ** Most significant bit
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
status.MEASUREMENT_SUMMARY_BIT
+
status.MSB
+
+
Set summary bit indicates that an enabled event in the Measurement Event Register has occurred.
+
Bit B0 decimal value: 1
+
+
+
+
B1
+
+
status.SYSTEM_SUMMARY_BIT
+
status.SSB
+
+
Set summary bit indicates that an enabled event in the System Summary Register has occurred.
+
Bit B1 decimal value: 2
+
+
+
+
B2
+
+
status.ERROR_AVAILABLE
+
status.EAV
+
+
Set summary bit indicates that an error or status message is present in the Error Queue.
+
Bit B2 decimal value: 4
+
+
+
+
B3
+
+
status.QUESTIONABLE_SUMMARY_BIT
+
status.QSB
+
+
Set summary bit indicates that an enabled event in the Questionable Status Register has occurred.
+
Bit B3 decimal value: 8
+
+
+
+
B4
+
+
status.MESSAGE_AVAILABLE
+
status.MAV
+
+
Set summary bit indicates that a response message is present in the Output Queue.
+
Bit B4 decimal value: 16
+
+
+
+
B5
+
+
status.EVENT_SUMMARY_BIT
+
status.ESB
+
+
Set summary bit indicates that an enabled event in the Standard Event Status Register has occurred.
+
Bit B5 decimal value: 32
+
+
+
+
B6
+
+
Not used
+
+
Not applicable
+
+
+
+
B7
+
+
status.OPERATION_SUMMARY_BIT
+
status.OSB
+
+
Set summary bit indicates that an enabled event in the Operation Status Register has occurred.
+
Bit B7 decimal value: 128
+
+
+
+
+
+
As an example, to set bit B0 of the service request enable register, set status.request_enable = status.MSB.
+
In addition to the above values, requestSRQEnableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set requestSRQEnableRegister to the sum of their decimal weights. For example, to set bits B0 and B7, set requestSRQEnableRegister to 129 (1 + 128).
This attribute stores the service request (SRQ) event register.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Not applicable
+
+
Not saved
+
+
0
+
+
+
+
+
Usage
+
requestSRQEventRegister = status.request_event
+
+
+
+
requestSRQEventRegister
+
+
The request event register's status; a zero (0) indicates no bits set; other values indicate various bit settings
+
+
+
+
+
Details
+
This attribute is used to read the service request event register, which is returned as a numeric value. Reading this register returns a value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000 0001. This value indicates that bit B0 and bit B7 are set.
+
+
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
**
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
>
+
+
*
+
+
+
+
1
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
0
+
+
1
+
+
+
+
+
* Least significant bit ** Most significant bit
+
The returned value can indicate one or more status events occurred.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
status.MEASUREMENT_SUMMARY_BIT
+
status.MSB
+
+
Set summary bit indicates that an enabled event in the Measurement Event Register has occurred.
+
Bit B0 decimal value: 1
+
+
+
+
B1
+
+
status.SYSTEM_SUMMARY_BIT
+
status.SSB
+
+
Set summary bit indicates that an enabled event in the System Summary Register has occurred.
+
Bit B1 decimal value: 2
+
+
+
+
B2
+
+
status.ERROR_AVAILABLE
+
status.EAV
+
+
Set summary bit indicates that an error or status message is present in the Error Queue.
+
Bit B2 decimal value: 4
+
+
+
+
B3
+
+
status.QUESTIONABLE_SUMMARY_BIT
+
status.QSB
+
+
Set summary bit indicates that an enabled event in the Questionable Status Register has occurred.
+
Bit B3 decimal value: 8
+
+
+
+
B4
+
+
status.MESSAGE_AVAILABLE
+
status.MAV
+
+
Set summary bit indicates that a response message is present in the Output Queue.
+
Bit B4 decimal value: 16
+
+
+
+
B5
+
+
status.EVENT_SUMMARY_BIT
+
status.ESB
+
+
Set summary bit indicates that an enabled event in the Standard Event Status Register has occurred.
+
Bit B5 decimal value: 32
+
+
+
+
B6
+
+
Not used
+
+
Not applicable
+
+
+
+
B7
+
+
status.OPERATION_SUMMARY_BIT
+
status.OSB
+
+
Set summary bit indicates that an enabled event in the Operation Status Register has occurred.
+
Bit B7 decimal value: 128
+
+
+
+
+
+
In addition to the above constants, requestEventRegister can be set to the decimal equivalent of the bit(s) set. When more than one bit of the register is set, requestEventRegister contains the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).
+
+
+
+
Bit
+
+
B7
+
+
B6
+
+
B5
+
+
B4
+
+
B3
+
+
B2
+
+
B1
+
+
B0
+
+
+
+
Binary value
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
0/1
+
+
+
+
Decimal
+
+
128
+
+
64
+
+
32
+
+
16
+
+
8
+
+
4
+
+
2
+
+
1
+
+
+
+
Weights
+
+
(27)
+
+
(26)
+
+
(25)
+
+
(24)
+
+
(23)
+
+
(22)
+
+
(21)
+
+
(20)
+
+
+
+
+
Example
+
+
+
+
requestEventRegister = status.request_event
+
print(requestEventRegister)
+
+
Reads the status request event register.
+
Sample output: 1.29000e+02
+
Converting this output (129) to its binary equivalent yields: 1000 0001
+
Therefore, this output indicates that the set bits of the status request event register are presently B0 (MSB) and B7 (OSB).
This attribute contains the write‑protect mask that protects bits from changes by the tsplink.writebit() and tsplink.writeport() functions.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset Recall setup
+
+
Saved setup
+
+
0
+
+
+
+
+
Usage
+
mask = tsplink.writeprotect
+
tsplink.writeprotect = mask
+
+
+
+
mask
+
+
An integer that specifies the value of the bit pattern for write‑protect; set bits to 1 to write‑protect the corresponding TSP-Link trigger line
+
+
+
+
+
Details
+
The binary equivalent of mask indicates the mask to be set for the TSP-Link trigger line. For example, a mask value of 5 has a binary equivalent of 101. This mask write‑protects TSP-Link trigger lines 1 and 3.
TSP-enabled instruments do not have inherent query commands. Like any other scripting environment, the print() command and other related print() commands generate output. The print() command creates one response message.
+
The output from multiple arguments are separated with a tab character.
+
Numbers are printed using the format.asciiprecision attribute. If you want use Lua formatting, print the return value from the tostring() function.
+
Example 1
+
+
+
+
x = 10
+
print(x)
+
+
Example of an output response message:
+
1.00000e+01
+
Note that your output might be different if you set your ASCII precision setting to a different value.
This attribute specifies events that cause this trigger to assert.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset LAN trigger N reset Recall setup
+
+
Not saved
+
+
0
+
+
+
+
+
Usage
+
triggerStimulus = lan.trigger[N].stimulus
+
lan.trigger[N].stimulus = triggerStimulus
+
+
+
+
triggerStimulus
+
+
The LAN event identifier used to trigger the event.
+
+
+
+
N
+
+
A number specifying the trigger packet over the LAN for which to set or query the trigger source (1 to 8).
+
+
+
+
+
Details
+
This attribute specifies which event causes a LAN trigger packet to be sent for this trigger. Set triggerStimulus to one of the existing trigger event IDs shown in the following table.
+
+
+
+
+
+
+
Trigger event IDs*
+
+
+
+
Event ID
+
+
Event description
+
+
+
+
smua.trigger.SWEEPING_EVENT_ID
+
+
Occurs when the source‑measure unit (SMU) transitions from the idle state to the arm layer of the trigger model
+
+
+
+
smua.trigger.ARMED_EVENT_ID
+
+
Occurs when the SMU moves from the arm layer to the trigger layer of the trigger model
+
+
+
+
smua.trigger.SOURCE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a source action
+
+
+
+
smua.trigger.MEASURE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a measure action
+
+
+
+
smua.trigger.PULSE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a pulse
+
+
+
+
smua.trigger.SWEEP_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a sweep
+
+
+
+
smua.trigger.IDLE_EVENT_ID
+
+
Occurs when the SMU returns to the idle state
+
+
+
+
digio.trigger[N].EVENT_ID
+
+
Occurs when an edge is detected on a digital I/O line
+
+
+
+
tsplink.trigger[N].EVENT_ID
+
+
Occurs when an edge is detected on a TSP‑Link line
+
+
+
+
lan.trigger[N].EVENT_ID
+
+
Occurs when the appropriate LXI trigger packet is received on LAN trigger object N
+
+
+
+
display.trigger.EVENT_ID
+
+
Occurs when the TRIG key on the front panel is pressed
+
+
+
+
trigger.EVENT_ID
+
+
Occurs when a *TRG command is received on the remote interface
+
GPIB only: Occurs when a GET bus command is received
+
VXI-11 only: Occurs with the VXI-11 command device_trigger; reference the VXI-11 standard for additional details on the device trigger operation
+
+
+
+
trigger.blender[N].EVENT_ID
+
+
Occurs after a collection of events is detected
+
+
+
+
trigger.timer[N].EVENT_ID
+
+
Occurs when a delay expires
+
+
+
+
* Use the name of the trigger event ID to set the stimulus value rather than the numeric value. Using the name makes the code compatible for future upgrades (for example, if the numeric values must change when enhancements are added to the instrument).
+
+
+
+
+
Setting this attribute to zero disables automatic trigger generation.
+
If any events are detected prior to calling lan.trigger[N].connect(), the event is ignored and the action overrun is set.
This attribute specifies the event that causes the synchronization line to assert a trigger.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset Recall setup TSP-Link trigger N reset
+
+
Not saved
+
+
0
+
+
+
+
+
Usage
+
eventID = tsplink.trigger[N].stimulus
+
tsplink.trigger[N].stimulus = eventID
+
+
+
+
eventID
+
+
The event identifier for the triggering event
+
+
+
+
N
+
+
The trigger line (1 to 3)
+
+
+
+
+
Details
+
To disable automatic trigger assertion on the synchronization line, set this attribute to zero (0).
+
Do not use this attribute when triggering under script control. Use tsplink.trigger[N].assert() instead.
+
The eventIDparameter may be one of the existing trigger event IDs shown in the following table.
+
+
+
+
+
+
+
Trigger event IDs*
+
+
+
+
Event ID
+
+
Event description
+
+
+
+
smua.trigger.SWEEPING_EVENT_ID
+
+
Occurs when the source‑measure unit (SMU) transitions from the idle state to the arm layer of the trigger model
+
+
+
+
smua.trigger.ARMED_EVENT_ID
+
+
Occurs when the SMU moves from the arm layer to the trigger layer of the trigger model
+
+
+
+
smua.trigger.SOURCE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a source action
+
+
+
+
smua.trigger.MEASURE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a measure action
+
+
+
+
smua.trigger.PULSE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a pulse
+
+
+
+
smua.trigger.SWEEP_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a sweep
+
+
+
+
smua.trigger.IDLE_EVENT_ID
+
+
Occurs when the SMU returns to the idle state
+
+
+
+
digio.trigger[N].EVENT_ID
+
+
Occurs when an edge is detected on a digital I/O line
+
+
+
+
tsplink.trigger[N].EVENT_ID
+
+
Occurs when an edge is detected on a TSP‑Link line
+
+
+
+
lan.trigger[N].EVENT_ID
+
+
Occurs when the appropriate LXI trigger packet is received on LAN trigger object N
+
+
+
+
display.trigger.EVENT_ID
+
+
Occurs when the TRIG key on the front panel is pressed
+
+
+
+
trigger.EVENT_ID
+
+
Occurs when a *TRG command is received on the remote interface
+
GPIB only: Occurs when a GET bus command is received
+
VXI-11 only: Occurs with the VXI-11 command device_trigger; reference the VXI-11 standard for additional details on the device trigger operation
+
+
+
+
trigger.blender[N].EVENT_ID
+
+
Occurs after a collection of events is detected
+
+
+
+
trigger.timer[N].EVENT_ID
+
+
Occurs when a delay expires
+
+
+
+
* Use the name of the trigger event ID to set the stimulus value rather than the numeric value. Using the name makes the code compatible for future upgrades (for example, if the numeric values must change when enhancements are added to the instrument).
+
+
+
+
+
Example
+
+
+
+
print(tsplink.trigger[3].stimulus)
+
+
Prints the event that will start TSP-Link trigger line 3 action.
This attribute specifies which events trigger the blender.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset Recall setup Trigger blender N reset
+
+
Not saved
+
+
0
+
+
+
+
+
Usage
+
eventID = trigger.blender[N].stimulus[M]
+
trigger.blender[N].stimulus[M] = eventID
+
+
+
+
eventID
+
+
The event that triggers the blender action; see Details
+
+
+
+
N
+
+
An integer representing the trigger event blender (1 to 4)
+
+
+
+
M
+
+
An integer representing the stimulus index (1 to 4)
+
+
+
+
+
Details
+
There are four acceptors that can each select a different event. The eventID parameter can be the event ID of any trigger event.
+
Use zero to disable the blender input.
+
The eventID parameter may be one of the existing trigger event IDs shown in the following table.
+
+
+
+
+
+
+
Trigger event IDs*
+
+
+
+
Event ID
+
+
Event description
+
+
+
+
smua.trigger.SWEEPING_EVENT_ID
+
+
Occurs when the source‑measure unit (SMU) transitions from the idle state to the arm layer of the trigger model
+
+
+
+
smua.trigger.ARMED_EVENT_ID
+
+
Occurs when the SMU moves from the arm layer to the trigger layer of the trigger model
+
+
+
+
smua.trigger.SOURCE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a source action
+
+
+
+
smua.trigger.MEASURE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a measure action
+
+
+
+
smua.trigger.PULSE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a pulse
+
+
+
+
smua.trigger.SWEEP_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a sweep
+
+
+
+
smua.trigger.IDLE_EVENT_ID
+
+
Occurs when the SMU returns to the idle state
+
+
+
+
digio.trigger[N].EVENT_ID
+
+
Occurs when an edge is detected on a digital I/O line
+
+
+
+
tsplink.trigger[N].EVENT_ID
+
+
Occurs when an edge is detected on a TSP‑Link line
+
+
+
+
lan.trigger[N].EVENT_ID
+
+
Occurs when the appropriate LXI trigger packet is received on LAN trigger object N
+
+
+
+
display.trigger.EVENT_ID
+
+
Occurs when the TRIG key on the front panel is pressed
+
+
+
+
trigger.EVENT_ID
+
+
Occurs when a *TRG command is received on the remote interface
+
GPIB only: Occurs when a GET bus command is received
+
VXI-11 only: Occurs with the VXI-11 command device_trigger; reference the VXI-11 standard for additional details on the device trigger operation
+
+
+
+
trigger.blender[N].EVENT_ID
+
+
Occurs after a collection of events is detected
+
+
+
+
trigger.timer[N].EVENT_ID
+
+
Occurs when a delay expires
+
+
+
+
* Use the name of the trigger event ID to set the stimulus value rather than the numeric value. Using the name makes the code compatible for future upgrades (for example, if the numeric values must change when enhancements are added to the instrument).
This attribute specifies which event starts the timer.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset Recall setup Trigger timer N reset
+
+
Not saved
+
+
0
+
+
+
+
+
Usage
+
eventID = trigger.timer[N].stimulus
+
trigger.timer[N].stimulus = eventID
+
+
+
+
eventID
+
+
The event that triggers the timer delay
+
+
+
+
N
+
+
Trigger timer number (1 to 4)
+
+
+
+
+
Details
+
The eventIDparameter may be one of the trigger event IDs shown in the following table.
+
+
+
+
+
+
+
Trigger event IDs*
+
+
+
+
Event ID
+
+
Event description
+
+
+
+
smua.trigger.SWEEPING_EVENT_ID
+
+
Occurs when the source‑measure unit (SMU) transitions from the idle state to the arm layer of the trigger model
+
+
+
+
smua.trigger.ARMED_EVENT_ID
+
+
Occurs when the SMU moves from the arm layer to the trigger layer of the trigger model
+
+
+
+
smua.trigger.SOURCE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a source action
+
+
+
+
smua.trigger.MEASURE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a measure action
+
+
+
+
smua.trigger.PULSE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a pulse
+
+
+
+
smua.trigger.SWEEP_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a sweep
+
+
+
+
smua.trigger.IDLE_EVENT_ID
+
+
Occurs when the SMU returns to the idle state
+
+
+
+
digio.trigger[N].EVENT_ID
+
+
Occurs when an edge is detected on a digital I/O line
+
+
+
+
tsplink.trigger[N].EVENT_ID
+
+
Occurs when an edge is detected on a TSP‑Link line
+
+
+
+
lan.trigger[N].EVENT_ID
+
+
Occurs when the appropriate LXI trigger packet is received on LAN trigger object N
+
+
+
+
display.trigger.EVENT_ID
+
+
Occurs when the TRIG key on the front panel is pressed
+
+
+
+
trigger.EVENT_ID
+
+
Occurs when a *TRG command is received on the remote interface
+
GPIB only: Occurs when a GET bus command is received
+
VXI-11 only: Occurs with the VXI-11 command device_trigger; reference the VXI-11 standard for additional details on the device trigger operation
+
+
+
+
trigger.blender[N].EVENT_ID
+
+
Occurs after a collection of events is detected
+
+
+
+
trigger.timer[N].EVENT_ID
+
+
Occurs when a delay expires
+
+
+
+
* Use the name of the trigger event ID to set the stimulus value rather than the numeric value. Using the name makes the code compatible for future upgrades (for example, if the numeric values must change when enhancements are added to the instrument).
+
+
+
+
+
Set this attribute to the eventID of any trigger event to cause the timer to start when that event occurs.
+
Set this attribute equal to zero (0) to disable event processing.
+
Example
+
+
+
+
print(trigger.timer[1].stimulus)
+
+
Prints the event that will start a trigger 1 timer action.
This function generates output in the form of a sequence of response messages (one message for each line of the script). It also generates output of the script control messages (loadscript or loadandrunscript, and endscript).
+
Example
+
+
+
+
test7 = script.new("display.clear() display.settext('Hello from my test')", "test7")
+
test7()
+
test7.save()
+
test7.list()
+
+
+
+
+
The above example code creates a script named "test7" that displays text on the front panel, lists the script with the following output:
+
loadscript test7
+
display.clear() display.settext("Hello from my test")
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2657A/17789.html b/WebHelpDocs/Commands_2657A/17789.html
new file mode 100644
index 0000000..a905516
--- /dev/null
+++ b/WebHelpDocs/Commands_2657A/17789.html
@@ -0,0 +1,42 @@
+
+
+ Information on scripting and programming
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Information on scripting and programming
+
If you need information about using scripts with Model 2657A, see Fundamentals of scripting for TSP.
+
If you need information about using the Lua programming language with Model 2657A, see Fundamentals of programming for TSP.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2657A/17852.html b/WebHelpDocs/Commands_2657A/17852.html
new file mode 100644
index 0000000..9ca40ff
--- /dev/null
+++ b/WebHelpDocs/Commands_2657A/17852.html
@@ -0,0 +1,44 @@
+
+
+ Using the command reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Using the command reference
+
The command reference contains detailed descriptions of each of the commands you can use to control your Model 2657A. Each command description is broken into several standardized subsections. The figure below shows an example of a command description.
+
+
Each command listing is divided into five major categories of information about the command:
+
Command name and summary table
Usage
Details
Example
Also see
The content of each of these categories is described in the following topics.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2657A/17853.html b/WebHelpDocs/Commands_2657A/17853.html
new file mode 100644
index 0000000..a0ef0d6
--- /dev/null
+++ b/WebHelpDocs/Commands_2657A/17853.html
@@ -0,0 +1,43 @@
+
+
+ Command name and summary table
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Command name and summary table
+
Each instrument command description starts with the command name, followed by a table with relevant information for each command. Definitions for the numbered items in the figure below are listed following the figure.
+
+
Instrument command name. Signals the beginning of the command description and is followed by a brief description of what the command does.
Type of command. Options are:
Function. Function-based commands control actions or activities, but are not always directly related to instrument operation. Function names are always followed by a set of parentheses, for example, digio.writeport(15). If the function does not need a parameter, the parentheses set remains empty, for example, exit().
Attribute (R),(RW), or (W). Attribute-based commands set or read the characteristics of an instrument feature or operation by defining a value. For example, a characteristic of a TSP‑enabled instrument is the model number (localnode.model); another characteristic is the number of errors in the error queue (errorqueue.count). For many attributes, the defined value is a number or predefined constant. Attributes can be read-only (R), read-write (RW), or write-only (W), and can be used as a parameter of a function or assigned to another variable.
Constant. A constant command represents a fixed value when used in a script.
TSP-Link accessible. Yes or No; indicates whether or not the command can accessed through a TSP-Link network.
Affected by. Commands or actions that have a direct effect on the instrument command.
LAN restore defaults
Recall setup
Instrument reset: An instrument reset can be invoked by reset(), localnode.reset(), or *RST.
Where saved. Indicates where the command settings reside once they are used on an instrument. Options include:
Not saved: Command is not saved anywhere and must be typed each time you use it.
Nonvolatile memory: Storage area in the instrument where information is saved when the instrument is turned off.
Saved setup
Default value: Lists the default value or constant for the command. The parameter values are defined in the Usage or Details sections of the command description.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
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: 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.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This manual uses italicized text to represent the parts of remote commands that must be replaced by user specified values. The following examples show typical uses of italicized text:
+
Example 1:
+
gpib.address = address
+
Where:
+
address is an integer (0 to 30) that you specify. For example, to set this attribute to 15 you would send:
+
gpib.address = 15
+
Example 2:
+
digio.trigger[N].assert()
+
Where:
+
N is an integer (1 to 14) that you specify. For example, to assert trigger line 7 you would send:
+
digio.trigger[7].assert()
+
To assert a trigger line with a variable as the integer, you would send:
+
triggerline = 7
+
digio.trigger[triggerline].assert()
+
Example 3:
+
smuX.trigger.measure.Y(rbuffer)
+
Where:
+
X refers to the source‑measure unit (SMU) channel (use a for SMU A).
+
Y is the measurement type that you specify (v, i, r, or p).
+
rbuffer is the reading buffer object where the readings will be stored.
+
For example, to use SMU A to take voltage measurements and store them in buffer vbuffername, you would send:
+
smua.trigger.measure.v(vbuffername)
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
The following table lists syntax requirements to build well-formed instrument control commands.
+
+
+
+
+
+
+
+
Syntax rules for instrument commands
+
+
+
+
Syntax rule
+
+
Details
+
+
Examples
+
+
+
+
Case sensitivity: Instrument commands are case sensitive.
+
+
For best results, simply match the case shown in the command reference descriptions.
+
+
+
Function and attribute names should be in lowercase characters.
+
+
An example of the scriptVar.save() function (where test8 is the name of the script):
+
test8.save()
+
+
+
+
Parameters can use a combination of lowercase and uppercase characters.
+
+
Attribute constants use uppercase characters
+
+
+
In the command below, which sets the format of data transmitted from the instrument to double‑precision floating point, format.REAL64 is the attribute constant and format.data is the attribute command:
+
format.data = format.REAL64
+
+
+
+
White space: Not required in a function.
+
+
Functions can be sent with or without white spaces.
+
+
The following functions, which set digital I/O line 3 low, are equivalent:
+
digio.writebit(3,0)
+
digio.writebit (3, 0)
+
+
+
+
Function parameters: All functions are required to have a set of parentheses () immediately following the function.
+
+
You can specify the function parameters by placing them between the parentheses. Note that the parentheses are required even when there are no parameters specified.
+
+
The following function specifies all overlapped commands in the nodes in group G must complete before commands from other groups can execute:
+
waitcomplete(G)
+
+
The command below reads the value of the local time zone (no parameters are needed):
+
timezone = localnode.gettimezone()
+
+
+
+
Multiple parameters: Must be separated by commas (,).
+
+
Some commands require multiple parameters, which must be separated by commas (,).
+
+
This command sets the beeper to emit a double‑beep at 2400 Hz, with a beep sequence of 0.5 seconds on, 0.25 seconds off, and then 0.5 seconds on:
+
beeper.beep(0.5, 2400)
+
delay(0.250)
+
beeper.beep(0.5, 2400)
+
+
+
+
+
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This attribute sets the reading buffer fill count.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Not applicable
+
+
See Details
+
+
0
+
+
+
+
+
Usage
+
fillCount = bufferVar.fillcount
+
bufferVar.fillcount = fillCount
+
+
+
+
fillCount
+
+
The reading buffer fill count
+
+
+
+
bufferVar
+
+
The reading buffer; can be a dynamically allocated buffer (user‑defined), or a dedicated reading buffer (such as smua.nvbuffer1)
+
+
+
+
+
Details
+
The reading buffer fill count sets the number of readings to store before restarting at index 1. If the value is zero (0), then the capacity of the buffer is used. Use this attribute to control when the SMU restarts filling the buffer at index 1, rather than having it restart when the buffer is full.
+
If the bufferVar.fillcount attribute is set to a value higher than the capacity of the buffer, after storing the element at the end of the buffer, the SMU will overwrite the reading at index 1, the reading after that will overwrite the reading at index 2, and so on.
+
This attribute is only used when the bufferVar.fillmode attribute is set to smuX.FILL_WINDOW.
+
For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.
+
Example
+
+
+
+
smua.nvbuffer1.fillcount = 50
+
+
Sets fill count of dedicated reading buffer 1 to 50.
The reading buffer fill mode; set to one of the following:
+
0 or smuX.FILL_ONCE: Do not overwrite old data
1 or smuX.FILL_WINDOW: New readings restart at index 1 after acquiring reading at index bufferVar.fillcount
+
+
+
bufferVar
+
+
The reading buffer; can be a dynamically allocated buffer (user‑defined), or a dedicated reading buffer (such as smua.nvbuffer1)
+
+
+
+
+
Details
+
When this attribute is set to smuX.FILL_ONCE, the reading buffer will not overwrite readings. If the buffer fills up, new readings will be discarded.
+
When this attribute is set to smuX.FILL_WINDOW, new readings will be added after existing data until the buffer holds bufferVar.fillcount elements. Continuing the sequence, the next reading will overwrite the reading at index 1, the reading after that will overwrite the reading at index 2, and so on.
+
For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.
+
Example
+
+
+
+
smua.nvbuffer1.fillmode = smua.FILL_ONCE
+
+
Sets fill mode of dedicated reading buffer 1 to fill once (do not overwrite old data).
This function returns a specified reading buffer's statistics.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
statistics = smuX.buffer.getstats(bufferVar)
+
+
+
+
statistics
+
+
The reading buffer's statistics
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.buffer.getstats() specifies SMU channel A)
+
+
+
+
bufferVar
+
+
The reading buffer to process
+
+
+
+
+
Details
+
This function returns a table with statistical data about the data placed in the buffer.
+
The SMU will automatically update reading buffer statistics as data is added to the reading buffer. When the reading buffer is configured to wrap around and overwrite older data with new data, the buffer statistics will include the data that was overwritten.
+
The table returned from this function is a snapshot. Although the SMU continues to update the statistics, the table returned will not be updated. To get fresh statistics, call this function again.
+
The statistics parameter has the following attributes:
+
+
+
+
Attribute
+
+
When returned
+
+
Description
+
+
+
+
n
+
+
Always
+
+
The number of data points on which the statistics are based
+
+
+
+
mean
+
+
When n > 0
+
+
The average of all readings added to the buffer
+
+
+
+
stddev
+
+
When n > 1
+
+
The standard deviation of all readings (samples) added to the buffer
+
+
+
+
min
+
+
When n > 0
+
+
A table containing data about the minimum reading value added to the buffer
+
+
+
+
max
+
+
When n > 0
+
+
A table containing data about the maximum reading value added to the buffer
+
+
+
+
+
If n equals zero (0), all other attributes will be nil because there is no data to base any statistics on. If n equals 1, the stddev attribute will be nil because the standard deviation of a sample size of 1 is undefined.
+
The min and max entries each have the following attributes:
+
+
+
+
Attribute
+
+
Description
+
+
+
+
measurefunction
+
+
String indicating the function measured for the reading (current, voltage, ohms or watts)
+
+
+
+
measurerange
+
+
The full-scale range value for the measure range used when the measurement was made
+
+
+
+
reading
+
+
The reading value
+
+
+
+
sourcefunction
+
+
String indicating the source function at the time of the measurement (current or voltage)
+
+
+
+
sourceoutputstate
+
+
String indicating the state of the source (off or on)
+
+
+
+
sourcerange
+
+
Full-scale range value for the source range used when the measurement was made
+
+
+
+
sourcevalue
+
+
If bufferVar.collectsourcevalues is enabled, the sourced value in effect at the time of the reading
+
+
+
+
status
+
+
Status value for the reading; the status value is a floating-point number that encodes the status value into a floating-point value
+
+
+
+
timestamp
+
+
If bufferVar.collecttimestamps is enabled, the timestamp, in seconds, between when the reading was acquired and when the first reading in the buffer was acquired; adding this value to the base timestamp will give the actual time the measurement was acquired
This function recalculates the specified reading buffer's statistics.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
smuX.buffer.recalculatestats(bufferVar)
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.buffer.recalculatestats() specifies SMU channel A)
+
+
+
+
bufferVar
+
+
The reading buffer to process
+
+
+
+
+
Details
+
This function will cause the SMU to regenerate the reading buffer statistics on the specified reading buffer. As the SMU automatically updates reading buffer statistics as data is added to the reading buffer, this function is generally not needed. When the reading buffer is configured to wrap around and overwrite older data with new data, the buffer statistics will include the data that was overwritten. Use this function to recalculate the statistics including only the data that is currently stored in the buffer.
The Model 2657A has two analog-to-digital converters (ADC): An integrating ADC and a fast ADC.
+
The integrating ADC uses a ratiometric analog-to-digital conversion technique. Depending on the configuration of the integrating ADC, periodic fresh reference measurements are required to minimize drift. The measurement aperture is used to determine the time interval between these measurement updates. For additional information, see Autozero. To help optimize operation of this ADC, the instrument caches the reference and zero values for up to ten of the most recent number of power line cycles. For additional information, see NPLC caching.
+
The fast ADC can acquire measurements at speeds up to 1 million samples per second. The fast ADC does not take reference measurements. A reading measurement acquisition buffer allows up to 5,000 readings to be made at the maximum acquisition rate of the fast ADCs. If this buffer is filled, the instrument slows its acquisition rate to the rate at which the instrument can process the data.
+
Data acquisition takes priority over both source operation and display operation. Sustained high data acquisition rates will cause the display to stop updating. A sustained high data acquisition rate during a sweep or pulse train may slow source operations. This can cause erratic sweep or pulse timing and may lead to triggers being missed (trigger overruns). Use the status model to monitor for trigger overruns. If a high sustained data acquisition rate causes undesirable sweep or pulse timing, reduce the data acquisition rate or reduce the total number of measurements until the desired sweep or pulse timing is achieved.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This attribute controls the overvoltage protection limit.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU reset Instrument reset Recall setup
+
+
Saved setup
+
+
0 (disabled)
+
+
+
+
+
Usage
+
limit = smuX.source.protectv
+
smuX.source.protectv = limit
+
+
+
+
limit
+
+
The overvoltage protection limit.
+
+
+
+
X
+
+
SMU channel (for example, smua.source.protectv applies to SMU channel A).
+
+
+
+
+
Details
+
Reading this attribute returns the overvoltage protection limit the SMU is currently using.
+
Setting this attribute to zero disables overvoltage protection (OVP). When this attribute is set to a nonzero value, the SMU will limit the voltage on the force leads to the value specified by this attribute.
+
The valid OVP range is between 300 V and 3000 V. Setting the OVP limit to a value outside of this range will generate standard error code -224, "Illegal parameter value." To disable OVP, either set smua.source.protectv = 0, or disable OVP from the front panel (see Front panel overvoltage protection).
This function is identical to the script.new() function, but it creates a script with the autorun attribute set to "yes".
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
scriptVar = script.newautorun(code)
+
scriptVar = script.newautorun(code, name)
+
+
+
+
scriptVar
+
+
The name of the variable that will reference the script
+
+
+
+
code
+
+
A string containing the body of the script
+
+
+
+
name
+
+
The name of the script
+
+
+
+
+
Details
+
The script.newautorun() function is identical to the script.new()function, except that the autorun attribute of the script is set to yes. The script is also automatically run immediately after it is created.
+
Example
+
+
+
+
NewAuto = script.newautorun("print('Hello from new auto run command')", 'NewAuto')
+
print(NewAuto.autorun)
+
print(NewAuto.name)
+
+
+
+
Creates a new script called NewAuto that automatically has the autorun attribute set to yes after it is created. The name attribute's value is set to "NewAuto".
Each time the script.run() command is given, the anonymous script is executed. This script can be run using this command many times without having to re-send it.
This KISweep factory script function performs a voltage list sweep with current measured at every step (point).
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
No
+
+
+
+
+
+
+
+
+
+
+
Usage
+
SweepVListMeasureI(smu, vlist, stime, points)
+
+
+
+
smu
+
+
System SourceMeter® instrument channel (set to smua)
+
+
+
+
vlist
+
+
Arbitrary list of voltage source values; vlist = {value1, value2, ... valueN}
+
+
+
+
stime
+
+
Settling time in seconds; occurs after stepping the source and before performing a measurement
+
+
+
+
points
+
+
Number of sweep points (must be ³2)
+
+
+
+
+
Details
+
Data for current measurements, voltage source values, and timestamps are stored in smuX.nvbuffer1.
+
If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.
+
Performs a voltage list sweep with current measured at every step (point):
+
1. Sets the smu to output vlist volts value, allows the source to settle for stime seconds, and then performs a current measurement.
+
2. Sets the smu to output the next vlist volts value, allows the source to settle for stime seconds, and then performs a current measurement.
+
3. Repeats the above sequence until the current is measured for the last volts value. The last point in the list to be measured is points.
+
Example
+
+
+
+
myvlist = {-100, 100, -200, 200, -400,
+
400, -800, 800, -1600, 1600}
+
+
SweepVListMeasureI(smua, myvlist,
+
500E-3, 10)
+
+
This function performs a 10‑point voltage list sweep starting at the first point in myvlist. Current is measured at every step (point) in the sweep. The source will be allowed to settle on each step for 500 ms before a measurement is performed.
+
+
+
+
+
Also see
+
None
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This function adds an entry to the User menu, which can be accessed by pressing the LOAD key on the instrument front panel.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
display.loadmenu.add(displayName, code)
+
display.loadmenu.add(displayName, code, memory)
+
+
+
+
displayName
+
+
The name that is added to the User menu
+
+
+
+
code
+
+
The code that is run from the User menu
+
+
+
+
memory
+
+
Determines if code is saved to nonvolatile memory:
+
0 or display.DONT_SAVE: Does not save the code to nonvolatile memory
+
1 or display.SAVE: Saves the code to nonvolatile memory (default)
+
+
+
+
+
Details
+
After adding code to the load menu, you can run it from the front panel by pressing the LOAD key, then selecting USER to select from the available code to load. Pressing the RUN key will then run the script.
+
You can add items in any order. They are always displayed in alphabetical order when the menu is selected.
+
Any Lua code can be can be included in the code parameter. If memory is set to display.SAVE, the entry (name and code) is saved in nonvolatile memory. Scripts, functions, and variables used in the code are not saved by display.SAVE. Functions and variables need to be saved with the code. If the code is not saved in nonvolatile memory, it will be lost when the Model 2657A is turned off. See Example 2 below.
+
If you do not make a selection for memory, the code is automatically saved to nonvolatile memory.
+
You can create a script that defines several functions, and then use the display.loadmenu.add() command to add items that call those individual functions. This allows the operator to run tests from the front panel.
+
Example 1
+
+
+
+
display.loadmenu.add("Test9", "Test9()")
+
+
Assume a user script named "Test9" has been loaded into the run-time environment. Adds the menu entry to the User menu to run the script after loading.
Assume a script with a function named “DUT1” has already been loaded into the instrument, and the script has NOT been saved in nonvolatile memory.
+
Now assume you want to add a test named “Test” to the USER TESTS menu. You want the test to run the function named “DUT1” and sound the beeper. This example adds “Test” to the menu, defines the code, and then saves the displayName and code in nonvolatile memory.
+
When “Test” is run from the front panel USER TESTS menu, the function named “DUT1” executes and the beeper beeps for two seconds.
+
Now assume you turn off instrument power. Because the script was not saved in nonvolatile memory, the function named “DUT1” is lost when you turn the instrument on. When “Test” is again run from the front panel, an error is generated because DUT1 no longer exists in the instrument as a function.
This function performs calibration of the fast analog-to-digital converter (fast ADC).
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
smuX.cal.fastadc()
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.cal.fastadc() specifies SMU channel A)
+
+
+
+
+
Details
+
This function automatically performs all the steps required to calibrate the fast ADC. This function uses the readings obtained when calibrating the measure ranges (make sure both voltage and current calibration has been completed before calling this function).
This attribute sets the source function used (source 0 A or 0 V) when the output is turned off and the source‑measure unit (SMU) is in normal output-off mode.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
SMU reset Instrument reset Recall setup
+
+
Saved setup
+
+
1 (smuX.OUTPUT_DCVOLTS)
+
+
+
+
+
Usage
+
offfunc = smuX.source.offfunc
+
smuX.source.offfunc = offfunc
+
+
+
+
offfunc
+
+
Set to the source function to be used when the output is off and the SMU is in normal output-off mode. Set to one of the following values:
+
0 or smuX.OUTPUT_DCAMPS: Source 0 A
+
1 or smuX.OUTPUT_DCVOLTS: Source 0 V
+
+
+
+
X
+
+
SMU channel (for example, smua.source.offfunc applies to SMU channel A)
+
+
+
+
+
Details
+
This attribute controls the source function used when the output is turned off and the smuX.source.offmode is set to smuX.OUTPUT_NORMAL. Set this attribute to smuX.OUTPUT_DCVOLTS for the source to be a 0 V source when the output is off (smuX.source.offlimiti is used). Set it to smuX.OUTPUT_DCAMPS for the source to be a 0 A source when the output is off (smuX.source.offlimitv is used).
+
This attribute is only used when the smuX.source.offmode attribute is set to smuX.OUTPUT_NORMAL.
+
Example
+
+
+
+
smua.source.offfunc = smua.OUTPUT_DCVOLTS
+
+
Sets the normal output-off mode to source 0 V when the output is turned off for SMU channel A.
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2657A/19514.html b/WebHelpDocs/Commands_2657A/19514.html
new file mode 100644
index 0000000..27fff19
--- /dev/null
+++ b/WebHelpDocs/Commands_2657A/19514.html
@@ -0,0 +1,44 @@
+
+
+ Advanced features for KIPulse tag parameter pulse functions
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Advanced features for KIPulse tag parameter pulse functions
+
Variable off time between pulses in a pulse train
+
The KIPulse “Configure” functions will accept the toff parameter as a table, or as a number. The table allows you to define different off times to be used after each pulse. The following should be noted:
+
If toff is passed as a number or only a single value is used in the table, it will be used for all points in a multiple point pulse.
The number of times specified in the table must match the number of points called for in the sweep.
The times used in tables must match for dual channel pulsing.
Each specified off time must adhere to the duty cycle limits for the specified pulsing region.
Simultaneous IV measurement during pulse
+
The KIPulse “Configure” functions will optionally accept an extra reading buffer to activate simultaneous IV measurements during pulsing. Previous usage of passing in a reading buffer or a nil (for no measurement) is still supported.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
Use the saved setups commands to save and restore the configuration of the instrument. You can restore (or save) configurations from the instrument's nonvolatile memory or an installed USB flash drive. You can use the setup.poweron attribute to specify which setup is recalled when the instrument is turned on.
This attribute selects the event that causes a trigger to be asserted on the digital output line.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Instrument reset Digital I/O trigger N reset Recall setup
+
+
Not saved
+
+
0
+
+
+
+
+
Usage
+
triggerStimulus = digio.trigger[N].stimulus
+
digio.trigger[N].stimulus = triggerStimulus
+
+
+
+
triggerStimulus
+
+
The event identifier for the triggering event
+
+
+
+
N
+
+
Digital I/O trigger line (1 to 14)
+
+
+
+
+
Details
+
Set this attribute to zero (0) to disable the automatic trigger output.
+
Do not use the stimulus attribute for generating output triggers under script control. Use digio.trigger[N].assert() instead.
+
The trigger stimulus for a digital I/O linemay be set to one of the existing trigger event IDs, described in the following table.
+
+
+
+
+
+
+
Trigger event IDs*
+
+
+
+
Event ID
+
+
Event description
+
+
+
+
smua.trigger.SWEEPING_EVENT_ID
+
+
Occurs when the source‑measure unit (SMU) transitions from the idle state to the arm layer of the trigger model
+
+
+
+
smua.trigger.ARMED_EVENT_ID
+
+
Occurs when the SMU moves from the arm layer to the trigger layer of the trigger model
+
+
+
+
smua.trigger.SOURCE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a source action
+
+
+
+
smua.trigger.MEASURE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a measure action
+
+
+
+
smua.trigger.PULSE_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a pulse
+
+
+
+
smua.trigger.SWEEP_COMPLETE_EVENT_ID
+
+
Occurs when the SMU completes a sweep
+
+
+
+
smua.trigger.IDLE_EVENT_ID
+
+
Occurs when the SMU returns to the idle state
+
+
+
+
digio.trigger[N].EVENT_ID
+
+
Occurs when an edge is detected on a digital I/O line
+
+
+
+
tsplink.trigger[N].EVENT_ID
+
+
Occurs when an edge is detected on a TSP‑Link line
+
+
+
+
lan.trigger[N].EVENT_ID
+
+
Occurs when the appropriate LXI trigger packet is received on LAN trigger object N
+
+
+
+
display.trigger.EVENT_ID
+
+
Occurs when the TRIG key on the front panel is pressed
+
+
+
+
trigger.EVENT_ID
+
+
Occurs when a *TRG command is received on the remote interface
+
GPIB only: Occurs when a GET bus command is received
+
VXI-11 only: Occurs with the VXI-11 command device_trigger; reference the VXI-11 standard for additional details on the device trigger operation
+
+
+
+
trigger.blender[N].EVENT_ID
+
+
Occurs after a collection of events is detected
+
+
+
+
trigger.timer[N].EVENT_ID
+
+
Occurs when a delay expires
+
+
+
+
* Use the name of the trigger event ID to set the stimulus value rather than the numeric value. Using the name makes the code compatible for future upgrades (for example, if the numeric values must change when enhancements are added to the instrument).
+
+
+
+
+
Example 1
+
+
+
+
digio.trigger[3].stimulus = 0
+
+
Clear the trigger stimulus of digital I/O line 3.
+
+
+
+
+
Example 2
+
+
+
+
digio.trigger[3].stimulus =
+
smua.trigger.SOURCE_COMPLETE_EVENT_ID
+
+
Set the trigger stimulus of digital I/O line 3 to be the source complete event.
The measure delay is a specific delay applied before each measurement is taken. This delay is set to the auto delay by default (see table). You can change the default delay by setting the smuX.measure.delay attribute either to a specific value or to an auto delay setting (set smua.measure.delay = smua.DELAY_AUTO). If the measure delay is set to the auto delay setting, a range-dependent delay is applied each time the instrument performs a current measurement. This delay also happens for the measurement that is taken after changing current ranges during an autoranged measurement. The following table contains the measure auto delays associated with each current range.
+
+
+
Range
+
+
Measure auto delay
+
+
+
+
120 mA
+
+
0.1 ms
+
+
+
+
20 mA
+
+
0.1 ms
+
+
+
+
2 mA
+
+
0.5 ms
+
+
+
+
1 mA
+
+
0.5 ms
+
+
+
+
100 mA
+
+
1 ms
+
+
+
+
10 mA
+
+
1 ms
+
+
+
+
1 mA
+
+
2 ms
+
+
+
+
100 nA
+
+
15 ms
+
+
+
+
10 nA
+
+
150 ms
+
+
+
+
1 nA
+
+
1 s
+
+
+
+
+
You can increase or decrease the auto delay by changing the delay factor (for example, to reduce the delay across all ranges by half, set smua.measure.delayfactor = 0.5). For additional information, refer to smuX.measure.delayfactor in the "Remote commands" section.
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This attribute contains the measurement range values that were used for readings stored in a specified buffer.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Clearing the buffer
+
+
See Details
+
+
Not applicable
+
+
+
+
+
Usage
+
measurerange = bufferVar.measureanges[N]
+
+
+
+
measurerange
+
+
The measurement range used to acquire reading number N in the specified buffer
+
+
+
+
bufferVar
+
+
The reading buffer; can be a dynamically allocated buffer (user‑defined), or a dedicated reading buffer (such as smua.nvbuffer1)
+
+
+
+
N
+
+
The reading number (1 to bufferVar.n)
+
+
+
+
+
+
Details
+
The measureranges buffer recall attribute is like an array (a Lua table) of full-scale range values for the measure range used when the measurement was made.
+
For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.
+
+
Example
+
+
+
+
measurerange = smua.nvbuffer1.measureranges[1]
+
+
+
Store the measure range that was used to make reading number 1.
+
+
+
+
printbuffer(1, 10, smua.nvbuffer1.measureranges)
+
+
Print the range values that were used for the first 10 readings saved in dedicated reading buffer 1.
This attribute indicates the state of the source output for readings stored in a specified buffer.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Clearing the buffer
+
+
See Details
+
+
Not applicable
+
+
+
+
+
Usage
+
state = bufferVar.sourceoutputstates[N]
+
+
+
+
state
+
+
The output state ("Off" or "On") when reading N of the specified buffer was acquired
+
+
+
+
bufferVar
+
+
The reading buffer; can be a dynamically allocated buffer (user‑defined), or a dedicated reading buffer (such as smua.nvbuffer1)
+
+
+
+
N
+
+
The reading number (1 to bufferVar.n)
+
+
+
+
+
Details
+
The sourceoutputstates buffer recall attribute is like an array (a Lua table) of strings indicating the state of the source output ("Off" or "On") at the time of the measurement.
+
For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.
This attribute contains the source range that was used for readings stored in a specified reading buffer.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Clearing the buffer
+
+
See Details
+
+
Not applicable
+
+
+
+
+
Usage
+
sourcerange = bufferVar.sourceranges[N]
+
+
+
+
sourcerange
+
+
The source range used to acquire reading number N in the specified buffer
+
+
+
+
bufferVar
+
+
The reading buffer; can be a dynamically allocated buffer (user‑defined), or a dedicated reading buffer (such as smua.nvbuffer1)
+
+
+
+
N
+
+
The reading number (1 to bufferVar.n)
+
+
+
+
+
Details
+
The sourceranges buffer recall attribute is like an array (a Lua table) of full-scale range values for the source range used when the measurement was made.
+
For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.
+
+
Example 1
+
+
+
+
sourcerange = smua.nvbuffer1.sourceranges[1]
+
+
+
Store the source range that was used for the first reading stored in dedicated reading buffer 1.
+
+
+
+
+
Example 2
+
+
+
+
printbuffer(1, 6, smua.nvbuffer1.sourceranges)
+
+
Print the source ranges that were used for the first 6 readings stored in source‑measure unit (SMU) A, buffer 1.
When enabled by the bufferVar.collectsourcevalues attribute, this attribute contains the source levels being output when readings in the reading buffer were acquired.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Clearing the buffer
+
+
See Details
+
+
Not applicable
+
+
+
+
+
Usage
+
sourcevalue = bufferVar.sourcevalues[N]
+
+
+
+
sourcevalue
+
+
The source's output value when reading N of the specified buffer was acquired
+
+
+
+
bufferVar
+
+
The reading buffer; can be a dynamically allocated buffer (user‑defined), or a dedicated reading buffer (such as smua.nvbuffer1)
+
+
+
+
N
+
+
The reading number (1 to bufferVar.n)
+
+
+
+
+
Details
+
If the bufferVar.collectsourcevalues attribute is enabled before readings are taken, the bufferVar.sourcevalues buffer recall attribute is like an array (a Lua table) of the sourced value in effect at the time of the reading. Note that you can set the bufferVar.collectsourcevalues attribute only if the affected reading buffer is empty. See bufferVar.collectsourcevalues for more detailed information.
+
For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.
+
Example 1
+
+
+
+
sourcevalue = smua.nvbuffer1.sourcevalues[1]
+
+
+
Get the sourced value of the first reading stored in dedicated reading buffer 1.
+
+
+
+
+
Example 2
+
+
+
+
printbuffer(1, 6, smua.nvbuffer1.sourcevalues)
+
+
Print the sourced value of the first 6 readings stored in source‑measure unit (SMU) A, buffer 1.
This attribute contains the readings stored in a specified reading buffer.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Clearing the buffer
+
+
See Details
+
+
Not applicable
+
+
+
+
+
Usage
+
reading = bufferVar.readings[N]
+
+
+
+
reading
+
+
The value of the reading in the specified reading buffer
+
+
+
+
bufferVar
+
+
The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer
+
+
+
+
N
+
+
The reading number (1 to bufferVar.n)
+
+
+
+
+
Details
+
The readings buffer recall attribute is like an array (a Lua table) of the readings stored in the reading buffer. This array holds the same data that is returned when the reading buffer is accessed directly; that is, rb[2] and rb.readings[2] access the same value.
+
For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.
+
Example
+
+
+
+
print(smua.nvbuffer1.readings[1])
+
+
Output the first reading saved in dedicated reading buffer 1.
This attribute contains the status values of readings in the reading buffer.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Clearing the buffer
+
+
See Details
+
+
Not applicable
+
+
+
+
+
Usage
+
statusInformation = bufferVar.statuses[N]
+
+
+
+
statusInformation
+
+
The status value when reading N of the specified buffer was acquired
+
+
+
+
bufferVar
+
+
The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer
+
+
+
+
N
+
+
The reading number (1 to bufferVar.n)
+
+
+
+
+
Details
+
This read‑only buffer recall attribute is like an array (a Lua table) of the status values for all of the readings in the buffer. The status values are floating-point numbers that encode the status value; see the following table for values.
+
For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.
When enabled by the bufferVar.collecttimestamps attribute, this attribute contains the timestamp (in seconds) of when each reading saved in the specified reading buffer occurred.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (R)
+
+
Yes
+
+
Clearing the buffer
+
+
See Details
+
+
Not applicable
+
+
+
+
+
Usage
+
timestamp = bufferVar.timestamps[N]
+
+
+
+
timestamp
+
+
The timestamp of reading number N in the specified buffer when the reading was acquired
+
+
+
+
bufferVar
+
+
The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer
+
+
+
+
N
+
+
The reading number (1 to bufferVar.n)
+
+
+
+
+
Details
+
The bufferVar.timestamps information from a reading buffer is only available if the bufferVar.collecttimestamps attribute is set to 1 (default setting). If it is set to 0, you will not be able to access any time information from a reading buffer.
+
If enabled, this buffer recall attribute is like an array (a Lua table) containing timestamps, in seconds, of when each reading occurred. These are relative to the bufferVar.basetimestamp for the buffer. See Reading buffer commands for more information.
+
For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.
+
Example
+
+
+
+
timestamp = smua.nvbuffer1.timestamps[1]
+
+
+
Get the timestamp of the first reading stored in dedicated reading buffer 1.
This function returns an iterator that can be used in a for loop to iterate over all the factory scripts.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
for name in script.factory.catalog() do body end
+
+
+
+
name
+
+
String representing the name of the script
+
+
+
+
body
+
+
Code that implements the body of the for loop to process the names in the catalog
+
+
+
+
+
Details
+
Accessing this catalog of scripts allows you to process the factory scripts. The entries will be enumerated in no particular order.
+
Each time the body of the function executes, name takes on the name of one of the factory scripts. The for loop repeats until all scripts have been iterated.
+
Example
+
+
+
+
for name in script.factory.catalog() do
+
print(name)
+
end
+
+
Retrieve the catalog listing for factory scripts.
+
+
+
+
+
Also see
+
None
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This function performs calibration of the overvoltage protection limit (OVP).
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
smuX.cal.ovp()
+
+
+
+
X
+
+
Source‑measure unit (SMU) channel (for example, smua.cal.ovp() specifies SMU channel A)
+
+
+
+
+
Details
+
This function automatically performs all the steps required to calibrate the overvoltage protection (OVP) limit circuit. Since this function uses the readings obtained during calibration of the measure ranges, make sure voltage calibration has been completed before calling this function.
The measurement overvoltage summary register status. A zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 2
+
+
+
+
+
Details
+
These attributes are used to read or write to the measurement event overvoltage summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000 0000 0000 0010. This value indicates that bit B1 (SMUA) is set.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
Not used
+
+
Not applicable.
+
+
+
+
B1
+
+
status.measurement.overvoltage.SMUA
+
+
Set bit indicates that an overvoltage condition has been detected.
+
Bit B1 decimal value: 2
+
Binary value: 0000 0010
+
+
+
+
B2-B15
+
+
Not used
+
+
Not applicable.
+
+
+
+
+
As an example, to set bit B1 of the measurement event overvoltage summary enable register, set status.measurement.overvoltage.enable = status.measurement.overvoltage.SMUA.
+
In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B1, set measurementRegister to 2.
+
Example
+
+
+
+
status.measurement.overvoltage.enable =
+
status.measurement.overvoltage.SMUA
+
+
Sets the SMU A bit of the measurement overvoltage summary enable register using a constant.
The measurement sink limit summary register status. A zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 2
+
+
+
+
+
Details
+
These attributes are used to read or write to the measurement event sink limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000 0000 0000 0010. This value indicates that bit B1 (SMUA) is set.
+
For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.
+
+
+
+
Bit
+
+
Value
+
+
Description
+
+
+
+
B0
+
+
Not used
+
+
Not applicable.
+
+
+
+
B1
+
+
status.measurement.sink_limit.SMUA
+
+
Set bit indicates that the sink limit was exceeded.
+
Bit B1 decimal value: 2
+
Binary value: 0000 0000 0000 0010
+
+
+
+
B2-B15
+
+
Not used
+
+
Not applicable.
+
+
+
+
+
As an example, to set bit B1 of the measurement event sink limit summary enable register, set status.measurement.sink_limit.enable = status.measurement.sink_limit.SMUA.
+
In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B1, set measurementRegister to 2.
+
Example
+
+
+
+
status.measurement.sink_limit.enable =
+
status.measurement.sink_limit.SMUA
+
+
Sets the SMU A bit of the measurement sink limit summary enable register using a constant.
This function captures the key code value for the next front‑panel action.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Function
+
+
Yes
+
+
+
+
+
+
+
+
+
+
+
Usage
+
keyCode = display.waitkey()
+
+
+
+
keyCode
+
+
See Details for more information
+
+
+
+
+
Details
+
After you send this function, script execution pauses until a front‑panel action (for example, pressing a key or the navigation wheel , or turning the navigation wheel ). After the action, the value of the key (or action) is returned.
+
If the EXIT (LOCAL) key is pressed while this function is waiting for a front‑panel action, the script is not aborted.
+
The table below lists the keyCode value for each front panel action.
+
+
+
+
+
+
+
+
+
+
Key codes
+
+
+
+
Value
+
+
Key (or action)
+
+
+
+
Value
+
+
Key (or action)
+
+
+
+
0
+
+
display.KEY_NONE
+
+
+
+
82
+
+
display.KEY_ENTER
+
+
+
+
65
+
+
display.KEY_RANGEUP
+
+
+
+
85
+
+
display.KEY_RECALL
+
+
+
+
68
+
+
display.KEY_MENU
+
+
+
+
86
+
+
display.KEY_MEASA
+
+
+
+
69
+
+
display.KEY_MODEA
+
+
+
+
86
+
+
display.KEY_DIGITSA
+
+
+
+
70
+
+
display.KEY_RELA
+
+
+
+
88
+
+
display.KEY_OUTPUTA
+
+
+
+
71
+
+
display.KEY_RUN
+
+
+
+
92
+
+
display.KEY_TRIG
+
+
+
+
72
+
+
display.KEY_DISPLAY
+
+
+
+
93
+
+
display.KEY_LIMITA
+
+
+
+
73
+
+
display.KEY_AUTO
+
+
+
+
94
+
+
display.KEY_SPEEDA
+
+
+
+
75
+
+
display.KEY_EXIT
+
+
+
+
95
+
+
display.KEY_LOAD
+
+
+
+
77
+
+
display.KEY_FILTERA
+
+
+
+
97
+
+
display.WHEEL_ENTER
+
+
+
+
78
+
+
display.KEY_STORE
+
+
+
+
103
+
+
display.KEY_RIGHT
+
+
+
+
79
+
+
display.KEY_SRCA
+
+
+
+
104
+
+
display.KEY_LEFT
+
+
+
+
80
+
+
display.KEY_CONFIG
+
+
+
+
107
+
+
display.WHEEL_LEFT
+
+
+
+
81
+
+
display.KEY_RANGEDOWN
+
+
+
+
114
+
+
display.WHEEL_RIGHT
+
+
+
+
+
When using this function, use built-in constants such as display.KEY_RIGHT (rather than the numeric value of 103). This will allow for better forward compatibility with firmware revisions.
+
Example
+
+
+
+
key = display.waitkey()
+
print(key)
+
+
Pause script execution until the operator presses a key or the navigation wheel, or rotates the navigation wheel.
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2657A/2408.html b/WebHelpDocs/Commands_2657A/2408.html
new file mode 100644
index 0000000..9e3105f
--- /dev/null
+++ b/WebHelpDocs/Commands_2657A/2408.html
@@ -0,0 +1,45 @@
+
+
+ Delete user scripts from the instrument
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Delete user scripts from the instrument
+
In most circumstances, you can delete a script using script.delete() (as described in Delete user scripts), and then turn the instrument off and back on again. However, if you cannot turn the instrument off, you can use the following steps to completely remove a script from the instrument.
+
When you completely remove a script, you delete all references to the script from the run-time environment, the script.user.scripts table, and nonvolatile memory.
+
To completely remove a script:
+
Remove the script from the run-time environment. Set any variables that refer to the script to nil or assign the variables a different value. For example, to remove the script "beepTwoSec" from the run-time environment, send the following code: beepTwoSec = nil
Remove the script from the script.user.scripts table. Set the name attribute to an empty string (""). This makes the script nameless, but does not make the script become the anonymous script. For example, to remove the script named "beepTwoSec", send the following code: script.user.scripts.beepTwoSec.name = ""
Remove the script from nonvolatile memory. To delete the script from nonvolatile memory, send the command: script.delete("name")
Where name is the name that the script was saved as. For example, to delete beepTwoSec, you would send: script.delete("beepTwoSec")
+
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
Sets the garbage-collection threshold to the given limit (in kilobytes) and checks it against the byte counter. If the new threshold is smaller than the byte counter, Lua immediately runs the garbage collector. If there is no limit parameter, it defaults to zero (0), which forces a garbage‑collection cycle. See the "Lua memory management" topic for more information.
+
+
+
+
gcinfo()
+
+
Returns the number of kilobytes of dynamic memory that the Test Script Processor (TSP®) scripting engine is using, and returns the current garbage collector threshold (also in kilobytes). See the "Lua memory management" topic for more information.
+
+
+
+
tonumber(x)
+
tonumber(x, base)
+
+
Returns x converted to a number. If x is already a number, or a convertible string, the number is returned; otherwise, it returns nil.
+
An optional argument specifies the base to interpret the numeral. The base may be any integer between 2 and 36, inclusive. In bases above 10, the letter A (in either upper or lower case) represents 10, B represents 11, and so forth, with Z representing 35. In base 10, the default, the number may have a decimal part, as well as an optional exponent. In other bases, only unsigned integers are accepted.
+
+
+
+
tostring(x)
+
+
Receives an argument of any type and converts it to a string in a reasonable format.
+
+
+
+
type(v)
+
+
Returns (as a string) the type of its only argument. The possible results of this function are "nil" (a string, not the value nil), "number", "string", "boolean", "table", "function", "thread", and "userdata".
+
+
+
+
+
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This attribute contains the power line frequency setting used for NPLC calculations.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
Yes
+
+
Not applicable
+
+
Nonvolatile memory
+
+
Country specific (50 Hz or 60 Hz)
+
+
+
+
+
Usage
+
frequency = localnode.linefreq
+
localnode.linefreq = frequency
+
+
+
+
frequency
+
+
An integer representing the specified power line frequency
+
+
+
+
+
Details
+
To achieve optimum noise rejection when performing measurements at integer NPLC apertures, set the line frequency attribute to match the frequency (50 Hz or 60 Hz) of the AC power line.
+
When using this command from a remote node, localnode should be replaced with the node reference, for example node[5].linefreq.
+
Example 1
+
+
+
+
frequency = localnode.linefreq
+
+
Reads line frequency setting.
+
+
+
+
+
Example 2
+
+
+
+
localnode.linefreq = 60
+
+
Sets the line frequency to 60 Hz.
+
+
+
+
+
Also see
+
None
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
This attribute contains the name of a script in the run-time environment.
+
+
+
Type
+
+
TSP-Link accessible
+
+
Affected by
+
+
Where saved
+
+
Default value
+
+
+
+
Attribute (RW)
+
+
No
+
+
Not applicable
+
+
Not applicable
+
+
Not applicable
+
+
+
+
+
Usage
+
scriptVar.name = scriptName
+
scriptName= scriptVar.name
+
+
+
+
scriptVar
+
+
Name of the variable that references the script
+
+
+
+
scriptName
+
+
A string that represents the name of the script
+
+
+
+
+
Details
+
When setting the script name, this attribute renames the script that the variable scriptVar references.
+
This attribute must be either a valid Lua identifier or the empty string. Changing the name of a script changes the index used to access the script in the script.user.scripts table. Setting the attribute to an empty string removes the script from the table completely, and the script becomes an unnamed script.
+
As long as there are variables referencing an unnamed script, the script can be accessed through those variables. When all variables that reference an unnamed script are removed, the script will be removed from the run‑time environment.
+
If the new name is the same as a name that is already used for another script, the name of the other script is set to an empty string, and that script becomes unnamed.
+
Changing the name of a script does not change the name of any variables that reference that script. The variables will still reference the script, but the names of the script and variables may not match.
+
Example
+
+
+
+
test7 = script.new("display.clear() display.settext('Hello from my test')", "")
+
test7()
+
print(test7.name)
+
+
test7.name = "test7"
+
print(test7.name)
+
test7.save()
+
+
+
+
The above example calls the script.new() function to create a script with no name, runs the script, names the script "test7", and then saves the script in nonvolatile memory.
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2657A/2600s-901-01b_kipulsetsptestscript_configpulseimeasurev.png b/WebHelpDocs/Commands_2657A/2600s-901-01b_kipulsetsptestscript_configpulseimeasurev.png
new file mode 100644
index 0000000..a741d9b
Binary files /dev/null and b/WebHelpDocs/Commands_2657A/2600s-901-01b_kipulsetsptestscript_configpulseimeasurev.png differ
diff --git a/WebHelpDocs/Commands_2657A/2600s-901-01b_kipulsetsptestscript_configpulseimeasurevsweeplin.png b/WebHelpDocs/Commands_2657A/2600s-901-01b_kipulsetsptestscript_configpulseimeasurevsweeplin.png
new file mode 100644
index 0000000..eb2b887
Binary files /dev/null and b/WebHelpDocs/Commands_2657A/2600s-901-01b_kipulsetsptestscript_configpulseimeasurevsweeplin.png differ
diff --git a/WebHelpDocs/Commands_2657A/2600s-901-01b_kipulsetsptestscript_configpulseimeasurevsweeplog.png b/WebHelpDocs/Commands_2657A/2600s-901-01b_kipulsetsptestscript_configpulseimeasurevsweeplog.png
new file mode 100644
index 0000000..6981b97
Binary files /dev/null and b/WebHelpDocs/Commands_2657A/2600s-901-01b_kipulsetsptestscript_configpulseimeasurevsweeplog.png differ
diff --git a/WebHelpDocs/Commands_2657A/2600s-901-01b_kipulsetsptestscript_configpulsevmeasurei.png b/WebHelpDocs/Commands_2657A/2600s-901-01b_kipulsetsptestscript_configpulsevmeasurei.png
new file mode 100644
index 0000000..9ed1ee5
Binary files /dev/null and b/WebHelpDocs/Commands_2657A/2600s-901-01b_kipulsetsptestscript_configpulsevmeasurei.png differ
diff --git a/WebHelpDocs/Commands_2657A/2600s-901-01b_kipulsetsptestscript_configpulsevmeasureisweeplin.png b/WebHelpDocs/Commands_2657A/2600s-901-01b_kipulsetsptestscript_configpulsevmeasureisweeplin.png
new file mode 100644
index 0000000..43e350a
Binary files /dev/null and b/WebHelpDocs/Commands_2657A/2600s-901-01b_kipulsetsptestscript_configpulsevmeasureisweeplin.png differ
diff --git a/WebHelpDocs/Commands_2657A/2600s-901-01b_kipulsetsptestscript_configpulsevmeasureisweeplog.png b/WebHelpDocs/Commands_2657A/2600s-901-01b_kipulsetsptestscript_configpulsevmeasureisweeplog.png
new file mode 100644
index 0000000..8e419cb
Binary files /dev/null and b/WebHelpDocs/Commands_2657A/2600s-901-01b_kipulsetsptestscript_configpulsevmeasureisweeplog.png differ
diff --git a/WebHelpDocs/Commands_2657A/2600s-901-01b_kisweeptsptestscript_pulseimeasurev.png b/WebHelpDocs/Commands_2657A/2600s-901-01b_kisweeptsptestscript_pulseimeasurev.png
new file mode 100644
index 0000000..c0eaeed
Binary files /dev/null and b/WebHelpDocs/Commands_2657A/2600s-901-01b_kisweeptsptestscript_pulseimeasurev.png differ
diff --git a/WebHelpDocs/Commands_2657A/2600s-901-01b_kisweeptsptestscript_pulsevmeasurei.png b/WebHelpDocs/Commands_2657A/2600s-901-01b_kisweeptsptestscript_pulsevmeasurei.png
new file mode 100644
index 0000000..df85cbe
Binary files /dev/null and b/WebHelpDocs/Commands_2657A/2600s-901-01b_kisweeptsptestscript_pulsevmeasurei.png differ
diff --git a/WebHelpDocs/Commands_2657A/2600s-901-01b_kisweeptsptestscript_sweepilinmeasurev.png b/WebHelpDocs/Commands_2657A/2600s-901-01b_kisweeptsptestscript_sweepilinmeasurev.png
new file mode 100644
index 0000000..3713a0e
Binary files /dev/null and b/WebHelpDocs/Commands_2657A/2600s-901-01b_kisweeptsptestscript_sweepilinmeasurev.png differ
diff --git a/WebHelpDocs/Commands_2657A/2600s-901-01b_kisweeptsptestscript_sweepilogmeasurev.png b/WebHelpDocs/Commands_2657A/2600s-901-01b_kisweeptsptestscript_sweepilogmeasurev.png
new file mode 100644
index 0000000..1a096e2
Binary files /dev/null and b/WebHelpDocs/Commands_2657A/2600s-901-01b_kisweeptsptestscript_sweepilogmeasurev.png differ
diff --git a/WebHelpDocs/Commands_2657A/2600s-901-01b_kisweeptsptestscript_sweepvlinmeasurei.png b/WebHelpDocs/Commands_2657A/2600s-901-01b_kisweeptsptestscript_sweepvlinmeasurei.png
new file mode 100644
index 0000000..d8bcf8b
Binary files /dev/null and b/WebHelpDocs/Commands_2657A/2600s-901-01b_kisweeptsptestscript_sweepvlinmeasurei.png differ
diff --git a/WebHelpDocs/Commands_2657A/2600s-901-01b_kisweeptsptestscript_sweepvlogmeasurei.png b/WebHelpDocs/Commands_2657A/2600s-901-01b_kisweeptsptestscript_sweepvlogmeasurei.png
new file mode 100644
index 0000000..a57cc29
Binary files /dev/null and b/WebHelpDocs/Commands_2657A/2600s-901-01b_kisweeptsptestscript_sweepvlogmeasurei.png differ
diff --git a/WebHelpDocs/Commands_2657A/26xxas-901-01e_fourquadrantsofoperation.png b/WebHelpDocs/Commands_2657A/26xxas-901-01e_fourquadrantsofoperation.png
new file mode 100644
index 0000000..f5b0415
Binary files /dev/null and b/WebHelpDocs/Commands_2657A/26xxas-901-01e_fourquadrantsofoperation.png differ
diff --git a/WebHelpDocs/Commands_2657A/26xxicldescription-table.png b/WebHelpDocs/Commands_2657A/26xxicldescription-table.png
new file mode 100644
index 0000000..abd546f
Binary files /dev/null and b/WebHelpDocs/Commands_2657A/26xxicldescription-table.png differ
diff --git a/WebHelpDocs/Commands_2657A/3249.html b/WebHelpDocs/Commands_2657A/3249.html
new file mode 100644
index 0000000..06a5fc4
--- /dev/null
+++ b/WebHelpDocs/Commands_2657A/3249.html
@@ -0,0 +1,62 @@
+
+
+ Removing stale values from the reading buffer cache
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Removing stale values from the reading buffer cache
+
The node that acquires the data stores the data for the reading buffer. To optimize data access, all nodes can cache data from the node that stores the reading buffer data.
+
Running Lua code remotely can cause reading buffer data that is held in the cache to become stale. If the values in the reading buffer change while the Lua code runs remotely, another node can hold stale values. Use the clearcache() command to clear the cache. For additional detail on the reading buffer cache commands, see bufferVar.cachemode and bufferVar.clearcache().
+
The following example code demonstrates how stale values occur and how to use the clearcache() command to clear the cache on node 2, which is part of group 7.
+
-- Create a reading buffer on a node in a remote group.
Test Script Processor (TSP®) enabled instruments do not have inherent query commands. Like any other scripting environment, the print() command and other related commands generate output in the form of response messages. Each print() command creates one response message.
+
Example
+
+
+
+
x = 10
+
print(x)
+
+
Example of an output response message:
+
1.00000e+01
+
Note that your output might be different if you set your ASCII precision setting to a different value.
+
+
+
+
+
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2657A/3700S_toc.xml b/WebHelpDocs/Commands_2657A/3700S_toc.xml
new file mode 100644
index 0000000..57747e5
--- /dev/null
+++ b/WebHelpDocs/Commands_2657A/3700S_toc.xml
@@ -0,0 +1,4 @@
+
+
+
+
\ No newline at end of file
diff --git a/WebHelpDocs/Commands_2657A/492.html b/WebHelpDocs/Commands_2657A/492.html
new file mode 100644
index 0000000..e3360d8
--- /dev/null
+++ b/WebHelpDocs/Commands_2657A/492.html
@@ -0,0 +1,94 @@
+
+
+ Attributes
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Attributes
+
Attribute-based commands are commands that set the characteristics of an instrument feature or operation. For example, some characteristics of TSP‑enabled instruments are the model number (localnode.model) and the number of errors in the error queue (errorqueue.count).
+
+
To set the characteristics, attribute-based commands define a value. For many attributes, the value is in the form of a number or a predefined constant.
+
Example 1: Set an attribute using a number
+
+
+
+
format.data = 3
+
+
This attribute sets the format of data printed by other commands. Setting this attribute to 3 sets the print format to double precision floating point format.
+
+
+
+
+
+
Example 2: Set an attribute using a constant
+
+
+
+
format.data = format.REAL64
+
+
Using the constant REAL64 instead of 3 also sets the print format to double precision floating point format.
+
+
+
+
+
+
+
To read an attribute, you can use the attribute as the parameter of a function, or assign it to another variable.
+
Example 3: Read an attribute using a function
+
+
+
+
print(format.data)
+
+
Reads the data format by passing the attribute to the print function. If the data format is set to 3, the output is:
+
3.00000e+00
+
This shows that the data format is set to double precision floating point.
+
+
+
+
+
Example 4: Read an attribute using a variable
+
+
+
+
fd = format.data
+
+
This reads the data format by assigning the attribute to a variable named fd.
+
+
+
+
+
+
+
+
+
+
+
Copyright (c) 2007-2012, Keithley Instruments, Inc. All rights reserved.
+
+
+
+
diff --git a/WebHelpDocs/Commands_2657A/70xbicldescription-alsosee.png b/WebHelpDocs/Commands_2657A/70xbicldescription-alsosee.png
new file mode 100644
index 0000000..b36ae47
Binary files /dev/null and b/WebHelpDocs/Commands_2657A/70xbicldescription-alsosee.png differ
diff --git a/WebHelpDocs/Commands_2657A/70xbicldescription-details.png b/WebHelpDocs/Commands_2657A/70xbicldescription-details.png
new file mode 100644
index 0000000..46a122f
Binary files /dev/null and b/WebHelpDocs/Commands_2657A/70xbicldescription-details.png differ
diff --git a/WebHelpDocs/Commands_2657A/70xbicldescription-example.png b/WebHelpDocs/Commands_2657A/70xbicldescription-example.png
new file mode 100644
index 0000000..36d87cb
Binary files /dev/null and b/WebHelpDocs/Commands_2657A/70xbicldescription-example.png differ
diff --git a/WebHelpDocs/Commands_2657A/70xbicldescription-usage.png b/WebHelpDocs/Commands_2657A/70xbicldescription-usage.png
new file mode 100644
index 0000000..f09a69b
Binary files /dev/null and b/WebHelpDocs/Commands_2657A/70xbicldescription-usage.png differ
diff --git a/WebHelpDocs/Commands_2657A/AfterPublish.bat b/WebHelpDocs/Commands_2657A/AfterPublish.bat
new file mode 100644
index 0000000..7558f57
--- /dev/null
+++ b/WebHelpDocs/Commands_2657A/AfterPublish.bat
@@ -0,0 +1,19 @@
+::--------------------------------------------------
+:: AfterPublishing.bat - Runs OracleToEclipse
+::--------------------------------------------------
+
+@echo off
+
+::Get the current batch file's short path
+for %%x in (%0) do set BatchPath=%%~dpsx
+for %%x in (%BatchPath%) do set BatchPath=%%~dpsx
+echo BatchPath = %BatchPath%
+
+echo "Enter ShortName (2600A, 3700, 707B, 2651A, 2657A):"
+set /p ShortName=
+
+echo "ShortName is " %ShortName%
+
+cd %BatchPath%
+OracleToEclipse toc.xml %ShortName%
+
diff --git a/WebHelpDocs/Commands_2657A/Model 2651A help files.hs b/WebHelpDocs/Commands_2657A/Model 2651A help files.hs
new file mode 100644
index 0000000..af9f76f
--- /dev/null
+++ b/WebHelpDocs/Commands_2657A/Model 2651A help files.hs
@@ -0,0 +1,25 @@
+
+
+
+
+Model 2657A help files
+
+
+
+ O19545
+
+
+
+
+
+
+ oracle.help.navigator.tocNavigator.TOCNavigator
+ toc.xml
+
+
+
+ oracle.help.navigator.searchNavigator.SearchNavigator
+ search.idx
+
+
+
diff --git a/WebHelpDocs/Commands_2657A/Model 2657A help files.hs b/WebHelpDocs/Commands_2657A/Model 2657A help files.hs
new file mode 100644
index 0000000..af9f76f
--- /dev/null
+++ b/WebHelpDocs/Commands_2657A/Model 2657A help files.hs
@@ -0,0 +1,25 @@
+
+
+
+
+Model 2657A help files
+
+
+
+ O19545
+
+
+
+
+
+
+ oracle.help.navigator.tocNavigator.TOCNavigator
+ toc.xml
+
+
+
+ oracle.help.navigator.searchNavigator.SearchNavigator
+ search.idx
+
+
+
diff --git a/WebHelpDocs/Commands_2657A/OracleToEclipse.exe b/WebHelpDocs/Commands_2657A/OracleToEclipse.exe
new file mode 100644
index 0000000..696ed36
Binary files /dev/null and b/WebHelpDocs/Commands_2657A/OracleToEclipse.exe differ
diff --git a/WebHelpDocs/Commands_2657A/OracleToEclipse.xslt b/WebHelpDocs/Commands_2657A/OracleToEclipse.xslt
new file mode 100644
index 0000000..9c676b8
--- /dev/null
+++ b/WebHelpDocs/Commands_2657A/OracleToEclipse.xslt
@@ -0,0 +1,28 @@
+
+
+
+
+
+
+
+
+ /.html
+
+
+
+
+
+
+
+
+ _toc.xml
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/WebHelpDocs/Commands_2657A/cautionhelp.png b/WebHelpDocs/Commands_2657A/cautionhelp.png
new file mode 100644
index 0000000..6856d76
Binary files /dev/null and b/WebHelpDocs/Commands_2657A/cautionhelp.png differ
diff --git a/WebHelpDocs/Commands_2657A/contents1.gif b/WebHelpDocs/Commands_2657A/contents1.gif
new file mode 100644
index 0000000..18ec664
Binary files /dev/null and b/WebHelpDocs/Commands_2657A/contents1.gif differ
diff --git a/WebHelpDocs/Commands_2657A/contents2.gif b/WebHelpDocs/Commands_2657A/contents2.gif
new file mode 100644
index 0000000..aac2736
Binary files /dev/null and b/WebHelpDocs/Commands_2657A/contents2.gif differ
diff --git a/WebHelpDocs/Commands_2657A/contents3.gif b/WebHelpDocs/Commands_2657A/contents3.gif
new file mode 100644
index 0000000..9fef3ca
Binary files /dev/null and b/WebHelpDocs/Commands_2657A/contents3.gif differ
diff --git a/WebHelpDocs/Commands_2657A/dhtml_search.htm b/WebHelpDocs/Commands_2657A/dhtml_search.htm
new file mode 100644
index 0000000..b0845da
--- /dev/null
+++ b/WebHelpDocs/Commands_2657A/dhtml_search.htm
@@ -0,0 +1,12 @@
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/WebHelpDocs/Commands_2657A/dhtml_search.js b/WebHelpDocs/Commands_2657A/dhtml_search.js
new file mode 100644
index 0000000..4ae4e82
--- /dev/null
+++ b/WebHelpDocs/Commands_2657A/dhtml_search.js
@@ -0,0 +1,614 @@
+/* Generated with Author-it 5.4.131.8883 4/5/2012 3:18:06 PM */
+Page=new Array();Page[0]=new Array("Keithley Instruments Test Script Processor (TSP®) enabled instruments operate like conventional instruments by responding to a sequence of commands sent by the controller. You can send individual commands to the TSP-enabled instrument the same way you would using any other instrument. ","Unlike conventional instruments, TSP-enabled instruments can execute automated test sequences independently, without a controller. You can load a series of remote commands into the instrument and store these commands as a script that can be run later by sending a single command message to the instrument. You do not have to choose between using “conventional” control or “script” control. You can combine these forms of instrument control in the way that works best for your particular test application.","Introduction to remote operation","17029.html");
+Page[1]=new Array("The simplest method of controlling an instrument through the communication interface is to send it a message that contains remote commands. You can use a test program that resides on a computer (the controller) to sequence the actions of the instrument.","Remote commands can be function-based or attribute-based. Function-based commands are commands that control actions or activities. Attribute-based commands define characteristics of an instrument feature or operation.","Controlling the instrument by sending individual command messages","17268.html");
+Page[2]=new Array("Function-based commands control actions or activities. A function-based command is not always directly related to instrument operation. For example, the bit.bitand() function will perform a logical AND operation on two numbers. Each function consists of a function name followed by a set of parentheses ( ). If the function does not have a parameter, the parentheses are left empty. If the function takes one or more parameters, they are placed between the parentheses and separated by commas.","Example 1","digio.writeport(15)","digio.writebit(3, 0)","reset()","digio.readport()","Sets digital I/O lines 1, 2, 3, and 4 high.","Sets line 3 to low (0).","Returns the instrument to its default settings.","Reads the digital I/O port.","Example 2","You can use the results of a function-based command directly or assign variables to the results for later access. The following code saves the value you enter from the front panel and prints it.","value = display.inputvalue("+0.00")","print(value)","If the operator enters 2.36 from the front panel, the resulting output is: ","2.36000e+00","Functions","13811.html");
+Page[3]=new Array("Attribute-based commands are commands that set the characteristics of an instrument feature or operation. For example, some characteristics of TSP‑enabled instruments are the model number (localnode.model) and the number of errors in the error queue (errorqueue.count).","Attributes","492.html");
+Page[4]=new Array("To set the characteristics, attribute-based commands define a value. For many attributes, the value is in the form of a number or a predefined constant.","Example 1: Set an attribute using a number","format.data = 3","This attribute sets the format of data printed by other commands. Setting this attribute to 3 sets the print format to double precision floating point format.","Example 2: Set an attribute using a constant","format.data = format.REAL64","Using the constant REAL64 instead of 3 also sets the print format to double precision floating point format.","","492.html#o493");
+Page[5]=new Array("To read an attribute, you can use the attribute as the parameter of a function, or assign it to another variable.","Example 3: Read an attribute using a function","print(format.data)","Reads the data format by passing the attribute to the print function. If the data format is set to 3, the output is:","3.00000e+00","This shows that the data format is set to double precision floating point.","Example 4: Read an attribute using a variable","fd = format.data","This reads the data format by assigning the attribute to a variable named fd.","","492.html#o494");
+Page[6]=new Array("Test Script Processor (TSP®) enabled instruments do not have inherent query commands. Like any other scripting environment, the print() command and other related commands generate output in the form of response messages. Each print() command creates one response message.","Example","x = 10","print(x)","Example of an output response message:","1.00000e+01","Note that your output might be different if you set your ASCII precision setting to a different value.","Queries","368.html");
+Page[7]=new Array("If you need information about using scripts with Model 2657A, see Fundamentals of scripting for TSP.","If you need information about using the Lua programming language with Model 2657A, see Fundamentals of programming for TSP.","Information on scripting and programming","17789.html");
+Page[8]=new Array("This section contains an overview of the instrument commands organized into groups, with a brief description of each group. Each section contains links to the detailed command descriptions for each command in the command reference section of this documentation (see Commands).","About remote commands","13401.html");
+Page[9]=new Array("The beeper commands allow you to enable or disable and sound the instrument beeper.","beeper.beep()","beeper.enable","Beeper control","14127.html");
+Page[10]=new Array("The bit functions perform bitwise logic operations on two given numbers, and bit operations on one given number. Logic and bit operations truncate the fractional part of given numbers to make them integers.","Logic operations","The bit.bitand(), bit.bitor(), and bit.bitxor() functions in this group perform bitwise logic operations on two numbers. The Test Script Processor (TSP®) scripting engine performs the indicated logic operation on the binary equivalents of the two integers. This bitwise logic operation is performed on all corresponding bits of the two numbers. The result of a logic operation is returned as an integer.","Bit operations","The rest of the functions in this group are used for operations on the bits of a given number. These functions can be used to:","Clear a bit","Toggle a bit","Test a bit","Set a bit or bit field","Retrieve the weighted value of a bit or field value","All these functions use an index parameter to specify the bit position of the given number. The least significant bit of a given number has an index of 1, and the most significant bit has an index of 32.","@ The Test Script Processor (TSP) scripting engine stores all numbers internally as IEEE Std 754 double-precision floating point values. The logical operations work on 32‑bit integers. Any fractional bits are truncated. For numbers larger than 4294967295, only the lower 32 bits are used.","bit.bitand()","bit.bitor()","bit.bitxor()","bit.clear()","bit.get()","bit.getfield()","bit.set()","bit.setfield()","bit.test()","bit.toggle()","Bit manipulation and logic operations","11382.html");
+Page[11]=new Array("Use the data queue commands to:","Share data between test scripts running in parallel","Access data from a remote group or a local node on a TSP‑Link® network at any time","The data queue in the Test Script Processor (TSP®) scripting engine is first-in, first-out (FIFO).","You can access data from the data queue even if a remote group or a node has overlapped operations in process.","dataqueue.add()","dataqueue.CAPACITY","dataqueue.clear()","dataqueue.count","dataqueue.next()","Data queue","14653.html");
+Page[12]=new Array("The digital I/O port of the Model 2657A can control external circuitry (such as a component handler for binning operations).","The I/O port has 14 lines. Each line can be at TTL logic state 1 (high) or 0 (low). See the pinout diagram in Digital I/O port for additional information.","There are commands to read and write to each individual bit, and commands to read and write to the entire port.","digio.readbit()","digio.readport()","digio.trigger[N].assert()","digio.trigger[N].clear()","digio.trigger[N].EVENT_ID","digio.trigger[N].mode","digio.trigger[N].overrun","digio.trigger[N].pulsewidth","digio.trigger[N].release()","digio.trigger[N].reset()","digio.trigger[N].stimulus","digio.trigger[N].wait()","digio.writebit()","digio.writeport()","digio.writeprotect","Digital I/O","14667.html");
+Page[13]=new Array("display.clear()","display.getannunciators()","display.getcursor()","display.getlastkey()","display.gettext()","display.inputvalue()","display.loadmenu.add()","display.loadmenu.catalog()","display.loadmenu.delete()","display.locallockout","display.menu()","display.numpad","display.prompt()","display.screen","display.sendkey()","display.setcursor()","display.settext()","display.smuX.digits","display.smuX.limit.func","display.smuX.measure.func","display.trigger.clear()","display.trigger.EVENT_ID","display.trigger.overrun","display.trigger.wait()","display.waitkey()","Display","15965.html");
+Page[14]=new Array("When errors and events occur, the error and status messages are placed in the error queue. Use the error queue commands to request error and status message information.","errorqueue.clear()","errorqueue.count","errorqueue.next()","Error queue","14748.html");
+Page[15]=new Array("You can use the event log to view specific details about LAN triggering events.","eventlog.all()","eventlog.clear()","eventlog.count","eventlog.enable","eventlog.next()","eventlog.overwritemethod","Event log","10905.html");
+Page[16]=new Array("You can use the file I/O commands to open and close directories and files, write data, or to read a file on an installed USB flash drive. File I/O commands are organized into two groups:","Commands that reside in the fs and io table, for example: io.open(), io.close(), io.input(), and io.output(). Use these commands to manage file system directories; open and close file descriptors; and perform basic I/O operations on a pair of default files (one input and one output).","Commands that reside in the file descriptors (for example: fileVar:seek(), fileVar:write(), and fileVar:read()) operate exclusively on the file with which they are associated.","The root folder of the USB flash drive has the absolute path:",""/usb1/"","@ Both slash (/) and backslash (\\) are supported as directory separators.","For basic information about navigation and directory listing of files on a flash drive, see File system navigation.","@ File descriptor commands for file I/O use a colon (:) to separate the command parts rather than a period (.), like the io commands.","File descriptors cannot be passed between nodes in a TSP-Link® system, so the io.open(), fileVar::read(), and fileVar::write commands are not accessible to the TSP-Link system. However, the default input and output files mentioned above allow for the execution of many file I/O operations without any reference to a file descriptor.","fileVar:close()","fileVar:flush()","fileVar:read()","fileVar:seek()","fileVar:write()","fs.chdir()","fs.cwd()","fs.is_dir()","fs.is_file()","fs.mkdir()","fs.readdir()","fs.rmdir()","io.close()","io.flush()","io.input()","io.open()","io.output()","io.read()","io.type()","io.write()","os.remove()","os.rename()","The following standard I/O commands are not supported at this time:","File","I/O","fileVar:lines()","fileVar:setvbuf()","io.lines()","io.popen()","File I/O","14771.html");
+Page[17]=new Array("This attribute stores the GPIB address.","gpib.address","GPIB","14859.html");
+Page[18]=new Array("These commands store strings that describe the instrument.","localnode.description","localnode.model","localnode.revision","localnode.serialno","Instrument identification","19423.html");
+Page[19]=new Array("The LAN commands have options that allow you to review and configure network settings.","The lan.config.* commands allow you to configure LAN settings over the remote interface. Note that you must send lan.applysettings() for the configuration settings to take effect.","The lan.status.* commands help you determine the status of the LAN.","The lan.trigger[N].* commands allow you to set up and assert trigger events that are sent over the LAN.","Other LAN commands allow you to reset the LAN, restore defaults, check LXI domain information, and enable or disable the Nagle algorithm.","lan.applysettings()","lan.autoconnect","lan.config.dns.address[N]","lan.config.dns.domain","lan.config.dns.dynamic","lan.config.dns.hostname","lan.config.dns.verify","lan.config.duplex","lan.config.gateway","lan.config.ipaddress","lan.config.method","lan.config.speed","lan.config.subnetmask","lan.linktimeout","lan.lxidomain","lan.nagle","lan.reset()","lan.restoredefaults()","lan.status.dns.address[N]","lan.status.dns.name","lan.status.duplex","lan.status.gateway","lan.status.ipaddress","lan.status.macaddress","lan.status.port.dst","lan.status.port.rawsocket","lan.status.port.telnet","lan.status.port.vxi11","lan.status.speed","lan.status.subnetmask","lan.timedwait","lan.trigger[N].assert()","lan.trigger[N].clear()","lan.trigger[N].connect()","lan.trigger[N].connected","lan.trigger[N].disconnect()","lan.trigger[N].EVENT_ID","lan.trigger[N].ipaddress","lan.trigger[N].mode","lan.trigger[N].overrun","lan.trigger[N].protocol","lan.trigger[N].pseudostate","lan.trigger[N].stimulus","lan.trigger[N].wait()","localnode.description","localnode.password","localnode.passwordmode","LAN and LXI","14129.html");
+Page[20]=new Array("delay()","exit()","localnode.linefreq","localnode.password","localnode.passwordmode","makegetter()","makesetter()","meminfo()","opc()","waitcomplete()","Miscellaneous","19424.html");
+Page[21]=new Array("dataqueue.add()","dataqueue.CAPACITY","dataqueue.clear()","dataqueue.count","dataqueue.next()","node[N].execute()","node[N].getglobal()","node[N].setglobal()","tsplink.group","tsplink.master","tsplink.node","Parallel script execution","19425.html");
+Page[22]=new Array("You can use the print(), printbuffer(), and printnumber() functions to query the instrument and generate response messages. The format attributes control how the data is formatted for the print functions used.","The localnode commands determine if generated errors are automatically sent and if prompts are generated.","format.asciiprecision","format.byteorder","format.data","localnode.prompts","localnode.prompts4882","localnode.showerrors","print()","printbuffer()","printnumber()","Queries and response messages","14795.html");
+Page[23]=new Array("Reading buffers capture measurements, ranges, instrument status, and output states of the Keithley Instruments Model 2657A.","bufferVar.appendmode","bufferVar.basetimestamp","bufferVar.cachemode","bufferVar.capacity","bufferVar.clear()","bufferVar.clearcache()","bufferVar.collectsourcevalues","bufferVar.collecttimestamps","bufferVar.fillcount","bufferVar.fillmode","bufferVar.measurefunctions","bufferVar.measureranges","bufferVar.n","bufferVar.readings","bufferVar.sourcefunctions","bufferVar.sourceoutputstates","bufferVar.sourceranges","bufferVar.sourcevalues","bufferVar.statuses","bufferVar.timestampresolution","bufferVar.timestamps","savebuffer()","smuX.buffer.getstats()","smuX.buffer.recalculatestats()","smuX.makebuffer()","smuX.nvbufferY","smuX.savebuffer()","Reading buffer","17112.html");
+Page[24]=new Array("Resets settings to their default settings.","digio.trigger[N].reset()","lan.reset()","localnode.reset()","reset()","timer.reset()","trigger.blender[N].reset()","trigger.timer[N].reset()","tsplink.trigger[N].reset()","Reset","15061.html");
+Page[25]=new Array("serial.baud","serial.databits","serial.flowcontrol","serial.parity","serial.read()","serial.write()","RS-232","15067.html");
+Page[26]=new Array("Use the saved setups commands to save and restore the configuration of the instrument. You can restore (or save) configurations from the instrument's nonvolatile memory or an installed USB flash drive. You can use the setup.poweron attribute to specify which setup is recalled when the instrument is turned on.","setup.poweron","setup.recall()","setup.save()","Saved setups","19516.html");
+Page[27]=new Array("Scripting helps you combine commands into a block of code that the instrument can run. Scripts help you communicate with the instrument efficiently. These commands describe how to create, load, modify, run, and exit scripts.","exit()","script.anonymous","script.delete()","script.factory.catalog()","script.load()","script.new()","script.newautorun()","script.restore()","script.run()","script.user.catalog()","scriptVar.autorun","scriptVar.list()","scriptVar.name","scriptVar.run()","scriptVar.save()","scriptVar.source","Scripting","15062.html");
+Page[28]=new Array("localnode.linefreq","smuX.abort()","smuX.buffer.getstats()","smuX.buffer.recalculatestats()","smuX.contact.check()","smuX.contact.r()","smuX.contact.speed","smuX.contact.threshold","smuX.makebuffer()","smuX.measure.adc","smuX.measure.autorangeY","smuX.measure.autozero","smuX.measure.count","smuX.measure.delay","smuX.measure.delayfactor","smuX.measure.filter.count","smuX.measure.filter.enable","smuX.measure.filter.type","smuX.measure.interval","smuX.measure.lowrangeY","smuX.measure.nplc","smuX.measure.overlappedY()","smuX.measure.rangeY","smuX.measure.rel.enableY","smuX.measure.rel.levelY","smuX.measure.Y()","smuX.measureYandstep()","smuX.nvbufferY","smuX.reset()","smuX.savebuffer()","smuX.sense","smuX.source.autorangeY","smuX.source.compliance","smuX.source.delay","smuX.source.func","smuX.source.levelY","smuX.source.limitY","smuX.source.lowrangeY","smuX.source.offlimitY","smuX.source.offmode","smuX.source.output","smuX.source.protectv","smuX.source.rangeY","smuX.source.settling","smuX.source.sink","smuX.trigger.arm.count","smuX.trigger.arm.set()","smuX.trigger.arm.stimulus","smuX.trigger.ARMED_EVENT_ID","smuX.trigger.autoclear","smuX.trigger.count","smuX.trigger.endpulse.action","smuX.trigger.endpulse.set()","smuX.trigger.endpulse.stimulus","smuX.trigger.endsweep.action","smuX.trigger.IDLE_EVENT_ID","smuX.trigger.initiate()","smuX.trigger.measure.action","smuX.trigger.measure.set()","smuX.trigger.measure.stimulus","smuX.trigger.measure.Y()","smuX.trigger.MEASURE_COMPLETE_EVENT_ID","smuX.trigger.PULSE_COMPLETE_EVENT_ID","smuX.trigger.source.action","smuX.trigger.source.limitY","smuX.trigger.source.linearY()","smuX.trigger.source.listY()","smuX.trigger.source.logY()","smuX.trigger.source.set()","smuX.trigger.source.stimulus","smuX.trigger.SOURCE_COMPLETE_EVENT_ID","smuX.trigger.SWEEP_COMPLETE_EVENT_ID","smuX.trigger.SWEEPING_EVENT_ID","SMU","15087.html");
+Page[29]=new Array("smuX.cal.adjustdate","smuX.cal.date","smuX.cal.due","smuX.cal.fastadc()","smuX.cal.lock()","smuX.cal.ovp()","smuX.cal.password","smuX.cal.polarity","smuX.cal.restore()","smuX.cal.save()","smuX.cal.state","smuX.cal.unlock()","smuX.contact.calibratehi()","smuX.contact.calibratelo()","smuX.measure.calibrateY()","smuX.source.calibrateY()","SMU calibration","19430.html");
+Page[30]=new Array("The status model is a set of status registers and queues. You can use the following commands to manipulate and monitor these registers and queues to view and control various instrument events.","status.condition","status.measurement.*","status.measurement.buffer_available.*","status.measurement.current_limit.*","status.measurement.instrument.*","status.measurement.instrument.smuX.*","status.measurement.overvoltage.*","status.measurement.reading_overflow.*","status.measurement.sink_limit.*","status.measurement.voltage_limit.*","status.node_enable","status.node_event","status.operation.*","status.operation.calibrating.*","status.operation.instrument.*","status.operation.instrument.digio.*","status.operation.instrument.digio.trigger_overrun.*","status.operation.instrument.lan.*","status.operation.instrument.lan.trigger_overrun.*","status.operation.instrument.smuX.*","status.operation.instrument.smuX.trigger_overrrun.*","status.operation.instrument.trigger_blender.*","status.operation.instrument.trigger_blender.trigger_overrun.*","status.operation.instrument.trigger_timer.*","status.operation.instrument.trigger_timer.trigger_overrun.*","status.operation.instrument.tsplink.*","status.operation.instrument.tsplink.trigger_overrun.*","status.operation.measuring.*","status.operation.remote.*","status.operation.sweeping.*","status.operation.trigger_overrun.*","status.operation.user.*","status.questionable.*","status.questionable.calibration.*","status.questionable.instrument.*","status.questionable.instrument.smuX.*","status.questionable.over_temperature.*","status.questionable.unstable_output.*","status.request_enable","status.request_event","status.reset()","status.standard.*","status.system.*","status.system2.*","status.system3.*","status.system4.*","status.system5.*","Status model","14126.html");
+Page[31]=new Array("bufferVar.basetimestamp","bufferVar.collecttimestamps","bufferVar.timestampresolution","delay()","gettimezone()","settime()","settimezone()","timer.measure.t()","timer.reset()","Time","19432.html");
+Page[32]=new Array("digio.trigger[N].assert()","digio.trigger[N].clear()","digio.trigger[N].EVENT_ID","digio.trigger[N].mode","digio.trigger[N].overrun","digio.trigger[N].pulsewidth","digio.trigger[N].release()","digio.trigger[N].reset()","digio.trigger[N].stimulus","digio.trigger[N].wait()","display.trigger.clear()","display.trigger.EVENT_ID","display.trigger.overrun","display.trigger.wait()","lan.trigger[N].assert()","lan.trigger[N].clear()","lan.trigger[N].connect()","lan.trigger[N].connected","lan.trigger[N].disconnect()","lan.trigger[N].EVENT_ID","lan.trigger[N].ipaddress","lan.trigger[N].mode","lan.trigger[N].overrun","lan.trigger[N].protocol","lan.trigger[N].pseudostate","lan.trigger[N].stimulus","lan.trigger[N].wait()","smuX.trigger.arm.count","smuX.trigger.arm.set()","smuX.trigger.arm.stimulus","smuX.trigger.ARMED_EVENT_ID","smuX.trigger.autoclear","smuX.trigger.count","smuX.trigger.endpulse.action","smuX.trigger.endpulse.set()","smuX.trigger.endpulse.stimulus","smuX.trigger.endsweep.action","smuX.trigger.IDLE_EVENT_ID","smuX.trigger.initiate()","smuX.trigger.measure.action","smuX.trigger.measure.set()","smuX.trigger.measure.stimulus","smuX.trigger.measure.Y()","smuX.trigger.MEASURE_COMPLETE_EVENT_ID","smuX.trigger.PULSE_COMPLETE_EVENT_ID","smuX.trigger.source.action","smuX.trigger.source.limitY","smuX.trigger.source.linearY()","smuX.trigger.source.listY()","smuX.trigger.source.logY()","smuX.trigger.source.set()","smuX.trigger.source.stimulus","smuX.trigger.SOURCE_COMPLETE_EVENT_ID","smuX.trigger.SWEEP_COMPLETE_EVENT_ID","smuX.trigger.SWEEPING_EVENT_ID","trigger.blender[N].clear()","trigger.blender[N].EVENT_ID","trigger.blender[N].orenable","trigger.blender[N].overrun","trigger.blender[N].reset()","trigger.blender[N].stimulus[M]","trigger.blender[N].wait()","trigger.clear()","trigger.EVENT_ID","trigger.timer[N].clear()","trigger.timer[N].count","trigger.timer[N].delay","trigger.timer[N].delaylist","trigger.timer[N].EVENT_ID","trigger.timer[N].overrun","trigger.timer[N].passthrough","trigger.timer[N].reset()","trigger.timer[N].stimulus","trigger.timer[N].wait()","trigger.wait()","tsplink.trigger[N].assert()","tsplink.trigger[N].clear()","tsplink.trigger[N].EVENT_ID","tsplink.trigger[N].mode","tsplink.trigger[N].overrun","tsplink.trigger[N].pulsewidth","tsplink.trigger[N].release()","tsplink.trigger[N].reset()","tsplink.trigger[N].stimulus","tsplink.trigger[N].wait()","Triggering","19433.html");
+Page[33]=new Array("These functions and attributes allow you to set up and work with a system that is connected by a TSP‑Link® network.","tsplink.group","tsplink.master","tsplink.node","tsplink.readbit()","tsplink.readport()","tsplink.reset()","tsplink.state","tsplink.trigger[N].assert()","tsplink.trigger[N].clear()","tsplink.trigger[N].EVENT_ID","tsplink.trigger[N].mode","tsplink.trigger[N].overrun","tsplink.trigger[N].pulsewidth","tsplink.trigger[N].release()","tsplink.trigger[N].reset()","tsplink.trigger[N].stimulus","tsplink.trigger[N].wait()","tsplink.writebit()","tsplink.writeport()","tsplink.writeprotect","TSP-Link","14123.html");
+Page[34]=new Array("The TSP-Net module provides a simple socket-like programming interface to Test Script Processor (TSP®) enabled instruments.","tspnet.clear()","tspnet.connect()","tspnet.disconnect()","tspnet.execute()","tspnet.idn()","tspnet.read()","tspnet.readavailable()","tspnet.reset()","tspnet.termination()","tspnet.timeout","tspnet.tsp.abort()","tspnet.tsp.abortonconnect","tspnet.tsp.rbtablecopy()","tspnet.tsp.runscript()","tspnet.write()","TSP-Net","14072.html");
+Page[35]=new Array("Use the functions in this group to store and retrieve user-defined strings in nonvolatile memory. These strings are stored as key‑value pairs. You can use the userstring functions to store custom, instrument-specific information in the instrument, such as department number, asset number, or manufacturing plant location.","userstring.add()","userstring.catalog()","userstring.delete()","userstring.get()","Userstrings","14033.html");
+Page[36]=new Array("The Keithley Instruments Model 2657A High Power System SourceMeter® instrument is shipped with one or more factory scripts saved in its flash firmware memory. A factory script is made up of a number of functions. Some of them can be called from the front‑panel LOAD TEST menu. All of them can be called using remote programming.","As Keithley Instruments develops additional factory scripts, they will be made available on the Keithley Instruments website as a flash firmware upgrade for the Model 2657A. See Upgrading the firmware for instructions on upgrading the flash firmware of your Model 2657A instrument.","A factory script is similar to a user script, except a factory script is created by Keithley Instruments at the factory and is permanently stored in nonvolatile memory. The differences between a user script and a factory script include the following:","A factory script cannot be deleted from nonvolatile memory.","The script listing for a factory script can be retrieved and modified, but it will then be treated as a user script. A user script cannot be saved as a factory script.","Factory scripts are not stored in global variables. The only references to factory scripts are in the script.factory.scripts attribute.","The script.factory.catalog() function returns an iterator that can be used in a for loop to iterate over all the factory scripts.","Example","To retrieve the catalog listing for factory scripts, send:","for name in script.factory.catalog() do print(name) end","Introduction","12912.html");
+Page[37]=new Array("Use either of the following commands to run a factory script:","script.factory.scripts.name() script.factory.scripts.name.run()","Where: name is the name of the factory script.","Example:","Run the factory script named “KIPulse”","script.factory.scripts.KIPulse()","Running a factory script","12913.html");
+Page[38]=new Array("Press the LOAD key.","Select FACTORY.","Select the function to run and press the ENTER key or navigation wheel @.","Press the RUN key.","Running a factory script function from the Model 2657A front panel controls","12914.html");
+Page[39]=new Array("The script listing for a factory script can be retrieved and modified. However, it cannot be saved as a factory script. The modified script can be saved as a user script using the same name or a new name.","An imported factory script can only be loaded back into the Model 2657A as a user script.","The following function retrieves a script listing. The script code is output with the shell keywords (loadscript or loadandrunscript, and endscript):","script.factory.scripts.name.list()","Where: name is the name of the factory script.","Example:","Retrieve the script listing for a factory script named “KIPulse”:","script.factory.scripts.KIPulse.list()","Retrieving and modifying a factory script listing","12194.html");
+Page[40]=new Array("The KISweep factory script provides simple sweep test programming and shows how to use the sweeping function.","This script is made up of the following functions. Access these functions from the front panel or the remote interfaces. The following functions make up the KISweep factory script:","SweepILinMeasureV()","SweepVLinMeasureI()","SweepILogMeasureV()","SweepVLogMeasureI()","SweepIListMeasureV()","SweepVListMeasureI()","KISweep factory script","12175.html");
+Page[41]=new Array("The KIPulse factory script provides examples of how to generate pulses and to provide a simple pulsing interface. Pulses can be generated using the functions listed below.","@ Please note the following information about the KIPulse factory script:
Ÿ This factory script only operates on the channels present in the instrument executing the pulse functions. These functions will not operate correctly if you attempt to access instrument channels over the TSP‑Link® interface.
Ÿ The KIPulse factory scripts are general purpose examples that may not be suitable for all use cases. Very short pulses (less than 1ms pulse width) may require optimization of the examples provided by the factory script in order to achieve settled measurements.
Ÿ The PulseIMeasureV() and PulseVMeasureI() functions may be accessed from the front panel. The remaining functions may only be accessed remotely.","Use the configuration KIPulse tag parameter pulse functions to configure a pulse train and assign the configuration to the tag parameter (use QueryPulseConfig() to inspect configured pulse trains). Use the initiation InitiatePulseTest() function to execute the pulse trains assigned to its tag arguments. The conditions listed in the table below must be true for these functions to execute successfully.","Use the KIPulse simple pulse functions to specify and perform a specified number of pulse-measure cycles.","The following functions make up the KIPulse factory script:","KIPulse factory script","12916.html");
+Page[42]=new Array("ConfigPulseIMeasureV()","ConfigPulseVMeasureI()","ConfigPulseIMeasureVSweepLin()","ConfigPulseVMeasureISweepLin()","ConfigPulseIMeasureVSweepLog()","ConfigPulseVMeasureISweepLog()","QueryPulseConfig()","InitiatePulseTest()","KIPulse tag parameter pulse functions","19518.html");
+Page[43]=new Array("PulseIMeasureV()","PulseVMeasureI()","KIPulse simple pulse functions","19519.html");
+Page[44]=new Array("Variable off time between pulses in a pulse train","The KIPulse “Configure” functions will accept the toff parameter as a table, or as a number. The table allows you to define different off times to be used after each pulse. The following should be noted:","If toff is passed as a number or only a single value is used in the table, it will be used for all points in a multiple point pulse.","The number of times specified in the table must match the number of points called for in the sweep.","The times used in tables must match for dual channel pulsing.","Each specified off time must adhere to the duty cycle limits for the specified pulsing region.","Simultaneous IV measurement during pulse","The KIPulse “Configure” functions will optionally accept an extra reading buffer to activate simultaneous IV measurements during pulsing. Previous usage of passing in a reading buffer or a nil (for no measurement) is still supported.","Advanced features for KIPulse tag parameter pulse functions","19514.html");
+Page[45]=new Array("The KIHighC factory script is made up of two functions: i_leakage_measure() and i_leakage_threshold(). Output is generally at a non-zero voltage prior to calling these functions. These functions can also be used to step the voltage to zero volts in order to measure the leakage current.","i_leakage_measure()","i_leakage_threshold()","KIHighC factory script","12950.html");
+Page[46]=new Array("The KIParlib factory script is made up of two functions: gm_vsweep() and gm_isweep().","gm_vsweep()","gm_isweep()","KIParlib factory script","12954.html");
+Page[47]=new Array("The KISavebuffer script has one function: savebuffer().","savebuffer()","KISavebuffer factory script","12958.html");
+Page[48]=new Array("This manual uses italicized text to represent the parts of remote commands that must be replaced by user specified values. The following examples show typical uses of italicized text: ","Example 1:","gpib.address = address","Where:","address is an integer (0 to 30) that you specify. For example, to set this attribute to 15 you would send:","gpib.address = 15","Example 2:","digio.trigger[N].assert()","Where:","N is an integer (1 to 14) that you specify. For example, to assert trigger line 7 you would send:","digio.trigger[7].assert()","To assert a trigger line with a variable as the integer, you would send:","triggerline = 7","digio.trigger[triggerline].assert()","Example 3:","smuX.trigger.measure.Y(rbuffer)","Where: ","X refers to the source‑measure unit (SMU) channel (use a for SMU A).","Y is the measurement type that you specify (v, i, r, or p). ","rbuffer is the reading buffer object where the readings will be stored. ","For example, to use SMU A to take voltage measurements and store them in buffer vbuffername, you would send:","smua.trigger.measure.v(vbuffername)","Placeholder text","17859.html");
+Page[49]=new Array("The following table lists syntax requirements to build well-formed instrument control commands.","Syntax rules for instrument commands","Syntax rule","Details","Examples","Case sensitivity: Instrument commands are case sensitive. ","For best results, simply match the case shown in the command reference descriptions.","Function and attribute names should be in lowercase characters.","An example of the scriptVar.save() function (where test8 is the name of the script):","test8.save()","Parameters can use a combination of lowercase and uppercase characters.","Attribute constants use uppercase characters","In the command below, which sets the format of data transmitted from the instrument to double‑precision floating point, format.REAL64 is the attribute constant and format.data is the attribute command:","format.data = format.REAL64","White space: Not required in a function.","Functions can be sent with or without white spaces.","The following functions, which set digital I/O line 3 low, are equivalent:","digio.writebit(3,0)","digio.writebit (3, 0)","Function parameters: All functions are required to have a set of parentheses () immediately following the function.","You can specify the function parameters by placing them between the parentheses. Note that the parentheses are required even when there are no parameters specified.","The following function specifies all overlapped commands in the nodes in group G must complete before commands from other groups can execute:","waitcomplete(G)","The command below reads the value of the local time zone (no parameters are needed):","timezone = localnode.gettimezone()","Multiple parameters: Must be separated by commas (,).","Some commands require multiple parameters, which must be separated by commas (,).","This command sets the beeper to emit a double‑beep at 2400 Hz, with a beep sequence of 0.5 seconds on, 0.25 seconds off, and then 0.5 seconds on:","beeper.beep(0.5, 2400)","delay(0.250)","beeper.beep(0.5, 2400)","Syntax rules","17860.html");
+Page[50]=new Array("Time and date values are represented as the number of seconds since some base. Representing time as a number of seconds is referred to as “standard time format.” There are three time bases:","UTC 12:00 am Jan 1, 1970. Some examples of UTC time are reading buffer base timestamps, adjustment dates, and the value returned by os.time().","Instrument on. References time to when the instrument was turned on. The value returned by os.clock() is referenced to the turn-on time.","Event. Time referenced to an event, such as the first reading stored in a reading buffer.","Time and date values","12044.html");
+Page[51]=new Array("The Model 2657A can be in either the local state or the remote state. When in the local state (REM indicator off), the instrument is operated using the front panel controls. When in the remote state (REM indicator on), instrument operation is being controlled by the PC. When the instrument is powered-on, it will be in the local state.","Remote versus local state","12906.html");
+Page[52]=new Array("The following actions will place the instrument in the remote state:","Sending a command from the PC to the instrument.","Running a script (FACTORY or USER test) from the front panel. After the test is completed, the instrument will return to the local mode.","Opening communications between the instrument and Test Script Builder.","While in the remote state, front panel controls are disabled. However, the LOCAL key will be active if it has not been locked out. When an interactive script is running, the front panel controls will be active to allow the operator to input parameter values.","The OUTPUT ON/OFF control is always active. If it is pressed when the instrument is in the remote state, the instrument will turn the output off (if it is on) and return to the local state.","Remote state","12040.html");
+Page[53]=new Array("The following actions will cancel the remote state and return the instrument to the local state:","Cycling power for the instrument.","Pressing the OUTPUT ON/OFF control.","Pressing front panel LOCAL key (if it is not locked out).","Sending the abort command from the PC.","Clicking the Abort Execution icon on the toolbar of the Instrument Console for Test Script Builder.","After a front panel script (FACTORY or USER test) is completed, the instrument will return to the local state.","Local state","12034.html");
+Page[54]=new Array("The command reference contains detailed descriptions of each of the commands you can use to control your Model 2657A. Each command description is broken into several standardized subsections. The figure below shows an example of a command description.","Each command listing is divided into five major categories of information about the command:","Command name and summary table","Usage","Details","Example","Also see","The content of each of these categories is described in the following topics.","Using the command reference","17852.html");
+Page[55]=new Array("Each instrument command description starts with the command name, followed by a table with relevant information for each command. Definitions for the numbered items in the figure below are listed following the figure.","Instrument command name. Signals the beginning of the command description and is followed by a brief description of what the command does.","Type of command. Options are:","Function. Function-based commands control actions or activities, but are not always directly related to instrument operation. Function names are always followed by a set of parentheses, for example, digio.writeport(15). If the function does not need a parameter, the parentheses set remains empty, for example, exit().","Attribute (R), (RW), or (W). Attribute-based commands set or read the characteristics of an instrument feature or operation by defining a value. For example, a characteristic of a TSP‑enabled instrument is the model number (localnode.model); another characteristic is the number of errors in the error queue (errorqueue.count). For many attributes, the defined value is a number or predefined constant. Attributes can be read-only (R), read-write (RW), or write-only (W), and can be used as a parameter of a function or assigned to another variable.","Constant. A constant command represents a fixed value when used in a script.","TSP-Link accessible. Yes or No; indicates whether or not the command can accessed through a TSP-Link network.","Affected by. Commands or actions that have a direct effect on the instrument command.","LAN restore defaults","Recall setup","Instrument reset: An instrument reset can be invoked by reset(), localnode.reset(), or *RST.","Where saved. Indicates where the command settings reside once they are used on an instrument. Options include:","Not saved: Command is not saved anywhere and must be typed each time you use it.","Nonvolatile memory: Storage area in the instrument where information is saved when the instrument is turned off. ","Saved setup","Default value: Lists the default value or constant for the command. The parameter values are defined in the Usage or Details sections of the command description.","Command name and summary table","17853.html");
+Page[56]=new Array("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: 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 usage","17854.html");
+Page[57]=new Array("This section lists additional information you need to know to successfully use the remote commands.","Command details","17855.html");
+Page[58]=new Array("The Example section of the remote command description shows some simple examples of how the command can be used.","Actual example code that you can copy from this table and paste into your own programming application.","Description of the code and what it does. This may also contain the output of the code.","Example section","17856.html");
+Page[59]=new Array("The Also see section of the remote command description lists commands that are related to the command being described.","Related commands and information","17857.html");
+Page[60]=new Array("This function generates an audible tone.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","beeper.beep(duration, frequency)","duration","The amount of time to play the tone in seconds; the allowable range is 0.1 s to 100 s","frequency","The frequency of the tone in Hertz (Hz)","Details","The beeper will not sound if it is disabled. It can be disabled or enabled with the beeper.enable attribute, or through the front‑panel Main Menu.","Example","beeper.enable = beeper.ON","beeper.beep(2, 2400)","Enables the beeper and generates a two‑second, 2400 Hz tone.","Also see","beeper.enable","beeper.beep()","18841.html");
+Page[61]=new Array("This attribute allows you to turn the beeper on or off.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Recall setup Instrument reset","Saved setup","1 (beeper.ON)","Usage","state = beeper.enable","beeper.enable = state","state","Disable the beeper (beeper.OFF or 0)","Enable the beeper (beeper.ON or 1)","Details","Disabling the beeper also disables front‑panel key clicks.","Example","beeper.enable = beeper.ON","beeper.beep(2, 2400)","Enables the beeper and generates a two‑second, 2400 Hz tone.","Also see","beeper.beep()","beeper.enable","14435.html");
+Page[62]=new Array("This function performs a bitwise logical AND operation on two numbers.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","result = bit.bitand(value1, value2)","result","Result of the logical AND operation","value1","Operand for the logical AND operation","value2","Operand for the logical AND operation","Details","Any fractional parts of value1 and value2 are truncated to form integers. The returned result is also an integer.","Example","testResult = bit.bitand(10, 9)","print(testResult)","Performs a logical AND operation on decimal 10 (binary 1010) with decimal 9 (binary 1001), which returns a value of decimal 8 (binary 1000).","Output:","8.00000e+00","Also see","bit.bitor()","bit.bitxor()","Logical operators","bit.bitand()","14632.html");
+Page[63]=new Array("This function performs a bitwise logical OR operation on two numbers.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","result = bit.bitor(value1, value2)","result","Result of the logical OR operation","value1","Operand for the logical OR operation","value2","Operand for the logical OR operation","Details","Any fractional parts of value1 and value2 are truncated to make them integers. The returned result is also an integer.","Example","testResult = bit.bitor(10, 9)","print(testResult)","Performs a bitwise logical OR operation on decimal 10 (binary 1010) with decimal 9 (binary 1001), which returns a value of decimal 11 (binary 1011).","Output: 1.10000e+01","Also see","bit.bitand()","bit.bitxor()","Logical operators","bit.bitor()","14634.html");
+Page[64]=new Array("This function performs a bitwise logical XOR (exclusive OR) operation on two numbers.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","result = bit.bitxor(value1, value2)","result","Result of the logical XOR operation","value1","Operand for the logical XOR operation","value2","Operand for the logical XOR operation","Details","Any fractional parts of value1 and value2 are truncated to make them integers. The returned result is also an integer.","Example","testResult = bit.bitxor(10, 9)","print(testResult)","Performs a logical XOR operation on decimal 10 (binary 1010) with decimal 9 (binary 1001), which returns a value of decimal 3 (binary 0011).","Output:","3.00000e+00","Also see","bit.bitand()","bit.bitor()","Logical operators","bit.bitxor()","14635.html");
+Page[65]=new Array("This function clears a bit at a specified index position.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","result = bit.clear(value, index)","result","Result of the bit manipulation","value","Specified number","index","One‑based bit position within value to clear (1 to 32)","Details","Any fractional part of value is truncated to make it an integer. The returned result is also an integer.","The least significant bit of value is at index position 1; the most significant bit is at index position 32.","Example","testResult = bit.clear(15, 2)","print(testResult)","The binary equivalent of decimal 15 is 1111. If you clear the bit at index position 2, the returned decimal value is 13 (binary 1101).","Output:","1.30000e+01","Also see","bit.get()","bit.set()","bit.test()","bit.toggle()","Logical operators","bit.clear()","14636.html");
+Page[66]=new Array("This function retrieves the weighted value of a bit at a specified index position.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","result = bit.get(value, index)","result","Result of the bit manipulation","value","Specified number","index","One‑based bit position within value to get (1 to 32)","Details","This function returns the value of the bit in value at index. This is the same as returning value with all other bits set to zero (0).","The least significant bit of value is at index position 1; the most significant bit is at index position 32.","If the indexed bit for the number is set to zero (0), the result will be zero (0).","Example","testResult = bit.get(10, 4)","print(testResult)","The binary equivalent of decimal 10 is 1010. If you get the bit at index position 4, the returned decimal value is 8.","Output:","8.00000e+00","Also see","bit.clear()","bit.set()","bit.test()","bit.toggle()","Logical operators","bit.get()","14637.html");
+Page[67]=new Array("This function returns a field of bits from the value starting at the specified index position.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","result = bit.getfield(value, index, width)","result","Result of the bit manipulation","value","Specified number","index","One‑based bit position within value to get (1 to 32)","width","The number of bits to include in the field (1 to 32)","Details","A field of bits is a contiguous group of bits. This function retrieves a field of bits from value starting at index.","The index position is the least significant bit of the retrieved field. The number of bits to return is specified by width.","The least significant bit of value is at index position 1; the most significant bit is at index position 32.","Example","myResult = bit.getfield(13, 2, 3)","print(myResult)","The binary equivalent of decimal 13 is 1101. ","The field at index position 2 and width 3 consists of the binary bits 110. The returned value is decimal 6 (binary 110).","Output:","6.00000e+00","Also see","bit.get()","bit.set()","bit.setfield()","Logical operators","bit.getfield()","14638.html");
+Page[68]=new Array("This function sets a bit at the specified index position.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","result = bit.set(value, index)","result","Result of the bit manipulation","value","Specified number","index","One‑based bit position within value to set (1 to 32)","Details","This function returns result, which is value with the indexed bit set. The index must be between 1 and 32.","The least significant bit of value is at index position 1; the most significant bit is at index position 32.","Any fractional part of value is truncated to make it an integer.","Example","testResult = bit.set(8, 3)","print(testResult)","The binary equivalent of decimal 8 is 1000. If the bit at index position 3 is set to 1, the returned value is decimal 12 (binary 1100).","Output:","1.20000e+01","Also see","bit.clear()","bit.get()","bit.getfield()","bit.setfield()","bit.test()","bit.toggle()","Logical operators","bit.set()","14639.html");
+Page[69]=new Array("This function overwrites a bit field at a specified index position.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","result = bit.setfield(value, index, width, fieldValue)","result","Result of the bit manipulation","value","Specified number","index","One‑based bit position in value to set (1 to 32)","width","The number of bits to include in the field (1 to 32)","fieldValue","Value to write to the field","Details","This function returns result, which is value with a field of bits overwritten, starting at index. The index specifies the position of the least significant bit of value. The width bits starting at index are set to fieldValue.","The least significant bit of value is at index position 1; the most significant bit is at index position 32.","Before setting the field of bits, any fractional parts of value and fieldValue are truncated to form integers.","If fieldValue is wider than width, the most significant bits of the fieldValue that exceed the width are truncated. For example, if width is 4 bits and the binary value for fieldValue is 11110 (5 bits), the most significant bit of fieldValue is truncated and a binary value of 1110 is used.","Example","testResult = bit.setfield(15, 2, 3, 5)","print(testResult)","The binary equivalent of decimal 15 is 1111. After overwriting it with a decimal 5 (binary 101) at index position 2, the returned value is decimal 11 (binary 1011).","Output:","1.10000e+01","Also see","bit.get()","bit.set()","bit.getfield()","Logical operators","bit.setfield()","14640.html");
+Page[70]=new Array("This function returns the Boolean value (true or false) of a bit at the specified index position.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","result = bit.test(value, index)","result","Result of the bit manipulation","value","Specified number","index","One‑based bit position within value to test (1 to 32)","Details","This function returns result, which is the result of the tested bit. ","The least significant bit of value is at index position 1; the most significant bit is at index position 32.","If the indexed bit for value is 0, result is false. If the bit of value at index is 1, the returned value is true.","If index is bigger than the number of bits in value, the result is false.","Example","testResult = bit.test(10, 4)","print(testResult)","The binary equivalent of decimal 10 is 1010. Testing the bit at index position 4 returns a Boolean value of true.","Output:","true","Also see","bit.clear()","bit.get()","bit.set()","bit.toggle()","Logical operators","bit.test()","14641.html");
+Page[71]=new Array("This function toggles the value of a bit at a specified index position.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","result = bit.toggle(value, index)","result","Result of the bit manipulation","value","Specified number","index","One‑based bit position within value to toggle (1 to 32)","Details","This function returns result, which is the result of toggling the bit index in value.","Any fractional part of value is truncated to make it an integer. The returned value is also an integer.","The least significant bit of value is at index position 1; the most significant bit is at index position 32.","The indexed bit for value is toggled from 0 to 1, or 1 to 0.","Example","testResult = bit.toggle(10, 3)","print(testResult)","The binary equivalent of decimal 10 is 1010. Toggling the bit at index position 3 returns a decimal value of 14 (binary 1110).","Output:","1.40000e+01","Also see","bit.clear()","bit.get()","bit.set()","bit.test()","Logical operators","bit.toggle()","14642.html");
+Page[72]=new Array("This attribute sets the state of the reading buffer's append mode.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Not applicable","See Details","0 (disabled)","Usage","state = bufferVar.appendmode","bufferVar.appendmode = state","state","The reading buffer append mode; set to one of the following:","0: Append mode off; new measure data overwrites the previous buffer content","1: Append mode on; appends new measure data to the present buffer content","bufferVar","The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer","Details","Assigning a value to this attribute enables or disables the buffer append mode. This value can only be changed with an empty buffer. Use bufferVar.clear() to empty the buffer.","For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.","If the append mode is set to 0, any stored readings in the buffer are cleared before new ones are stored. If append mode is set to 1, any stored readings remain in the buffer and new readings are added to the buffer after the stored readings.","With append mode on, the first new measurement is stored at rb[n+1], where n is the number of readings stored in buffer rb.","Example","buffer1.appendmode = 1","Append new readings to contents of the reading buffer named buffer1.","Also see","bufferVar.clear()","Reading buffers","bufferVar.appendmode","15127.html");
+Page[73]=new Array("This attribute contains the timestamp of when the first reading was stored in the buffer.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","See Details","0","Usage","basetime = bufferVar.basetimestamp","basetime","The timestamp of the first stored reading","bufferVar","The reading buffer; can be a dynamically allocated buffer (user‑defined), or a dedicated reading buffer (such as smua.nvbuffer1)","Details","This read-only attribute contains the timestamp (in seconds) of the first reading stored in a buffer (rb[1] stored in reading buffer rb). The timestamp is the number of seconds since 12:00 AM January 1, 1970 (UTC) that the measurement was performed and stored.","For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.","See the smuX.nvbufferY attribute for details on accessing dedicated reading buffers.","Example","basetime = smua.nvbuffer1.basetimestamp","print(basetime)","Read the timestamp for the first reading","stored in dedicated reading buffer 1.","Output: 1.2830e+09","The above output indicates that the timestamp is 1,283,000,000 seconds (which is Saturday, August 28, 2010 at 12:53:20 PM).","Also see","smuX.measure.overlappedY()","smuX.measure.Y()","smuX.nvbufferY","smuX.trigger.measure.Y()","Reading buffers","bufferVar.basetimestamp","15128.html");
+Page[74]=new Array("This attribute enables or disables the reading buffer cache (on or off).","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Not applicable","Not saved","1 (enabled)","Usage","cacheMode = bufferVar.cachemode","bufferVar.cachemode = cacheMode","cacheMode","The reading buffer cache mode; set to one of the following:","0: Cache mode disabled (off)","1: Cache mode enabled (on)","bufferVar","The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer","Details","Assigning a value to this attribute enables or disables the reading buffer cache. When enabled, the reading buffer cache improves access speed to reading buffer data. ","If you run successive operations that overwrite reading buffer data, the reading buffer may return stale cache data. This can happen when initiating successive sweeps without reconfiguring the sweep measurements or when overwriting data in the reading buffer by setting the bufferVar.fillmode attribute to smuX.FILL_WINDOW. To avoid this, make sure that you include commands that automatically invalidate the cache as needed (for example, explicit calls to the bufferVar.clearcache() function) or disable the cache using this attribute (bufferVar.cachemode).","Example","smua.nvbuffer1.cachemode = 1","Enables reading buffer cache of dedicated reading buffer 1.","Also see","bufferVar.clearcache()","bufferVar.fillmode","bufferVar.cachemode","17109.html");
+Page[75]=new Array("This attribute contains the capacity of the buffer.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","See Details","Not applicable","Usage","bufferCapacity = bufferVar.capacity","bufferCapacity","The maximum number of readings the buffer can store","bufferVar","The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer","Details","This read-only attribute reads the number of readings that can be stored in the buffer.","For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.","The buffer's capacity does not change as readings fill the buffer. A dedicated reading buffer that only collects basic items can store over 140,000 readings. Turning on additional collection items, such as timestamps and source values, decreases the capacity of a dedicated reading buffer (for example, smua.nvbuffer1), but does not change the capacity of a user-defined dynamically allocated buffer. A user-defined dynamically allocated buffer has a fixed capacity that is set when the buffer is created.","See the smuX.nvbufferY attribute for details on accessing dedicated reading buffers. See the smuX.makebuffer() function for information on creating user-defined dynamically allocated reading buffers.","Example","bufferCapacity = smua.nvbuffer1.capacity","print(bufferCapacity)","Reads the capacity of dedicated reading buffer 1.","Output: ","1.49789e+05","The above output indicates that the buffer can hold 149789 readings.","Also see","Reading buffers","smuX.makebuffer()","smuX.measure.overlappedY()","smuX.measure.Y()","smuX.nvbufferY","smuX.trigger.measure.Y()","bufferVar.capacity","15129.html");
+Page[76]=new Array("This function clears the buffer.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","bufferVar.clear()","bufferVar","The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer","Details","This function clears all readings and associated recall attributes (for example, bufferVar.timestamps and bufferVar.statuses) from the specified buffer.","Example","smua.nvbuffer1.clear()","Clears dedicated reading buffer 1.","Also see","smuX.nvbufferY","Reading buffers","bufferVar.clear()","15130.html");
+Page[77]=new Array("This function clears the cache.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","bufferVar.clearcache()","bufferVar","The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer","Details","This function clears all readings from the specified cache. ","If you run successive operations that overwrite reading buffer data, the reading buffer may return stale cache data. This can happen when:","Initiating successive sweeps without reconfiguring the sweep measurements. Watch for this when running Lua code remotely on more than one node, because values in the reading buffer cache may change while the Lua code is running.","Overwriting data in the reading buffer by setting the bufferVar.fillmode attribute to smuX.FILL_WINDOW. ","To avoid this, you can include explicit calls to the bufferVar.clearcache() function to remove stale values from the reading buffer cache.","Example","smua.nvbuffer1.clearcache()","Clears the reading buffer cache for dedicated reading buffer 1.","Also see","bufferVar.fillmode","smuX.nvbufferY","Reading buffers","Removing stale values from the reading buffer cache","bufferVar.clearcache()","15131.html");
+Page[78]=new Array("This attribute sets whether or not source values will be stored with the readings in the buffer.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Not applicable","See Details","0 (disabled)","Usage","state = bufferVar.collectsourcevalues","bufferVar.collectsourcevalues = state","state","Source value collection status; set to one of the following:","0: Source value collection disabled (off)","1: Source value collection enabled (on)","bufferVar","The reading buffer; can be a dynamically allocated buffer (user‑defined), or a dedicated reading buffer (such as smua.nvbuffer1)","Details","Assigning a value to this attribute enables or disables the storage of source values. Reading this attribute returns the state of source value collection. This value can only be changed with an empty buffer. Empty the buffer using the bufferVar.clear() function.","For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.","When on, source values will be stored with readings in the buffer. This requires four extra bytes of storage per reading. Turning on additional collection items, such as source values (this attribute) and timestamps, decreases the capacity of a dedicated reading buffer (for example, smua.nvbuffer1), but does not change the capacity of a user-defined dynamically allocated buffer.","Example","smua.nvbuffer1.collectsourcevalues = 1","Include source values with readings for dedicated reading buffer 1.","Also see","bufferVar.clear()","smuX.measure.overlappedY()","smuX.measure.Y()","smuX.nvbufferY","smuX.trigger.measure.Y()","Reading buffers","bufferVar.collectsourcevalues","15132.html");
+Page[79]=new Array("This attribute sets whether or not timestamp values will be stored with the readings in the buffer.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Not applicable","See Details","0 (disabled)","Usage","state = bufferVar.collecttimestamps","bufferVar.collecttimestamps = state","state","Timestamp value collection status; set to one of the following:","0: Timestamp value collection disabled (off)","1: Timestamp value collection enabled (on)","bufferVar","The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer","Details","Assigning a value to this attribute enables or disables the storage of timestamps. Reading this attribute returns the state of timestamp collection. ","For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.","When on, timestamp values will be stored with readings in the buffer. This requires four extra bytes of storage per reading. Turning on additional collection items, such as timestamps (this attribute) and source values, decreases the capacity of a dedicated reading buffer (for example, smua.nvbuffer1), but does not change the capacity of a user-defined dynamically allocated buffer.","This value, off (0) or on (1), can only be changed when the buffer is empty. Empty the buffer using the bufferVar.clear() function.","Example","smua.nvbuffer1.collecttimestamps = 1","Include timestamps with readings for dedicated reading buffer 1.","Also see","bufferVar.clear()","smuX.measure.overlappedY()","smuX.measure.Y()","smuX.nvbufferY","smuX.trigger.measure.Y()","Reading buffers","bufferVar.collecttimestamps","15133.html");
+Page[80]=new Array("This attribute sets the reading buffer fill count.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Not applicable","See Details","0","Usage","fillCount = bufferVar.fillcount","bufferVar.fillcount = fillCount","fillCount","The reading buffer fill count","bufferVar","The reading buffer; can be a dynamically allocated buffer (user‑defined), or a dedicated reading buffer (such as smua.nvbuffer1)","Details","The reading buffer fill count sets the number of readings to store before restarting at index 1. If the value is zero (0), then the capacity of the buffer is used. Use this attribute to control when the SMU restarts filling the buffer at index 1, rather than having it restart when the buffer is full. ","If the bufferVar.fillcount attribute is set to a value higher than the capacity of the buffer, after storing the element at the end of the buffer, the SMU will overwrite the reading at index 1, the reading after that will overwrite the reading at index 2, and so on.","This attribute is only used when the bufferVar.fillmode attribute is set to smuX.FILL_WINDOW.","For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.","Example","smua.nvbuffer1.fillcount = 50","Sets fill count of dedicated reading buffer 1 to 50.","Also see","bufferVar.fillmode","bufferVar.fillcount","18551.html");
+Page[81]=new Array("This attribute sets the reading buffer fill mode.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Not applicable","See Details","0 (smuX.FILL_ONCE)","Usage","fillMode = bufferVar.fillmode","bufferVar.fillmode = fillMode","fillMode","The reading buffer fill mode; set to one of the following:","0 or smuX.FILL_ONCE: Do not overwrite old data","1 or smuX.FILL_WINDOW: New readings restart at index 1 after acquiring reading at index bufferVar.fillcount","bufferVar","The reading buffer; can be a dynamically allocated buffer (user‑defined), or a dedicated reading buffer (such as smua.nvbuffer1)","Details","When this attribute is set to smuX.FILL_ONCE, the reading buffer will not overwrite readings. If the buffer fills up, new readings will be discarded. ","When this attribute is set to smuX.FILL_WINDOW, new readings will be added after existing data until the buffer holds bufferVar.fillcount elements. Continuing the sequence, the next reading will overwrite the reading at index 1, the reading after that will overwrite the reading at index 2, and so on. ","For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.","Example","smua.nvbuffer1.fillmode = smua.FILL_ONCE","Sets fill mode of dedicated reading buffer 1 to fill once (do not overwrite old data).","Also see","bufferVar.fillcount","bufferVar.fillmode","18552.html");
+Page[82]=new Array("This attribute contains the measurement function that was used to acquire a reading stored in a specified reading buffer.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Clearing the buffer","See Details","Not applicable","Usage","measurefunction = bufferVar.measurefunctions[N]","measurefunction","The measurement function used ("current", "voltage", "ohms", or "watts") to acquire reading number N in the specified buffer","bufferVar","The reading buffer; can be a dynamically allocated buffer (user‑defined), or a dedicated reading buffer (such as smua.nvbuffer1)","N","The reading number (1 to bufferVar.n)","Details","The measurefunctions buffer recall attribute is like an array (a Lua table) of strings indicating the function measured for the reading.","For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.","Example 1","measurefunction = smua.nvbuffer1.measurefunctions[5]","Store the measure function used to make reading number 5.","Example 2","printbuffer(1, 5, smua.nvbuffer1.measurefunctions)","Print the measurement function that was used to measure the first five readings saved in dedicated reading buffer 1. Example output:","Current, Current, Current, Current, Current","Also see","bufferVar.measureranges","bufferVar.n","bufferVar.readings","bufferVar.sourcefunctions","bufferVar.sourceoutputstates","bufferVar.sourceranges","bufferVar.sourcevalues","bufferVar.statuses","bufferVar.timestamps","bufferVar.measurefunctions","19914.html");
+Page[83]=new Array("This attribute contains the measurement range values that were used for readings stored in a specified buffer.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Clearing the buffer","See Details","Not applicable","Usage","measurerange = bufferVar.measureanges[N]","measurerange","The measurement range used to acquire reading number N in the specified buffer","bufferVar","The reading buffer; can be a dynamically allocated buffer (user‑defined), or a dedicated reading buffer (such as smua.nvbuffer1)","N","The reading number (1 to bufferVar.n)","Details","The measureranges buffer recall attribute is like an array (a Lua table) of full-scale range values for the measure range used when the measurement was made.","For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.","Example","measurerange = smua.nvbuffer1.measureranges[1]","Store the measure range that was used to make reading number 1.","printbuffer(1, 10, smua.nvbuffer1.measureranges)","Print the range values that were used for the first 10 readings saved in dedicated reading buffer 1.","Example output:","1.00000e-07, 1.00000e-07, 1.00000e-07, 1.00000e-07, 1.00000e-07, 1.00000e-07, 1.00000e-07, 1.00000e-07, 1.00000e-07, 1.00000e-07","Also see","bufferVar.measurefunctions","bufferVar.n","bufferVar.readings","bufferVar.sourcefunctions","bufferVar.sourceoutputstates","bufferVar.sourceranges","bufferVar.sourcevalues","bufferVar.statuses","bufferVar.timestamps","bufferVar.measureranges","19915.html");
+Page[84]=new Array("This attribute contains the number of readings in the buffer.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Clearing the buffer","See Details","Not applicable","Usage","numberOfReadings = bufferVar.n","numberOfReadings","The number of readings stored in the buffer","bufferVar","The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer","Details","This read-only attribute contains the number of readings presently stored in the buffer.","For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.","Example","numberOfReadings = smua.nvbuffer1.n","print(numberOfReadings)","Reads the number of readings stored in dedicated reading buffer 1.","Output: 1.250000+02","The above output indicates that there are 125 readings stored in the buffer.","Also see","bufferVar.measurefunctions","bufferVar.measureranges","bufferVar.readings","bufferVar.sourcefunctions","bufferVar.sourceoutputstates","bufferVar.sourceranges","bufferVar.sourcevalues","bufferVar.statuses","bufferVar.timestamps","Reading buffers","smuX.measure.overlappedY()","smuX.measure.Y()","smuX.nvbufferY","smuX.trigger.measure.Y()","bufferVar.n","15134.html");
+Page[85]=new Array("This attribute contains the readings stored in a specified reading buffer.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Clearing the buffer","See Details","Not applicable","Usage","reading = bufferVar.readings[N]","reading","The value of the reading in the specified reading buffer","bufferVar","The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer","N","The reading number (1 to bufferVar.n)","Details","The readings buffer recall attribute is like an array (a Lua table) of the readings stored in the reading buffer. This array holds the same data that is returned when the reading buffer is accessed directly; that is, rb[2] and rb.readings[2] access the same value.","For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.","Example","print(smua.nvbuffer1.readings[1])","Output the first reading saved in dedicated reading buffer 1.","Output:","8.81658e-08","Also see","bufferVar.measurefunctions","bufferVar.measureranges","bufferVar.n","bufferVar.sourcefunctions","bufferVar.sourceoutputstates","bufferVar.sourceranges","bufferVar.sourcevalues","bufferVar.statuses","bufferVar.timestamps","Reading buffers","bufferVar.readings","19920.html");
+Page[86]=new Array("This attribute contains the source function that was used for readings stored in a specified reading buffer.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Clearing the buffer","See Details","Not applicable","Usage","sourcefunction = bufferVar.sourcefunctions[N]","sourcefunction","The source function used ("current" or "voltage") to acquire reading number N in the specified buffer","bufferVar","The reading buffer; can be a dynamically allocated buffer (user‑defined), or a dedicated reading buffer (such as smua.nvbuffer1)","N","The reading number (1 to bufferVar.n)","Details","The sourcefunctions buffer recall attribute is like an array (a Lua table) of strings indicating the source function at the time of the measurement.","For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.","Example 1","sourcefunction = smua.nvbuffer1.sourcefunctions[3]","Store the source function used to make reading number 3.","Example 2","printbuffer(1, 10, smua.nvbuffer1.sourcefunctions)","Print the source function used for 10 readings stored in dedicated reading buffer 1.","Example output:","Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage, Voltage","Also see","bufferVar.measurefunctions","bufferVar.measureranges","bufferVar.n","bufferVar.readings","bufferVar.sourceoutputstates","bufferVar.sourceranges","bufferVar.sourcevalues","bufferVar.statuses","bufferVar.timestamps","bufferVar.sourcefunctions","19916.html");
+Page[87]=new Array("This attribute indicates the state of the source output for readings stored in a specified buffer.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Clearing the buffer","See Details","Not applicable","Usage","state = bufferVar.sourceoutputstates[N]","state ","The output state ("Off" or "On") when reading N of the specified buffer was acquired","bufferVar","The reading buffer; can be a dynamically allocated buffer (user‑defined), or a dedicated reading buffer (such as smua.nvbuffer1)","N","The reading number (1 to bufferVar.n)","Details","The sourceoutputstates buffer recall attribute is like an array (a Lua table) of strings indicating the state of the source output ("Off" or "On") at the time of the measurement.","For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.","Example","printbuffer(1, 1, smua.nvbuffer1.sourceoutputstates)","Print the source output for the first reading stored in dedicated reading buffer 1.","Example output: On","Also see","bufferVar.measurefunctions","bufferVar.measureranges","bufferVar.n","bufferVar.readings","bufferVar.sourcefunctions","bufferVar.sourceranges","bufferVar.sourcevalues","bufferVar.statuses","bufferVar.timestamps","bufferVar.sourceoutputstates","19917.html");
+Page[88]=new Array("This attribute contains the source range that was used for readings stored in a specified reading buffer.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Clearing the buffer","See Details","Not applicable","Usage","sourcerange = bufferVar.sourceranges[N]","sourcerange","The source range used to acquire reading number N in the specified buffer","bufferVar","The reading buffer; can be a dynamically allocated buffer (user‑defined), or a dedicated reading buffer (such as smua.nvbuffer1)","N","The reading number (1 to bufferVar.n)","Details","The sourceranges buffer recall attribute is like an array (a Lua table) of full-scale range values for the source range used when the measurement was made.","For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.","Example 1","sourcerange = smua.nvbuffer1.sourceranges[1]","Store the source range that was used for the first reading stored in dedicated reading buffer 1.","Example 2","printbuffer(1, 6, smua.nvbuffer1.sourceranges)","Print the source ranges that were used for the first 6 readings stored in source‑measure unit (SMU) A, buffer 1.","Example output:","1.00000e-04, 1.00000e-04, 1.00000e-04, 1.00000e-04, 1.00000e-04, 1.00000e-04","Also see","bufferVar.measurefunctions","bufferVar.measureranges","bufferVar.n","bufferVar.readings","bufferVar.sourcefunctions","bufferVar.sourceoutputstates","bufferVar.sourcevalues","bufferVar.statuses","bufferVar.timestamps","bufferVar.sourceranges","19918.html");
+Page[89]=new Array("When enabled by the bufferVar.collectsourcevalues attribute, this attribute contains the source levels being output when readings in the reading buffer were acquired.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Clearing the buffer","See Details","Not applicable","Usage","sourcevalue = bufferVar.sourcevalues[N]","sourcevalue","The source's output value when reading N of the specified buffer was acquired","bufferVar","The reading buffer; can be a dynamically allocated buffer (user‑defined), or a dedicated reading buffer (such as smua.nvbuffer1)","N","The reading number (1 to bufferVar.n)","Details","If the bufferVar.collectsourcevalues attribute is enabled before readings are taken, the bufferVar.sourcevalues buffer recall attribute is like an array (a Lua table) of the sourced value in effect at the time of the reading. Note that you can set the bufferVar.collectsourcevalues attribute only if the affected reading buffer is empty. See bufferVar.collectsourcevalues for more detailed information.","For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.","Example 1","sourcevalue = smua.nvbuffer1.sourcevalues[1]","Get the sourced value of the first reading stored in dedicated reading buffer 1.","Example 2","printbuffer(1, 6, smua.nvbuffer1.sourcevalues)","Print the sourced value of the first 6 readings stored in source‑measure unit (SMU) A, buffer 1.","Example output:","1.00000e-04, 1.00000e-04,","1.00000e-04, 1.00000e-04,","1.00000e-04, 1.00000e-04","Also see","bufferVar.measurefunctions","bufferVar.measureranges","bufferVar.n","bufferVar.readings","bufferVar.sourcefunctions","bufferVar.sourceoutputstates","bufferVar.sourceranges","bufferVar.statuses","bufferVar.timestamps","bufferVar.sourcevalues","19919.html");
+Page[90]=new Array("This attribute contains the status values of readings in the reading buffer.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Clearing the buffer","See Details","Not applicable","Usage","statusInformation = bufferVar.statuses[N]","statusInformation","The status value when reading N of the specified buffer was acquired ","bufferVar","The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer","N","The reading number (1 to bufferVar.n)","Details","This read‑only buffer recall attribute is like an array (a Lua table) of the status values for all of the readings in the buffer. The status values are floating-point numbers that encode the status value; see the following table for values. ","For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.","Buffer status bits","Bit","Name","Hex value","Description","B0","FastADC","0x01","Fast ADC was used to make the reading","B1","Overtemp","0x02","Over temperature condition","B2","AutoRangeMeas","0x04","Measure range was autoranged","B3","AutoRangeSrc","0x08","Source range was autoranged","B4","4Wire","0x10","4-wire (remote) sense mode enabled","B5","Rel","0x20","Rel applied to reading","B6","Compliance","0x40","Source function in compliance","B7","Filtered","0x80","Reading was filtered","Also see","bufferVar.measurefunctions","bufferVar.measureranges","bufferVar.n","bufferVar.readings","bufferVar.sourcefunctions","bufferVar.sourceranges","bufferVar.timestamps","Reading buffers","bufferVar.statuses","19921.html");
+Page[91]=new Array("This attribute contains the timestamp's resolution.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Not applicable","See Details","1e-6 (1 ms)","Usage","resolution = bufferVar.timestampresolution","resolution","Timestamp resolution in seconds","bufferVar","The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer","Details","Assigning a value to this attribute sets the resolution for the timestamps. Reading this attribute returns the timestamp resolution value. This value can only be changed with an empty buffer. Empty the buffer using the bufferVar.clear() function.","The finest timestamp resolution is 0.000001 seconds (1 μs). At this resolution, the reading buffer can store unique timestamps for up to 71 minutes. This value can be increased for very long tests.","The value specified when setting this attribute will be rounded to an even power of 2 μs.","For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.","Example","smua.nvbuffer1.timestampresolution = 0.000008","Sets the timestamp resolution of dedicated reading buffer 1 to 8 μs.","Also see","bufferVar.clear()","bufferVar.collecttimestamps","bufferVar.timestamps","smuX.measure.overlappedY()","smuX.measure.Y()","smuX.nvbufferY","smuX.trigger.measure.Y()","Reading buffers","bufferVar.timestampresolution","15135.html");
+Page[92]=new Array("When enabled by the bufferVar.collecttimestamps attribute, this attribute contains the timestamp (in seconds) of when each reading saved in the specified reading buffer occurred.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Clearing the buffer","See Details","Not applicable","Usage","timestamp = bufferVar.timestamps[N]","timestamp","The timestamp of reading number N in the specified buffer when the reading was acquired","bufferVar","The reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer","N","The reading number (1 to bufferVar.n)","Details","The bufferVar.timestamps information from a reading buffer is only available if the bufferVar.collecttimestamps attribute is set to 1 (default setting). If it is set to 0, you will not be able to access any time information from a reading buffer. ","If enabled, this buffer recall attribute is like an array (a Lua table) containing timestamps, in seconds, of when each reading occurred. These are relative to the bufferVar.basetimestamp for the buffer. See Reading buffer commands for more information.","For dedicated reading buffers, all buffer attributes are saved to nonvolatile memory only when the reading buffer is saved to nonvolatile memory.","Example","timestamp = smua.nvbuffer1.timestamps[1]","Get the timestamp of the first reading stored in dedicated reading buffer 1.","Also see","bufferVar.clear()","bufferVar.collecttimestamps","bufferVar.measurefunctions","bufferVar.measureranges","bufferVar.n","bufferVar.readings","bufferVar.sourcefunctions","bufferVar.sourceoutputstates","bufferVar.sourceranges","bufferVar.sourcevalues","bufferVar.statuses","Reading buffers","bufferVar.timestamps","19922.html");
+Page[93]=new Array("This KIPulse factory script function configures a current pulse train with a voltage measurement at each point.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, "," tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)","f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, "," tag, sync_in, sync_out, sync_in_timeout)","f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, "," tag, sync_in, sync_out)","f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, "," tag, sync_in)","f, msg = ConfigPulseIMeasureV(smu, bias, level, limit, ton, toff, points, buffer, "," tag)","f","A Boolean flag; this flag will be true when the pulse was successfully configured, false when errors were encountered ","msg","A string message; if the f flag is false, msg will contain an error message; if it is true, msg will contain a string indicating successful configuration","smu","System SourceMeter® instrument channel (set to smua)","bias","Bias level in amperes","level","Pulse level in amperes","limit","Voltage limit (for example, compliance) in volts","ton","Pulse on time in seconds","toff","Pulse off time in seconds","points","Number of pulse-measure cycles","buffer","Reading buffer where pulsed measurements will be stored; if this is nil when the function is called, no measurements will be made when the pulse train is initiated","tag","Numeric identifier to be assigned to the defined pulse train","sync_in","Defines a digital I/O trigger input line; if programmed, the pulse train will wait for a trigger input before executing each pulse","sync_out","Defines a digital I/O trigger output line; if programmed, the pulse train will generate a trigger output immediately before the start of ton","sync_in_timeout","Specifies the length of time (in seconds) to wait for input trigger; default value is 10 s","sync_in_abort","Specifies whether or not to abort pulse if input trigger is not received. If pulse aborts because of a missed trigger, a timer timeout message is returned; true or false","Details","Data for pulsed voltage measurements are stored in the reading buffer specified by the buffer input parameter.","This function configures a current pulse train with a voltage measurement at each point. Measurements are made at the end of the ton time. ","This function does not cause the specified smu to output a pulse train. It simply checks to see if all of the pulse dimensions are achievable, and if they are, assigns the indicated tag or index to the pulse train. @","Example","ConfigPulseIMeasureV(smua, 0, 10e-3,"," 100, 0.01, 0.1, 1, smua.nvbuffer1, 1)","Set up a pulse train that uses System SourceMeter® instrument channel A. The pulse amplitude will be 10 mA and will return to 0 A after 10 ms. The pulse will remain at 0 A for 100 ms and the voltage limit will be 100 V during the pulse. The pulse train will consist of only 1 pulse, and this pulse will be assigned a tag index of 1.","Also see","InitiatePulseTest()","ConfigPulseIMeasureV()","12926.html");
+Page[94]=new Array("This KIPulse factory script function configures a linear pulsed current sweep with a voltage measurement at each point.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)","f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out, sync_in_timeout)","f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in, sync_out)","f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag, sync_in)","f, msg = ConfigPulseIMeasureVSweepLin(smu, bias, start, stop, limit, ton, toff, points, buffer, tag)","f","A Boolean flag; this flag will be true when the pulse was successfully configured, false when errors were encountered","msg","A string message; if the f flag is false, msg will contain an error message; if it is true, msg will contain a string indicating successful configuration","smu","System SourceMeter® instrument channel (set to smua)","bias","Bias level in amperes","start","Pulse sweep start level in volts","stop","Pulse sweep stop level in volts","limit","Voltage limit (for example, compliance) in volts","ton","Pulse on time in seconds","toff","Pulse off time in seconds","points","Number of pulse-measure cycles","buffer","Reading buffer where pulsed measurements will be stored; if this is nil when the function is called, no measurements will be made when the pulse train is initiated","tag","Numeric identifier to be assigned to the defined pulse train","sync_in","Defines a digital I/O trigger input line; if programmed, the pulse train will wait for a trigger input before executing each pulse","sync_out","Defines a digital I/O trigger output line; if programmed, the pulse train will generate a trigger output immediately before the start of ton","sync_in_timeout","Specifies the length of time (in seconds) to wait for input trigger; default value is 10 s","sync_in_abort","Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or false","Details","Data for pulsed voltage measurements are stored in the reading buffer specified by the buffer input parameter.","This function configures a linear pulsed current sweep with a voltage measurement at each point. Measurements are made at the end of the ton time.","The magnitude of the first pulse will be start amperes; the magnitude of the last pulse will be stop amperes. The magnitude of each pulse in between will be step amperes larger than the previous pulse, where:","step = (stop - start) / (points - 1) ","This function does not cause the specified smu to output a pulse train. It simply checks to see if all of the pulse dimensions are achievable, and if they are, assigns the indicated tag or index to the pulse train. @","Example","ConfigPulseIMeasureVSweepLin(smua, 0, 0.01, 0.05, 500, 15e-3, 0.1, 20, smua.nvbuffer2, 3)","Set up a pulsed sweep that will use System SourceMeter® instrument channel A. The pulsed sweep will start at 10 mA, end at 50 mA, and return to a 0 mA bias level between pulses. Each pulsed step will be on for 15 ms, and then at the bias level for 100 ms. The voltage limit will be 500 V during the entire pulsed sweep. The pulse train will be comprised of 20 pulsed steps and the pulse train will be assigned a tag index of 3.","Also see","InitiatePulseTest()","ConfigPulseIMeasureVSweepLin()","12937.html");
+Page[95]=new Array("This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff,"," points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)","f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff,"," points, buffer, tag, sync_in, sync_out, sync_in_timeout)","f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff,"," points, buffer, tag, sync_in, sync_out)","f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff,"," points, buffer, tag, sync_in)","f, msg = ConfigPulseIMeasureVSweepLog(smu, bias, start, stop, limit, ton, toff,"," points, buffer, tag)","f","A Boolean flag; this flag will be true when the pulse was successfully configured, false when errors were encountered ","msg","A string message; if the f flag is false, msg will contain an error message; if it is true, msg will contain a string indicating successful configuration","smu","System SourceMeter® instrument channel (set to smua)","bias","Bias level in amperes","start","Pulse sweep start level in amperes","stop","Pulse sweep stop level in amperes","limit","Voltage limit (for example, compliance) in volts","ton","Pulse on time in seconds","toff","Pulse off time in seconds","points","Number of pulse-measure cycles","buffer","Reading buffer where pulsed measurements will be stored; if this is nil when the function is called, no measurements will be made when the pulse train is initiated","tag","Numeric identifier to be assigned to the defined pulse train","sync_in","Defines a digital I/O trigger input line; if programmed, the pulse train will wait for a trigger input before executing each pulse","sync_out","Defines a digital I/O trigger output line; if programmed, the pulse train will generate a trigger output immediately before the start of ton","sync_in_timeout","Specifies the length of time (in seconds) to wait for input trigger; default value is 10 s","sync_in_abort","Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or false ","Details","Data for pulsed voltage measurements are stored in the reading buffer specified by the buffer input parameter.","This function configures a logarithmic pulsed current sweep with a voltage measurement at each point. Measurements are made at the end of the ton time.","The magnitude of the first pulse will be start amperes; the magnitude of the last pulse will be stop amperes. The magnitude of each pulse in between will be LogStepn amperes larger than the previous pulse, where:","LogStepSize = (log10(stop) - log10(start)) / (points -1)","LogStepn = (n - 1) * (LogStepSize), where n = [1, points]","SourceStepLeveln = antilog(LogStepn) * start","This function does not cause the specified smu to output a pulse train. It simply checks to see if all of the pulse dimensions are achievable, and if they are, assigns the indicated tag or index to the pulse train. @","Example","ConfigPulseIMeasureVSweepLog(smua, 0,"," 1e-3, 0.01, 100, 10e-3, 100e-3, "," 10, smua.nvbuffer1, 5)","Set up a pulsed logarithmic sweep that uses System SourceMeter® instrument channel A. The pulsed sweep will start at 1 mA, end at 10 mA, and return to a 0 A bias level between pulses. Each pulsed step will be on for 10 ms, and then at the bias level for 100 ms. The voltage limit will be 100 V during the entire pulsed sweep. The pulse train will be comprised of 10 pulsed steps, and the pulse train will be assigned a tag index of 5.","Also see","InitiatePulseTest()","ConfigPulseIMeasureVSweepLog()","12943.html");
+Page[96]=new Array("This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, "," tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)","f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, "," tag, sync_in, sync_out, sync_in_timeout)","f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, "," tag, sync_in, sync_out)","f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, "," tag, sync_in)","f, msg = ConfigPulseVMeasureI(smu, bias, level, limit, ton, toff, points, buffer, "," tag)","f","A Boolean flag; this flag will be true when the pulse was successfully configured, false when errors were encountered ","msg","A string message; if the f flag is false, msg will contain an error message; if it is true, msg will contain a string indicating successful configuration","smu","System SourceMeter® instrument channel (set to smua)","bias","Bias level in volts","level","Pulse level in volts","limit","Current limit (for example, compliance) in amperes","ton","Pulse on time in seconds","toff","Pulse off time in seconds","points","Number of pulse-measure cycles","buffer","Reading buffer where pulsed measurements will be stored; if this is nil when the function is called, no measurements will be made when the pulse train is initiated","tag","Numeric identifier to be assigned to the defined pulse train","sync_in","Defines a digital I/O trigger input line; if programmed, the pulse train will wait for a trigger input before executing each pulse","sync_out","Defines a digital I/O trigger output line; if programmed, the pulse train will generate a trigger output immediately before the start of ton","sync_in_timeout","Specifies the length of time (in seconds) to wait for input trigger; default value is 10 s","sync_in_abort","Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or false","Details","Data for pulsed current measurements are stored in the reading buffer specified by the buffer input parameter.","This function configures a voltage pulse train with a current measurement at each point. Measurements are made at the end of the ton time. ","This function does not cause the specified smu to output a pulse train. It simply checks to see if all of the pulse dimensions are achievable, and if they are, assigns the indicated tag or index to the pulse train.","Example 1","ConfigPulseVMeasureI(smua, 0, 400,"," 100e-6, 5e-3, 10e-3, 10,"," smua.nvbuffer1, 2)","Set up a pulse train that uses System SourceMeter® instrument channel A. The pulse amplitude will be 400 V and will return to 0 V after 5 ms. The pulse will remain at 0 V for 10 ms, and the current limit will be 100 mA during the pulse. The pulse train will consist of 10 pulses, and the pulse train will be assigned a tag index of 2.","Example 2","local timelist = { 1, 2, 3, 4, 5 }","f, msg = ConfigPulseVMeasureI(smua, 0, 1,"," 100e-3, 1, timelist, 5, nil, 1)","Variable off time between pulses in a pulse train.","Configure a pulse with 1 second on-time and variable off-time, no measurement.","Example 3","rbi = smua.makebuffer(10)","rbv = smua.makebuffer(10)","rbi.appendmode = 1","rbv.appendmode = 1","rbs = { i = rbi, v = rbv }","f, msg = ConfigPulseVMeasureI(smua, 0, 10,"," 1e-3, 1e-3, 1e-3, 2, rbs, 1)","Simultaneous IV measurement during pulse.","Also see","InitiatePulseTest()","ConfigPulseVMeasureI()","12931.html");
+Page[97]=new Array("This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff,"," points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)","f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff,"," points, buffer, tag, sync_in, sync_out, sync_in_timeout)","f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff,"," points, buffer, tag, sync_in, sync_out)","f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff,"," points, buffer, tag, sync_in)","f, msg = ConfigPulseVMeasureISweepLin(smu, bias, start, stop, limit, ton, toff,"," points, buffer, tag)","f","A Boolean flag; this flag will be true when the pulse was successfully configured, false when errors were encountered ","msg","A string message; if the f flag is false, msg will contain an error message; if it is true, msg will contain a string indicating successful configuration","smu","System SourceMeter® instrument channel (set to smua)","bias","Bias level in volts","start","Pulse sweep start level in volts","stop","Pulse sweep stop level in volts","limit","Current limit (for example, compliance) in amperes","ton","Pulse on time in seconds","toff","Pulse off time in seconds","points","Number of pulse-measure cycles","buffer","Reading buffer where pulsed measurements will be stored; if this is nil when the function is called, no measurements will be made when the pulse train is initiated","tag","Numeric identifier to be assigned to the defined pulse train","sync_in","Defines a digital I/O trigger input line; if programmed, the pulse train will wait for a trigger input before executing each pulse","sync_out","Defines a digital I/O trigger output line; if programmed, the pulse train will generate a trigger output immediately before the start of ton","sync_in_timeout","Specifies the length of time (in seconds) to wait for input trigger; default value is 10 s","sync_in_abort","Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or false","Details","Data for pulsed current measurements are stored in the reading buffer specified by the buffer input parameter.","This function configures a linear pulsed voltage sweep with a current measurement at each point. Measurements are made at the end of the ton time.","The magnitude of the first pulse will be start volts; the magnitude of the last pulse will be stop volts. The magnitude of each pulse in between will be step volts larger than the previous pulse, where:","step = (stop - start) / (points - 1)","This function does not cause the specified smu to output a pulse train. It simply checks to see if all of the pulse dimensions are achievable, and if they are, assigns the indicated tag or index to the pulse train. @","Example","ConfigPulseVMeasureISweepLin(smua, 0,"," 100, 1000, 1e-3, 10e-3, 50e-3, 16,"," smua.nvbuffer1, 4)","Set up a pulsed sweep that will use System SourceMeter® instrument channel A. The pulsed sweep will start at 100 V, end at 1000 V, and return to a 0 V bias level between pulses. Each pulsed step will be on for 10 ms, and then at the bias level for 50 ms. ","The current limit will be 1 mA during the entire pulsed sweep. The pulse train will be comprised of 16 pulsed steps, and the pulse train will be assigned a tag index of 4.","Also see","InitiatePulseTest()","ConfigPulseVMeasureISweepLin()","12940.html");
+Page[98]=new Array("This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, "," points, buffer, tag, sync_in, sync_out, sync_in_timeout, sync_in_abort)","f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, "," points, buffer, tag, sync_in, sync_out, sync_in_timeout)","f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, "," points, buffer, tag, sync_in, sync_out)","f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, "," points, buffer, tag, sync_in)","f, msg = ConfigPulseVMeasureISweepLog(smu, bias, start, stop, limit, ton, toff, "," points, buffer, tag)","f","A Boolean flag; this flag will be true when the pulse was successfully configured, false when errors were encountered","msg","A string message; if the f flag is false, msg will contain an error message; if it is true, msg will contain a string indicating successful configuration","smu","System SourceMeter® instrument channel (set to smua)","bias","Bias level in volts","start","Pulse sweep start level in volts","stop","Pulse sweep stop level in volts","limit","Current limit (for example, compliance) in amperes","ton","Pulse on time in seconds","toff","Pulse off time in seconds","points","Number of pulse-measure cycles","buffer","Reading buffer where pulsed measurements will be stored; if this is nil when the function is called, no measurements will be made when the pulse train is initiated","tag","Numeric identifier to be assigned to the defined pulse train","sync_in","Defines a digital I/O trigger input line; if programmed, the pulse train will wait for a trigger input before executing each pulse","sync_out","Defines a digital I/O trigger output line; if programmed, the pulse train will generate a trigger output immediately before the start of ton","sync_in_timeout","Specifies the length of time (in seconds) to wait for input trigger; default value is 10 s","sync_in_abort","Specifies whether or not to abort pulse if input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or false","Details","Data for pulsed current measurements are stored in the reading buffer specified by the buffer input parameter.","This function configures a logarithmic pulsed voltage sweep with a current measurement at each point. Measurements are made at the end of the ton time.","The magnitude of the first pulse will be start volts; the magnitude of the last pulse will be stop volts. The magnitude of each pulse in between will be LogStepn volts larger than the previous pulse, where:","LogStepSize = (log10(stop) - log10(start)) / (points -1)","LogStepn = (n - 1) * (LogStepSize), where n = [1, points]","SourceStepLeveln = antilog(LogStepn) * start","This function does not cause the specified smu to output a pulse train. It simply checks to see if all of the pulse dimensions are achievable, and if they are, assigns the indicated tag or index to the pulse train. @","Example","ConfigPulseVMeasureISweepLog(smua, 0, "," 10, 1000, 10e-3, 20e-3, 100e-3, 10,"," smua.nvbuffer1, 6)","Set up a pulsed logarithmic sweep that will use System SourceMeter® instrument channel A. The pulsed sweep will start at 10 V, end at 1000 V, and return to a 0 V bias level between pulses. Each pulsed step will be on for 20 ms, and then at the bias level for 100 ms. ","The current limit will be 10 mA during the entire pulsed sweep. The pulse train will be comprised of 10 pulsed steps, and the pulse train will be assigned a tag index of 6.","Also see","InitiatePulseTest()","ConfigPulseVMeasureISweepLog()","12946.html");
+Page[99]=new Array("This function adds an entry to the data queue.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","result = dataqueue.add(value)","result = dataqueue.add(value, timeout)","result","The resulting value of true or false based on the success of the function","value","The data item to add; value can be of any type","timeout","The maximum number of seconds to wait for space in the data queue","Details","You cannot use the timeout value when accessing the data queue from a remote node (you can only use the timeout value while adding data to the local data queue).","The timeout value is ignored if the data queue is not full.","The dataqueue.add() function returns false:","If the timeout expires before space is available in the data queue","If the data queue is full and a timeout value is not specified","If the value is a table, a duplicate of the table and any subtables is made. The duplicate table does not contain any references to the original table or to any subtables.","Example","dataqueue.clear()","dataqueue.add(10)","dataqueue.add(11, 2)","result = dataqueue.add(12, 3)","if result == false then"," print("Failed to add 12 to the dataqueue")","end","print("The dataqueue contains:")","while dataqueue.count > 0 do"," print(dataqueue.next())","end","Clear the data queue.","Each line adds one item to the data queue.","Output:","The dataqueue contains:","1.00000e+01","1.10000e+01","1.20000e+01","Also see","dataqueue.CAPACITY","dataqueue.clear()","dataqueue.count","dataqueue.next()","dataqueue.add()","14654.html");
+Page[100]=new Array("This constant is the maximum number of entries that you can store in the data queue.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Constant","Yes","Usage","count = dataqueue.CAPACITY","count","The variable assigned the value of dataqueue.CAPACITY","Details","This constant always returns the maximum number of entries that can be stored in the data queue.","Example","MaxCount = dataqueue.CAPACITY","while dataqueue.count < MaxCount do"," dataqueue.add(1)","end","print("There are " .. dataqueue.count"," .. " items in the data queue")","Add items to the data queue until it is at capacity.","Output:","There are 128 items in the data queue","Also see","dataqueue.add()","dataqueue.clear()","dataqueue.count","dataqueue.next()","dataqueue.CAPACITY","14656.html");
+Page[101]=new Array("This function clears the data queue.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","dataqueue.clear()","Details","This function forces all dataqueue.add() commands that are in progress to time out.","The function deletes all data from the data queue.","Example","MaxCount = dataqueue.CAPACITY","while dataqueue.count < MaxCount do"," dataqueue.add(1)","end","print("There are " .. dataqueue.count"," .. " items in the data queue")","dataqueue.clear()","print("There are " .. dataqueue.count"," .. " items in the data queue")","This example fills the data queue and prints the number of items in the queue. It then clears the queue and prints the number of items again.","Output:","There are 128 items in the data queue","There are 0 items in the data queue","Also see","dataqueue.add()","dataqueue.CAPACITY","dataqueue.count","dataqueue.next()","dataqueue.clear()","14655.html");
+Page[102]=new Array("This attribute contains the number of items in the data queue.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Power cycle","Not saved","Not applicable","Usage","count = dataqueue.count","count","The number of items in the data queue","Details","The count gets updated as entries are added with dataqueue.add() and read from the data queue with dataqueue.next(). It is also updated when the dataqueue is cleared with dataqueue.clear().","A maximum of dataqueue.CAPACITY items can be stored at any one time in the data queue.","Example","MaxCount = dataqueue.CAPACITY","while dataqueue.count < MaxCount do"," dataqueue.add(1)","end","print("There are " .. dataqueue.count"," .. " items in the data queue")","dataqueue.clear()","print("There are " .. dataqueue.count"," .. " items in the data queue")","Add items to the data queue until it is at capacity.","Output:","There are 128 items in the data queue","There are 0 items in the data queue","Also see","dataqueue.add()","dataqueue.CAPACITY","dataqueue.clear()","dataqueue.next()","dataqueue.count","14657.html");
+Page[103]=new Array("This function removes the next entry from the data queue.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","value = dataqueue.next()","value = dataqueue.next(timeout)","value","The next entry in the data queue","timeout","The number of seconds to wait for data in the queue","Details","If the data queue is empty, the function waits up to the timeout value.","If data is not available in the data queue before the timeout expires, the return value is nil.","The entries in the data queue are removed in first-in, first-out (FIFO) order.","If the value is a table, a duplicate of the original table and any subtables is made. The duplicate table does not contain any references to the original table or to any subtables.","Example","dataqueue.clear()","for i = 1, 10 do"," dataqueue.add(i)","end","print("There are " .. dataqueue.count"," .. " items in the data queue")","while dataqueue.count > 0 do"," x = dataqueue.next()"," print(x)","end","print("There are " .. dataqueue.count"," .. " items in the data queue")","Clears the data queue, adds ten entries, then reads the entries from the data queue.","Output:","There are 10 items in the data queue","1.00000e+00","2.00000e+00","3.00000e+00","4.00000e+00","5.00000e+00","6.00000e+00","7.00000e+00","8.00000e+00","9.00000e+00","1.00000e+01","There are 0 items in the data queue","Also see","dataqueue.add()","dataqueue.CAPACITY","dataqueue.clear()","dataqueue.count","dataqueue.next()","14658.html");
+Page[104]=new Array("This function delays the execution of the commands that follow it.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","delay(seconds)","seconds","The number of seconds to delay, maximum 100,000","Details","You cannot set a delay for zero seconds.","The system delays execution of the commands for at least the specified number of seconds and fractional seconds. However, the processing time may cause the system to delay 5 μs to 10 μs (typical) more than the requested delay.","Example 1","beeper.beep(0.5, 2400)","delay(0.250)","beeper.beep(0.5, 2400)","Emit a double‑beep at 2400 Hz. The sequence is 0.5 s on, 0.25 s off, 0.5 s on.","Example 2","dataqueue.clear()","dataqueue.add(35)","timer.reset()","delay(0.5)","dt = timer.measure.t()","print("Delay time was " .. dt)","print(dataqueue.next())","Clear the data queue, add 35 to it, then delay 0.5 seconds before reading it.","Output:","Delay time was 0.500099","3.50000e+01","Also see","None","delay()","13949.html");
+Page[105]=new Array("This function reads one digital I/O line.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","data = digio.readbit(N)","data","A custom variable that stores the state of the I/O line","N","Digital I/O line number to be read (1 to 14)","Details","A returned value of zero (0) indicates that the line is low. A returned value of one (1) indicates that the line is high.","Example","print(digio.readbit(4))","Assume line 4 is set high, and it is then read.","Output:","1.00000e+00","Also see","digio.readport()","digio.writebit()","digio.writeport()","Digital I/O port","digio.readbit()","14668.html");
+Page[106]=new Array("This function reads the digital I/O port.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","data = digio.readport()","data","The present value of the input lines on the digital I/O port","Details","The binary equivalent of the returned value indicates the value of the input lines on the I/O port. The least significant bit (bit B1) of the binary number corresponds to line 1; bit B14 corresponds to line 14.","For example, a returned value of 170 has a binary equivalent of 000000010101010, which indicates that lines 2, 4, 6, and 8 are high (1), and the other 10 lines are low (0).","Example","data = digio.readport()","print(data)","Assume lines 2, 4, 6, and 8 are set high when the I/O port is read.","Output:","1.70000e+02","This is binary 10101010","Also see","digio.readbit()","digio.writebit()","digio.writeport()","Digital I/O port","digio.readport()","14669.html");
+Page[107]=new Array("This function asserts a trigger on one of the digital I/O lines.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","digio.trigger[N].assert()","N","Digital I/O trigger line (1 to 14)","Details","The set pulsewidth determines how long the trigger is asserted.","Example","digio.trigger[2].assert()","Asserts a trigger on digital I/O line 2.","Also see","digio.trigger[N].pulsewidth","digio.trigger[N].assert()","14670.html");
+Page[108]=new Array("This function clears the trigger event on a digital I/O line.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","digio.trigger[N].clear()","N","Digital I/O trigger line (1 to 14)","Details","The event detector of a trigger recalls if a trigger event has been detected since the last digio.trigger[N].wait() command. This function clears the event detector of the specified trigger line, discards the previous history of the trigger line, and clears the digio.trigger[N].overrun attribute.","Example","digio.trigger[2].clear()","Clears the trigger event detector on I/O line 2.","Also see","digio.trigger[N].overrun","digio.trigger[N].wait()","digio.trigger[N].clear()","14671.html");
+Page[109]=new Array("This constant identifies the trigger event generated by the digital I/O line N.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Constant","Yes","Usage","eventID = digio.trigger[N].EVENT_ID","eventID","The trigger event number","N","Digital I/O trigger line (1 to 14)","Details","To have another trigger object respond to trigger events generated by the trigger line, set the other object's stimulus attribute to the value of this constant.","Example 1","digio.trigger[5].stimulus = digio.trigger[3].EVENT_ID","Uses a trigger event on digital I/O trigger line 3 to be the stimulus for digital I/O trigger line 5.","Example 2","smua.trigger.arm.stimulus ="," digio.trigger[3].EVENT_ID","Uses a trigger event on digital I/O trigger line 3 to be the trigger stimulus for the SMU.","Also see","None","digio.trigger[N].EVENT_ID","14672.html");
+Page[110]=new Array("This attribute sets the mode in which the trigger event detector and the output trigger generator operate on the given trigger line.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Digital I/O trigger N reset Recall setup","Not saved ","0 (digio.TRIG_BYPASS)","Usage","triggerMode = digio.trigger[N].mode","digio.trigger[N].mode = triggerMode","triggerMode","The trigger mode; see Details for values","N","Digital I/O trigger line (1 to 14)","Details","Set triggerMode to one of the following values:","Trigger mode values","triggerMode","Description","digio.TRIG_BYPASS or 0","Allows direct control of the line.","digio.TRIG_FALLING or 1","Detects falling‑edge triggers as input; asserts a TTL-low pulse for output.","digio.TRIG_RISING or 2","If the programmed state of the line is high, the digio.TRIG_RISING mode behavior is similar to digio.TRIG_RISINGA. If the programmed state of the line is low, the digio.TRIG_RISING mode behavior is similar to digio.TRIG_RISINGM. This setting should only be used if necessary for compatibility with other Keithley Instruments products.","digio.TRIG_EITHER or 3","Detects rising- or falling‑edge triggers as input. Asserts a TTL‑low pulse for output.","digio.TRIG_SYNCHRONOUSA or 4","Detects the falling‑edge input triggers and automatically latches and drives the trigger line low. Asserting the output trigger releases the latched line.","digio.TRIG_SYNCHRONOUS or 5","Detects the falling‑edge input triggers and automatically latches and drives the trigger line low. Asserts a TTL‑low pulse as an output trigger.","digio.TRIG_SYNCHRONOUSM or 6","Detects rising‑edge triggers as input. Asserts a TTL‑low pulse for output.","digio.TRIG_RISINGA or 7","Detects rising‑edge triggers as input. Asserts a TTL‑low pulse for output.","digio.TRIG_RISINGM or 8","Asserts a TTL-high pulse for output. Input edge detection is not possible in this mode.","When programmed to any mode except digio.TRIG_BYPASS, the output state of the I/O line is controlled by the trigger logic, and the user‑specified output state of the line is ignored.","Use of either digio.TRIG_SYNCHRONOUSA or digio.TRIG_SYNCHRONOUSM is preferred over digio.TRIG_SYNCHRONOUS, because digio.TRIG_SYNCHRONOUS is provided for compatibility with the digital I/O and TSP-Link triggering on other Keithley Instruments products.","To control the line state, set the mode to digio.TRIG_BYPASS and use the digio.writebit() and digio.writeport() commands.","Example","digio.trigger[4].mode = 2","Sets the trigger mode for I/O line 4 to digio.TRIG_RISING.","Also see","digio.trigger[N].clear()","digio.trigger[N].reset()","digio.writebit()","digio.writeport()","Sweep operation","digio.trigger[N].mode","14674.html");
+Page[111]=new Array("Use this attribute to read the event detector overrun status.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Instrument reset Digital I/O trigger N clear Digital I/O trigger N reset Recall setup","Not saved","Not applicable","Usage","overrun = digio.trigger[N].overrun","overrun","Trigger overrun state (true or false)","N","Digital I/O trigger line (1 to 14)","Details","If this is true, an event was ignored because the event detector was already in the detected state when the event occurred.","This is an indication of the state of the event detector built into the line itself. It does not indicate if an overrun occurred in any other part of the trigger model or in any other detector that is monitoring the event.","Example","overrun = digio.trigger[1].overrun","print(overrun)","If there is no trigger overrun, the following text is output:","false","Also see","digio.trigger[N].clear()","digio.trigger[N].reset()","digio.trigger[N].overrun","14675.html");
+Page[112]=new Array("This attribute describes the length of time that the trigger line is asserted for output triggers.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Digital I/O trigger N reset Recall setup","Not saved ","10e-6 (10 µs)","Usage","width = digio.trigger[N].pulsewidth","digio.trigger[N].pulsewidth = width","width","The pulse width (seconds)","N","Digital I/O trigger line (1 to 14)","Details","Setting width to zero (0) seconds asserts the trigger indefinitely. To release the trigger line, use digio.trigger[N].release().","Example","digio.trigger[4].pulsewidth = 20e-6","Sets the pulse width for trigger line 4 to 20 μs.","Also see","digio.trigger[N].assert()","digio.trigger[N].reset()","digio.trigger[N].release()","digio.trigger[N].pulsewidth","17691.html");
+Page[113]=new Array("This function releases an indefinite length or latched trigger.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","digio.trigger[N].release()","N","Digital I/O trigger line (1 to 14)","Details","Releases a trigger that was asserted with an indefinite pulse width time, as well as a trigger that was latched in response to receiving a synchronous mode trigger. Only the specified trigger line (N) is affected.","Example","digio.trigger[4].release()","Releases digital I/O trigger line 4.","Also see","digio.trigger[N].pulsewidth","digio.trigger[N].release()","14677.html");
+Page[114]=new Array("This function resets trigger values to their factory defaults.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","digio.trigger[N].reset()","N","Digital I/O trigger line (1 to 14)","Details","This function resets the following attributes to factory default settings:","digio.trigger[N].mode","digio.trigger[N].pulsewidth","digio.trigger[N].stimulus","It also clears digio.trigger[N].overrun.","Example","digio.trigger[3].mode = 2","digio.trigger[3].pulsewidth = 50e-6","digio.trigger[3].stimulus = digio.trigger[5].EVENT_ID","print(digio.trigger[3].mode, digio.trigger[3].pulsewidth, digio.trigger[3].stimulus)","digio.trigger[3].reset()","print(digio.trigger[3].mode, digio.trigger[3].pulsewidth, digio.trigger[3].stimulus)","Set the digital I/O trigger line 3 for a falling edge with a pulsewidth of 50 microseconds.","Use digital I/O line 5 to trigger the event on line 3.","Reset the line back to factory default values.","Output before reset:","2.00000e+00 5.00000e-05 5.00000e+00","Output after reset:","0.00000e+00 1.00000e-05 0.00000e+00","Also see","digio.trigger[N].mode","digio.trigger[N].overrun","digio.trigger[N].pulsewidth","digio.trigger[N].stimulus","digio.trigger[N].reset()","17719.html");
+Page[115]=new Array("This attribute selects the event that causes a trigger to be asserted on the digital output line.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Digital I/O trigger N reset Recall setup","Not saved","0","Usage","triggerStimulus = digio.trigger[N].stimulus","digio.trigger[N].stimulus = triggerStimulus","triggerStimulus","The event identifier for the triggering event","N","Digital I/O trigger line (1 to 14)","Details","Set this attribute to zero (0) to disable the automatic trigger output.","Do not use the stimulus attribute for generating output triggers under script control. Use digio.trigger[N].assert() instead.","The trigger stimulus for a digital I/O line may be set to one of the existing trigger event IDs, described in the following table.","Trigger event IDs*","Event ID","Event description","smua.trigger.SWEEPING_EVENT_ID","Occurs when the source‑measure unit (SMU) transitions from the idle state to the arm layer of the trigger model","smua.trigger.ARMED_EVENT_ID","Occurs when the SMU moves from the arm layer to the trigger layer of the trigger model","smua.trigger.SOURCE_COMPLETE_EVENT_ID","Occurs when the SMU completes a source action","smua.trigger.MEASURE_COMPLETE_EVENT_ID","Occurs when the SMU completes a measure action","smua.trigger.PULSE_COMPLETE_EVENT_ID","Occurs when the SMU completes a pulse","smua.trigger.SWEEP_COMPLETE_EVENT_ID","Occurs when the SMU completes a sweep","smua.trigger.IDLE_EVENT_ID","Occurs when the SMU returns to the idle state","digio.trigger[N].EVENT_ID","Occurs when an edge is detected on a digital I/O line","tsplink.trigger[N].EVENT_ID","Occurs when an edge is detected on a TSP‑Link line","lan.trigger[N].EVENT_ID","Occurs when the appropriate LXI trigger packet is received on LAN trigger object N","display.trigger.EVENT_ID","Occurs when the TRIG key on the front panel is pressed","trigger.EVENT_ID","Occurs when a *TRG command is received on the remote interface","GPIB only: Occurs when a GET bus command is received","VXI-11 only: Occurs with the VXI-11 command device_trigger; reference the VXI-11 standard for additional details on the device trigger operation","trigger.blender[N].EVENT_ID","Occurs after a collection of events is detected","trigger.timer[N].EVENT_ID","Occurs when a delay expires","* Use the name of the trigger event ID to set the stimulus value rather than the numeric value. Using the name makes the code compatible for future upgrades (for example, if the numeric values must change when enhancements are added to the instrument).","Example 1","digio.trigger[3].stimulus = 0","Clear the trigger stimulus of digital I/O line 3.","Example 2","digio.trigger[3].stimulus ="," smua.trigger.SOURCE_COMPLETE_EVENT_ID","Set the trigger stimulus of digital I/O line 3 to be the source complete event.","Also see","digio.trigger[N].assert()","digio.trigger[N].clear()","digio.trigger[N].reset()","digio.trigger[N].stimulus","19521.html");
+Page[116]=new Array("This function waits for a trigger.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","triggered = digio.trigger[N].wait(timeout)","triggered","The value true if a trigger is detected, or false if no triggers are detected during the timeout period","N","Digital I/O trigger line (1 to 14)","timeout","Timeout in seconds","Details","This function pauses for up to timeout seconds for an input trigger. If one or more trigger events are detected since the last time digio.trigger[N].wait() or digio.trigger[N].clear() was called, this function returns a value immediately. After waiting for a trigger with this function, the event detector is automatically reset and ready to detect the next trigger. This is true regardless of the number of events detected.","Example","triggered = digio.trigger[4].wait(3)","print(triggered)","Waits up to three seconds for a trigger to be detected on trigger line 4, then outputs the results.","Output if no trigger is detected:","false","Output if a trigger is detected:","true","Also see","digio.trigger[N].clear()","digio.trigger[N].wait()","14679.html");
+Page[117]=new Array("This function sets a digital I/O line high or low.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","digio.writebit(N, data)","N","Digital I/O trigger line (1 to 14)","data","The value to write to the bit:","0 (low)","Non‑zero (high)","Details","If the output line is write‑protected using the digio.writeprotect attribute, the command is ignored.","The reset() function does not affect the present state of the digital I/O lines.","Use the digio.writebit() and digio.writeport() commands to control the output state of the synchronization line when trigger operation is set to digio.TRIG_BYPASS.","The data must be zero (0) to clear the bit. Any value other than zero (0) sets the bit.","Example","digio.writebit(4, 0)","Sets digital I/O line 4 low (0).","Also see","digio.readbit()","digio.readport()","digio.trigger[N].mode","digio.writeport()","digio.writeprotect","digio.writebit()","14680.html");
+Page[118]=new Array("This function writes to all digital I/O lines.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","digio.writeport(data)","data","Value to write to the port (0 to 16383)","Details","The binary representation of data indicates the output pattern to be written to the I/O port. For example, a data value of 170 has a binary equivalent of 00000010101010. Lines 2, 4, 6, and 8 are set high (1), and the other 10 lines are set low (0).","Write‑protected lines are not changed.","The reset() function does not affect the present states of the digital I/O lines.","Use the digio.writebit() and digio.writeport() commands to control the output state of the synchronization line when trigger operation is set to digio.TRIG_BYPASS.","Example","digio.writeport(255)","Sets digital I/O Lines 1 through 8 high (binary 00000011111111).","Also see","digio.readbit()","digio.readport()","digio.writebit()","digio.writeprotect","digio.writeport()","14681.html");
+Page[119]=new Array("This attribute contains the write‑protect mask that protects bits from changes from the digio.writebit() and digio.writeport() functions.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Recall setup ","Saved setup ","0","Usage","mask = digio.writeprotect","digio.writeprotect = mask","mask","Sets the value that specifies the bit pattern for write‑protect","Details","Bits that are set to one cause the corresponding line to be write‑protected.","The binary equivalent of mask indicates the mask to be set for the I/O port. For example, a mask value of 7 has a binary equivalent of 00000000000111. This mask write‑protects lines 1, 2, and 3.","Example","digio.writeprotect = 15","Write‑protects lines 1, 2, 3, and 4.","Also see","digio.writebit()","digio.writeport()","digio.writeprotect","14682.html");
+Page[120]=new Array("This function clears all lines of the display.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","display.clear()","Details","This function switches to the user screen and then clears the display.","The display.clear(), display.setcursor(), and display.settext() functions are overlapped, nonblocking commands. That is, the script does not wait for one of these commands to complete. These nonblocking functions do not immediately update the display. For performance considerations, they update the physical display as soon as processing time becomes available.","Also see","display.setcursor()","display.settext()","display.clear()","14699.html");
+Page[121]=new Array("This function reads the annunciators (indicators) that are presently turned on.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","annunciators = display.getannunciators()","annunciators","The bitmasked value that shows which indicators are turned on","Details","This function returns a bitmasked value showing which indicators are turned on. The 16‑bit binary equivalent of the returned value is the bitmask. The return value is a sum of set annunciators, based on the weighted value, as shown in the following table.","Annunciator (indicator) bitmasked values and equivalent constants","Indicator","Bit","Weighted value","Equivalent constant","FILT","1","1","display.ANNUNCIATOR_FILTER","MATH","2","2","display.ANNUNCIATOR_MATH","4W","3","4","display.ANNUNCIATOR_4_WIRE","AUTO","4","8","display.ANNUNCIATOR_AUTO","ARM","5","16","display.ANNUNCIATOR_ARM","TRIG","6","32","display.ANNUNCIATOR_TRIGGER","* (star)","7","64","display.ANNUNCIATOR_STAR","SMPL","8","128","display.ANNUNCIATOR_SAMPLE","EDIT","9","256","display.ANNUNCIATOR_EDIT","ERR","10","512","display.ANNUNCIATOR_ERROR","REM","11","1024","display.ANNUNCIATOR_REMOTE","TALK","12","2048","display.ANNUNCIATOR_TALK ","LSTN","13","4096","display.ANNUNCIATOR_LISTEN","SRQ","14","8192","display.ANNUNCIATOR_SRQ","REAR","15","16384","display.ANNUNCIATOR_REAR","REL","16","32768","display.ANNUNCIATOR_REL","Example 1","testAnnunciators = display.getannunciators()","print(testAnnunciators)","rem = bit.bitand(testAnnunciators, 1024)","if rem > 0 then"," print("REM is on")","else"," print("REM is off")","end","REM indicator is turned on.","Output:","1.28000e+03","REM is on","Example 2","print(display.ANNUNCIATOR_EDIT)","print(display.ANNUNCIATOR_TRIGGER)","print(display.ANNUNCIATOR_AUTO)","Output:","2.56000e+02","3.20000e+01","8.00000e+00","Also see","bit.bitand()","display.getannunciators()","14719.html");
+Page[122]=new Array("This function reads the present position of the cursor on the front panel display.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","row, column, style = display.getcursor()","row","The row where the cursor is: 1 (top row); 2 (bottom row)","column","The column where the cursor is:","If the cursor is in the top row: 1 to 20","If the cursor is in the bottom row: 1 to 32","style","Visibility of the cursor: 0 (invisible cursor); 1 (blinking cursor)","Details","This function switches the display to the user screen (the text set by display.settext()), and then returns values to indicate the cursor's row and column position and cursor style.","Columns are numbered from left to right on the display.","Example 1","testRow, testColumn = display.getcursor()","print(testRow, testColumn)","This example reads the cursor position into local variables and prints them. Example output:","1.00000e+00 1.00000e+00","Example 2","print(display.getcursor())","This example prints the cursor position directly. In this example, the cursor is in row 1 at column 3, with an invisible cursor:","1.00000e+00 3.00000e+00 0.00000e+00","Also see","display.gettext()","display.screen","display.setcursor()","display.settext()","display.getcursor()","14700.html");
+Page[123]=new Array("This function retrieves the key code for the last pressed key.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","keyCode = display.getlastkey()","keyCode","A returned value that represents the last front-panel key pressed; see Details for more information","Details","A history of the key code for the last pressed front‑panel key is maintained by the instrument. When the instrument is turned on, or when it is transitioning from local to remote operation, the key code is set to 0 (display.KEY_NONE).","Pressing the EXIT (LOCAL) key normally aborts a script. To use this function with the EXIT (LOCAL) key, display.locallockout must be used.","The table below lists the keyCode value for each front‑panel action.","Key codes","Value","Key list","Value","Key list","0","display.KEY_NONE","82","display.KEY_ENTER","65","display.KEY_RANGEUP","85","display.KEY_RECALL","68","display.KEY_MENU","86","display.KEY_MEASA","69","display.KEY_MODEA","87","display.KEY_DIGITSA","70","display.KEY_RELA","92","display.KEY_TRIG","71","display.KEY_RUN","93","display.KEY_LIMITA","72","display.KEY_DISPLAY","94","display.KEY_SPEEDA","73","display.KEY_AUTO","95","display.KEY_LOAD","75","display.KEY_EXIT","97","display.WHEEL_ENTER","77","display.KEY_FILTERA","103","display.KEY_RIGHT","78","display.KEY_STORE","104","display.KEY_LEFT","79","display.KEY_SRCA","107","display.WHEEL_LEFT","80","display.KEY_CONFIG","114","display.WHEEL_RIGHT","81","display.KEY_RANGEDOWN","@ When using this function, use built-in constants such as display.KEY_RIGHT (rather than the numeric value of 103). This will allow for better forward compatibility with firmware revisions.","The OUTPUT ON/OFF control cannot be tracked by this function.","Example","key = display.getlastkey()","print(key)","On the front panel, press the MENU key and then send the code to the left. This retrieves the key code for the last pressed key.","Output:","6.80000e+01","Also see","display.locallockout","display.sendkey()","display.getlastkey()","17047.html");
+Page[124]=new Array("This function reads the text displayed on the instrument front panel.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","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)","text","The returned value, which contains the text that is presently displayed","embellished","Indicates type of returned text: false (simple text); true (text with embedded character codes)","row","Selects the row from which to read the text: 1 (row 1); 2 (row 2). If row is not included, both rows of text are read","columnStart","Selects the first column from which to read text; for row 1, the valid column numbers are 1 to 20; for row 2, the valid column numbers are 1 to 32; if nothing is selected, 1 is used","columnEnd","Selects the last column from which to read text; for row 1, the valid column numbers are 1 to 20; for row 2, the valid column numbers are 1 to 32; the default is 20 for row 1, and 32 for row 2","Details","Using the command without any parameters returns both lines of the display.","The $N character code is included in the returned value to show where the top line ends and the bottom line begins. This is not affected by the value of embellished.","When embellished is set to true, all other character codes are returned along with the message. When embellished is set to false, only the message and the $N character code is returned. For information on the embedded character codes, see display.settext().","The display is not switched to the user screen (the screen set using display.settext()). Text will be read from the active screen.","Example 1","display.clear()","display.setcursor(1, 1)","display.settext("ABCDEFGHIJ$DKLMNOPQRST")","display.setcursor(2, 1)","display.settext("abcdefghijklm$Bnopqrstuvwxyz$F123456")","print(display.gettext())","print(display.gettext(true))","print(display.gettext(false, 2))","print(display.gettext(true, 2, 9))","print(display.gettext(false, 2, 9, 10))","This example shows how to retrieve the display text in multiple ways. The output is:","ABCDEFGHIJKLMNOPQRST$Nabcdefghijklmnopqrstuvwxyz123456","$RABCDEFGHIJ$DKLMNOPQRST$N$Rabcdefghijklm$Bnopqrstuvwxyz$F123456","abcdefghijklmnopqrstuvwxyz123456","$Rijklm$Bnopqrstuvwxyz$F123456","ij","Example 2","display.clear()","display.settext("User Screen")","text = display.gettext()","print(text)","This outputs all text in both lines of the display:","User Screen $N","This indicates that the message “User Screen” is on the top line. The bottom line is blank.","Also see","display.clear()","display.getcursor()","display.setcursor()","display.settext()","display.gettext()","14702.html");
+Page[125]=new Array("This function displays a formatted input field on the instrument display that the operator can edit.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","display.inputvalue(format)","display.inputvalue(format, default)","display.inputvalue(format, default, minimum)","display.inputvalue(format, default, minimum, maximum)","format","A string that defines how the input field is formatted; see Details for more information","default","The default value for the input value","minimum","The minimum input value","maximum","The maximum input value","Details","The format parameter uses zeros (0), the decimal point, polarity sign, and exponents to define how the input field is formatted. The format parameter can include the options shown in the following table.","Option","Description","Examples","E","Include the E to display the value exponentially","0.00000e+0","+","Allows operators to enter positive or negative values; if the "+" sign is not included, the operator cannot enter a negative value","+0.00","0","Defines the digit positions for the value; you can use up to six zeros (0)","+00.0000e+00",".","Include to have a decimal point appear in the value","+0.00","The default parameter is the value shown when the value is first displayed.","The minimum and maximum parameters can be used to limit the values that can be entered. When + is not selected for format, the minimum limit must be more than or equal to zero (0). When limits are used, you cannot enter values above or below these limits.","The input value is limited to ±1e37.","Before calling display.inputvalue(), you should send a message prompt to the operator using display.prompt(). Make sure to position the cursor where the edit field should appear.","After this command is sent, script execution pauses until you enter a value and press the ENTER key.","For positive and negative entry (plus sign (+) used for the value field and/or the exponent field), polarity of a nonzero value or exponent can be toggled by positioning the cursor on the polarity sign and turning the navigation wheel @. Polarity will also toggle when using the navigation wheel @ to decrease or increase the value or exponent past zero. A zero (0) value or exponent (for example, +00) is always positive and cannot be toggled to negative polarity.","After executing this command and pressing the EXIT (LOCAL) key, the function returns nil.","Example","display.clear()","display.settext("Enter value between$N -0.10 and 2.00: ")","value = display.inputvalue("+0.00", 0.5, -0.1, 2.0)","print("Value entered = ", value)","Displays an editable field (+0.50) for operator input. The valid input range is -0.10 to +2.00, with a default of 0.50.","Output:","Value entered = 1.35000e+00","Also see","display.prompt()","display.setcursor()","display.settext()","display.inputvalue()","14703.html");
+Page[126]=new Array("This function adds an entry to the User menu, which can be accessed by pressing the LOAD key on the instrument front panel.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","display.loadmenu.add(displayName, code)","display.loadmenu.add(displayName, code, memory)","displayName","The name that is added to the User menu","code","The code that is run from the User menu","memory","Determines if code is saved to nonvolatile memory:","0 or display.DONT_SAVE: Does not save the code to nonvolatile memory","1 or display.SAVE: Saves the code to nonvolatile memory (default)","Details","After adding code to the load menu, you can run it from the front panel by pressing the LOAD key, then selecting USER to select from the available code to load. Pressing the RUN key will then run the script.","You can add items in any order. They are always displayed in alphabetical order when the menu is selected.","Any Lua code can be can be included in the code parameter. If memory is set to display.SAVE, the entry (name and code) is saved in nonvolatile memory. Scripts, functions, and variables used in the code are not saved by display.SAVE. Functions and variables need to be saved with the code. If the code is not saved in nonvolatile memory, it will be lost when the Model 2657A is turned off. See Example 2 below.","If you do not make a selection for memory, the code is automatically saved to nonvolatile memory.","@ You can create a script that defines several functions, and then use the display.loadmenu.add() command to add items that call those individual functions. This allows the operator to run tests from the front panel.","Example 1","display.loadmenu.add("Test9", "Test9()")","Assume a user script named "Test9" has been loaded into the run-time environment. Adds the menu entry to the User menu to run the script after loading.","Example 2","display.loadmenu.add("," "Test", "DUT1() beeper.beep(2, 500)", display.SAVE)","Assume a script with a function named “DUT1” has already been loaded into the instrument, and the script has NOT been saved in nonvolatile memory.","Now assume you want to add a test named “Test” to the USER TESTS menu. You want the test to run the function named “DUT1” and sound the beeper. This example adds “Test” to the menu, defines the code, and then saves the displayName and code in nonvolatile memory.","When “Test” is run from the front panel USER TESTS menu, the function named “DUT1” executes and the beeper beeps for two seconds.","Now assume you turn off instrument power. Because the script was not saved in nonvolatile memory, the function named “DUT1” is lost when you turn the instrument on. When “Test” is again run from the front panel, an error is generated because DUT1 no longer exists in the instrument as a function.","Example 3","display.loadmenu.add("Part1", "testpart([[Part1]], 5.0)", display.SAVE)","Adds an entry called “Part1” to the front panel “USER TESTS” load menu for the code testpart([[Part1]], 5.0), and saves it in nonvolatile memory.","Also see","display.loadmenu.delete()","display.loadmenu.add()","19382.html");
+Page[127]=new Array("This function creates an iterator for the user menu items accessed using the LOAD key on the instrument front panel.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","for displayName in display.loadmenu.catalog() do body end","for displayName, code in display.loadmenu.catalog() do body end","displayName","The name displayed in the menu","code","The code associated with the displayName","body","The body of the code to process the entries in the loop","Details","Each time through the loop, displayName and code will take on the values in the User menu.","The instrument goes through the list in random order.","Example","for displayName, code in display.loadmenu.catalog() do"," print(displayName, code)","end","Output:","Test DUT1() beeper.beep(2, 500)","Part1 testpart([[Part1]], 5.0)","Test9 Test9()","Also see","display.loadmenu.add()","display.loadmenu.delete()","display.loadmenu.catalog()","14705.html");
+Page[128]=new Array("This function removes an entry from the User menu, which can be accessed using the LOAD key on the instrument front panel.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","display.loadmenu.delete(displayName)","displayName","The name to be deleted from the User menu","Details","If you delete an entry from the User menu, you can no longer run it by pressing the LOAD key.","Example","display.loadmenu.delete("Test9")","for displayName, code in display.loadmenu.catalog() do"," print(displayName, code)","end","Deletes the entry named "Test9"","Output:","Test DUT1() beeper.beep(2, 500)","Part1 testpart([[Part1]], 5.0) ","Also see","display.loadmenu.add()","display.loadmenu.catalog()","display.loadmenu.delete()","14706.html");
+Page[129]=new Array("This attribute describes whether or not the EXIT (LOCAL) key on the instrument front panel is enabled.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Power cycle","Not saved","0 (display.UNLOCK)","Usage","lockout = display.locallockout","display.locallockout = lockout"," ","lockout","0 or display.UNLOCK: Unlocks EXIT (LOCAL) key","1 or display.LOCK: Locks out EXIT (LOCAL) key","Details","Set display.locallockout to display.LOCK to prevent the user from interrupting remote operation by pressing the EXIT (LOCAL) key.","Set this attribute to display.UNLOCK to allow the EXIT (LOCAL) key to interrupt script/remote operation.","Example","display.locallockout = display.LOCK","Disables the front‑panel EXIT (LOCAL) key.","Also see","None","display.locallockout","14707.html");
+Page[130]=new Array("This function presents a menu on the front panel display.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","selection = display.menu(name, items)","selection","Name of the variable that holds the menu item selected","name","Menu name to display on the top line","items","Menu items to display on the bottom line","Details","The menu consists of the menu name string on the top line, and a selectable list of items on the bottom line. The menu items must be a single string with each item separated by whitespace. The name for the top line is limited to 20 characters.","After sending this command, script execution pauses for the operator to select a menu item. An item is selected by rotating the navigation wheel @ to place the blinking cursor on the item, and then pressing the navigation wheel @ (or the ENTER key). When an item is selected, the text of that selection is returned.","Pressing the EXIT (LOCAL) key will not abort the script while the menu is displayed, but it will return nil. The script can be aborted by calling the exit function when nil is returned.","Example","selection = display.menu("Menu", "Test1 Test2 Test3")","print(selection)","Displays a menu with three menu items. If the second menu item is selected, selection is given the value Test2.","Output:","Test2","Also see","None","display.menu()","14708.html");
+Page[131]=new Array("This attribute controls whether the front panel keys act as a numeric keypad during value entry.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Recall setup","Saved setup","1 (display.ENABLE)","Usage","numericKeypad = display.numpad","display.numpad = numericKeypad","numericKeypad","Enable the numeric keypad feature (1 or display.ENABLE)","Disable the numeric keypad feature (0 or display.DISABLE)","Details","The numeric keypad feature is only available when editing a numeric value at the same time that the EDIT indicator is lit.","Example","display.numpad = display.ENABLE","Turn on the numeric keypad feature.","Also see","Setting a value","display.numpad","14709.html");
+Page[132]=new Array("This function prompts the user to enter a parameter from the front panel of the instrument.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","display.prompt(format, units, help)","display.prompt(format, units, help, default)","display.prompt(format, units, help, default, minimum)","display.prompt(format, units, help, default, minimum, maximum)","format","A string that defines how the input field is formatted; see Details for more information","units","Set the units text string for the top line (eight characters maximum); this indicates the units (for example, "V" or "A") for the value","help","Text string to display on the bottom line (32 characters maximum)","default","The value that is shown when the value is first displayed","minimum","The minimum input value that can be entered","maximum","The maximum input value that can be entered (must be more than minimum)","Details","This function creates 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 parameter uses zeros (0), the decimal point, polarity sign, and exponents to define how the input field is formatted.","The format parameter can include the options shown in the following table.","Option","Description","Examples","E","Include the E to display the value exponentially. Include a plus sign (+) for positive/negative exponent entry. Do not include the plus sign (+) to prevent negative value entry. 0 defines the digit positions for the exponent.","0.00000E+0","+","Allows operators to enter positive or negative values. If the plus sign (+) is not included, the operator cannot enter a negative value.","+0.00","0","Defines the digit positions for the value. You can use up to six zeros (0).","+00.0000E+00",".","The decimal point where needed for the value.","+0.00","The minimum and maximum parameters can be used to limit the values that can be entered. When a plus sign (+) is not selected for format, the minimum limit must be greater than or equal to zero (0). When limits are used, the operator cannot enter values above or below these limits.","The input value is limited to ±1e37.","After sending this command, script execution pauses for the operator to enter a value and press ENTER.","For positive and negative entry (plus sign (+) used for the value field and the exponent field), polarity of a nonzero value or exponent can be toggled by positioning the cursor on the polarity sign and turning the navigation wheel @. Polarity will also toggle when using the navigation wheel @ to decrease or increase the value or exponent past zero. A zero value or exponent (for example, +00) is always positive and cannot be toggled to negative polarity.","After executing this command and pressing the EXIT (LOCAL) key, the value returns nil.","Example","value = display.prompt("0.00", "V", "Input 0 to +2V", 0.5, 0, 2)","print(value)","The above command prompts the operator to enter a voltage value. The valid input range is 0 to +2.00, with a default of 0.50:","0.50V","Input 0 to +2V","If the operator enters 0.70, the output is:","7.00000e-01","Also see","display.inputvalue()","display.prompt()","14740.html");
+Page[133]=new Array("This attribute contains the selected display screen.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Recall setup","Saved setup","0 (display.SMUA)","Usage","displayID = display.screen","display.screen = displayID","displayID","One of the following values:","0 or display.SMUA: Displays source-measure and compliance limit","3 or display.USER: Displays the user screen","Details","Setting this attribute selects the display screen for the front panel. This performs the same action as pressing the DISPLAY key on the front panel. The text for the display screen is set by display.settext().","Read this attribute to determine which of the available display screens was last selected.","Example","display.screen = display.SMUA","Selects the source-measure and compliance limit display for the SMU.","Also see","display.settext()","display.screen","14741.html");
+Page[134]=new Array("This function sends a code that simulates the action of a front panel control.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","display.sendkey(keyCode)","keyCode","A parameter that specifies the key to virtually press; see Details for more information","Details","This command simulates the pressing of a front panel key or navigation wheel, or the turning the navigation wheel one click to the left or right.","Key codes","Value","Key list","Value","Key list","0","display.KEY_NONE","82","display.KEY_ENTER","65","display.KEY_RANGEUP","85","display.KEY_RECALL","68","display.KEY_MENU","86","display.KEY_MEASA","69","display.KEY_MODEA","87","display.KEY_DIGITSA","70","display.KEY_RELA","88","display.KEY_OUTPUTA","71","display.KEY_RUN","92","display.KEY_TRIG","72","display.KEY_DISPLAY","93","display.KEY_LIMITA","73","display.KEY_AUTO","94","display.KEY_SPEEDA","75","display.KEY_EXIT","95","display.KEY_LOAD","77","display.KEY_FILTERA","97","display.WHEEL_ENTER","78","display.KEY_STORE","103","display.KEY_RIGHT","79","display.KEY_SRCA","104","display.KEY_LEFT","80","display.KEY_CONFIG","107","display.WHEEL_LEFT","81","display.KEY_RANGEDOWN","114","display.WHEEL_RIGHT","@ When using this function, use built-in constants such as display.KEY_RIGHT (rather than the numeric value of 103). This will allow for better forward compatibility with firmware revisions.","Example","display.sendkey(display.KEY_RUN)","Simulates pressing the RUN key.","Also see","Front panel","display.sendkey()","17055.html");
+Page[135]=new Array("This function sets the position of the cursor.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","display.setcursor(row, column)","display.setcursor(row, column, style)","row","The row number for the cursor (1 or 2)","column","The active column position to set; row 1 has columns 1 to 20, row 2 has columns 1 to 32","style","Set the cursor to invisible (0, default) or blinking (1)","Details","Sending this command selects the user screen and then moves the cursor to the given location.","The display.clear(), display.setcursor(), and display.settext() functions are overlapped, nonblocking commands. That is, the script does not wait for one of these commands to complete. These nonblocking functions do not immediately update the display. For performance considerations, they update the physical display as soon as processing time becomes available.","An out‑of-range parameter for row sets the cursor to row 2. An out‑of‑range parameter for column sets the cursor to column 20 for row 1, or 32 for row 2.","An out‑of‑range parameter for style sets it to 0 (invisible).","A blinking cursor is only visible when it is positioned over displayed text. It cannot be seen when positioned over a space character.","Example","display.clear()","display.setcursor(1, 8)","display.settext("Hello")","display.setcursor(2, 14)","display.settext("World")","This example displays a message on the instrument front panel, approximately center. Note that the top line of text is larger than the bottom line of text.","The front panel of the instrument displays "Hello" on the top line and "World" on the second line.","Also see","display.clear()","display.getcursor()","display.gettext()","display.screen","display.settext()","display.setcursor()","14711.html");
+Page[136]=new Array("This function displays text on the user screen.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","display.settext(text)","text","Text message to be displayed, with optional character codes","Details","This function selects the user display screen and displays the given text.","After the instrument is turned on, the first time you use a display command to write to the display, the message "User Screen" is cleared. After the first write, you need to use display.clear() to clear the message.","The display.clear(), display.setcursor(), and display.settext() functions are overlapped, nonblocking commands. That is, the script does not wait for one of these commands to complete. These nonblocking functions do not immediately update the display. For performance considerations, they update the physical display as soon as processing time becomes available.","The text starts at the present cursor position. After the text is displayed, the cursor is after the last character in the display message.","Top line text does not wrap to the bottom line of the display automatically. Any text that does not fit on the current line is truncated. If the text is truncated, the cursor remains 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:","Display character codes","Character Code","Description","$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 intensity, nonblinking","$B","Sets text to blink","$D","Sets text to dim intensity","$F","Sets the text to background blink","$$","Escape sequence to display a single dollar symbol ($)","Example","display.clear()","display.settext("Normal $BBlinking$N")","display.settext("$DDim $FBackgroundBlink$R $$$$ 2 dollars")","This example sets the display to:","Normal Blinking","Dim BackgroundBlink $$ 2 dollars","with the named effect on each word.","Also see","display.clear()","display.getcursor()","display.gettext()","display.screen","display.setcursor()","display.settext()","14712.html");
+Page[137]=new Array("This attribute sets the display resolution of the selected measurement.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Recall setup","Saved setup","5 (display.DIGITS_5_5)","Usage","digits = display.smuX.digits","display.smuX.digits = digits","digits","Set digits to one of the following values:","Select 4-1/2 digit resolution (4 or display.DIGITS_4_5)","Select 5-1/2 digit resolution (5 or display.DIGITS_5_5)","Select 6-1/2 digit resolution (6 or display.DIGITS_6_5)","X","Source‑measure unit (SMU) channel (for example, display.smua.digits applies to SMU channel A)","Details","This attribute sets the display resolution.","Example","display.smua.digits = display.DIGITS_5_5","Select 5-1/2 digit resolution for SMU A.","Also see","Display resolution","display.smuX.digits","14713.html");
+Page[138]=new Array("This attribute specifies the type of limit value setting displayed.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Recall setup","Saved setup","0 (display.LIMIT_IV)","Usage","func = display.smuX.limit.func","display.smuX.limit.func = func","func","One of the following values:","0 or display.LIMIT_IV: Displays the primary limit setting","1 or display.LIMIT_P: Displays the power limit setting","X","Source‑measure unit (SMU) channel (for example, display.smua.limit.func applies to SMU channel A)","Details","Selects the displayed limit function: primary (IV) or power (P). ","Example","display.smua.limit.func = display.LIMIT_P","Specifies the power limit value is displayed for SMU Channel A.","Also see","display.smuX.measure.func","display.smuX.limit.func","20584.html");
+Page[139]=new Array("This attribute specifies the type of measurement being displayed.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Recall setup","Saved setup","1 (display.MEASURE_DCVOLTS)","Usage","func = display.smuX.measure.func","display.smuX.measure.func = func","func","One of the following values:","0 or display.MEASURE_DCAMPS: Selects current measure function","1 or display.MEASURE_DCVOLTS: Selects volts measure function","2 or display.MEASURE_OHMS: Selects ohms measure function","3 or display.MEASURE_WATTS: Selects power measure function","X","Source‑measure unit (SMU) channel (for example, display.smua.measure.func applies to SMU channel A)","Details","Selects the displayed measurement function: Amperes, volts, ohms, or watts.","Example","display.smua.measure.func = display.MEASURE_DCAMPS","Selects the current measure function for SMU A.","Also see","display.smuX.limit.func","display.smuX.measure.func","14714.html");
+Page[140]=new Array("This function clears the front‑panel trigger event detector.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","display.trigger.clear()","Details","The trigger event detector remembers if an event has been detected since the last display.trigger.wait() call. This function clears the trigger’s event detector and discards the previous history of TRIG key presses.","This attribute also clears the display.trigger.overrun attribute.","Also see","display.trigger.overrun","display.trigger.wait()","display.trigger.clear()","14715.html");
+Page[141]=new Array("This constant is the event ID of the event generated when the front‑panel TRIG key is pressed.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Constant","Yes","Usage","eventID = display.trigger.EVENT_ID","eventID","The trigger event number","Details","Set the stimulus of any trigger event detector to the value of this constant to have it respond to front-panel trigger key events.","Also see","None","display.trigger.EVENT_ID","14716.html");
+Page[142]=new Array("This attribute contains the event detector overrun status.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Display trigger clear Instrument reset Recall setup","Not saved","false","Usage","overrun = display.trigger.overrun","overrun","The trigger overrun state","Details","Indicates if a trigger event was ignored because the event detector was already in the detected state when the TRIG button was pressed.","Indicates the overrun state of the event detector built into the display.","This attribute does not indicate whether an overrun occurred in any other part of the trigger model or in any other detector that is monitoring the event.","Example","overrun = display.trigger.overrun","Sets the variable overrun equal to the present state of the event detector built into the display. ","Also see","display.trigger.clear()","display.trigger.overrun","14739.html");
+Page[143]=new Array("This function waits for the TRIG key on the front panel to be pressed.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","triggered = display.trigger.wait(timeout)","triggered","true: Trigger was detected","false: The operation timed out","timeout","Timeout in seconds","Details","If the trigger key was previously pressed and one or more trigger events were detected, this function returns immediately.","After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.","Use the display.trigger.clear() call to clear the trigger event detector.","Example","triggered = display.trigger.wait(5)","print(triggered)","Waits up to five seconds for the TRIG key to be pressed. If TRIG is pressed within five seconds, the output is true. If not, the output is false.","Also see","display.trigger.clear()","display.trigger.wait()","14717.html");
+Page[144]=new Array("This function captures the key code value for the next front‑panel action.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","keyCode = display.waitkey()","keyCode","See Details for more information","Details","After you send this function, script execution pauses until a front‑panel action (for example, pressing a key or the navigation wheel @, or turning the navigation wheel @). After the action, the value of the key (or action) is returned.","If the EXIT (LOCAL) key is pressed while this function is waiting for a front‑panel action, the script is not aborted.","The table below lists the keyCode value for each front panel action.","Key codes","Value","Key (or action)","Value","Key (or action)","0","display.KEY_NONE","82","display.KEY_ENTER","65","display.KEY_RANGEUP","85","display.KEY_RECALL","68","display.KEY_MENU","86","display.KEY_MEASA","69","display.KEY_MODEA","86","display.KEY_DIGITSA","70","display.KEY_RELA","88","display.KEY_OUTPUTA","71","display.KEY_RUN","92","display.KEY_TRIG","72","display.KEY_DISPLAY","93","display.KEY_LIMITA","73","display.KEY_AUTO","94","display.KEY_SPEEDA","75","display.KEY_EXIT","95","display.KEY_LOAD","77","display.KEY_FILTERA","97","display.WHEEL_ENTER","78","display.KEY_STORE","103","display.KEY_RIGHT","79","display.KEY_SRCA","104","display.KEY_LEFT","80","display.KEY_CONFIG","107","display.WHEEL_LEFT","81","display.KEY_RANGEDOWN","114","display.WHEEL_RIGHT","@ When using this function, use built-in constants such as display.KEY_RIGHT (rather than the numeric value of 103). This will allow for better forward compatibility with firmware revisions.","Example","key = display.waitkey()","print(key)","Pause script execution until the operator presses a key or the navigation wheel, or rotates the navigation wheel.","If the output is:","8.60000e+01","It indicates that the MEAS(A) key was pressed.","Also see","display.getlastkey()","display.sendkey()","display.settext()","Capturing key-press codes","display.waitkey()","21607.html");
+Page[145]=new Array("This function clears all entries out of the error queue.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","errorqueue.clear()","Details","See the Error queue topic for additional information about the error queue.","Also see","Error queue","errorqueue.count","errorqueue.next()","errorqueue.clear()","14749.html");
+Page[146]=new Array("This attribute gets the number of entries in the error queue.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Power cycle Clearing error queue Reading error messages","Not applicable","Not applicable","Usage","count = errorqueue.count","count","The number of entries in the error queue","Example","count = errorqueue.count","print(count)","Returns the number of entries in the error queue.","The output below indicates that there are four entries in the error queue:","4.00000e+00","Also see","errorqueue.clear()","errorqueue.next()","errorqueue.count","14750.html");
+Page[147]=new Array("This function reads the oldest entry from the error queue and removes it from the queue.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","errorCode, message, severity, errorNode = errorqueue.next()","errorCode","The error code number for the entry","message","The message that describes the error code","severity","The severity level (0, 10, 20, 30, or 40); see Details for more information","errorNode","The node number where the error originated","Details","Entries are stored in a first-in, first-out (FIFO) queue. This functions reads the oldest entry and removes it from the queue.","Error codes and messages are listed in the Error summary list.","If there are no entries in the queue, code 0, "Queue is Empty" is returned.","Returned severity levels are described in the following table.","Severity level descriptions","Number","Level","Description","0 ","Informational","Indicates that there are no entries in the queue.","10 ","Informational","Indicates a status message or minor error.","20","Recoverable","Indicates possible invalid user input; operation continues but action should be taken to correct the error.","30","Serious","Indicates a serious error that may require technical assistance, such as corrupted data.","40","Fatal","Indicates that the Model 2657A is nonoperational and requires service. Contact information for service is provided at the front of this manual. Examples: “Bad SMU AFPGA image size,” “SMU is unresponsive,” and “Communication Timeout with DFPGA.”","In an expanded system, each TSP‑Link enabled instrument is assigned a node number. The variable errorNode stores the node number where the error originated.","Example","errorcode, message = errorqueue.next()","print(errorcode, message)","Reads the oldest entry in the error queue. The output below indicates that the queue is empty.","Output:","0.00000e+00 Queue Is Empty","Also see","Error queue","errorqueue.clear()","errorqueue.count","Error summary list","errorqueue.next()","17242.html");
+Page[148]=new Array("This function returns all entries from the event log as a single string and removes them from the event log.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","logString = eventlog.all()","logString","A listing of all event log entries","Details","This function returns all events in the event log. Logged items are shown from oldest to newest. The response is a string that has the messages delimited with a new line character.","This function also clears the event log.","If there are no entries in the event log, this function returns the value nil.","Example","print(eventlog.all())","Get and print all entries from the event log and remove the entries from the log.","Output:","17:26:35.690 10 Oct 2007, LAN0, 192.168.1.102, LXI, 0, 1192037132, 1192037155.733269000, 0, 0x0","17:26:39.009 10 Oct 2007, LAN5, 192.168.1.102, LXI, 0, 1192037133, 1192037159.052777000, 0, 0x0","Also see","eventlog.clear()","eventlog.count","eventlog.enable","eventlog.next()","eventlog.overwritemethod","eventlog.all()","14756.html");
+Page[149]=new Array("This function clears the event log.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","eventlog.clear()","Details","This function erases any messages in the event log.","Also see","eventlog.all()","eventlog.count","eventlog.enable","eventlog.next()","eventlog.overwritemethod","eventlog.clear()","14758.html");
+Page[150]=new Array("This attribute gets the number of events contained in the event log.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Instrument reset Clearing event log Reading event log","Not applicable","Not applicable","Usage","N = eventlog.count","N","The number of events in the event log","Example","print(eventlog.count)","Displays the present number of events contained in the Model 2657A event log.","Output looks similar to:","3.00000e+00","Also see","eventlog.all()","eventlog.clear()","eventlog.enable","eventlog.next()","eventlog.overwritemethod","eventlog.count","14757.html");
+Page[151]=new Array("This attribute enables or disables the event log.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Recall setup","Not saved","1 (eventlog.ENABLE)","Usage","status = eventlog.enable","eventlog.enable = status","status","The enable status of the event log:","1 or eventlog.ENABLE: Event log enable","0 or eventlog.DISABLE: Event log disable","Details","When the event log is disabled (eventlog.DISABLE or 0), no new events are added to the event log. You can, however, read and remove existing events.","When the event log is enabled, new events are logged.","Example","print(eventlog.enable)","eventlog.enable = eventlog.DISABLE","print(eventlog.enable)","Displays the present status of the Model 2657A event log.","Output:","1.00000e+00","0.00000e+00","Also see","eventlog.all()","eventlog.clear()","eventlog.count","eventlog.next()","eventlog.overwritemethod","eventlog.enable","14760.html");
+Page[152]=new Array("This function returns the oldest message from the event log and removes it from the log.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","logString = eventlog.next()","logString","The next log entry","Details","Returns the next entry from the event log and removes it from the log.","If there are no entries in the event log, returns the value nil.","Example 1","print(eventlog.next())","Get the oldest message in the event log and remove that entry from the log.","Output:","17:28:22.085 10 Oct 2009, LAN2, 192.168.1.102, LXI, 0, 1192037134, <no time>, 0, 0x0","Example 2","print(eventlog.next())","If you send this command when there is nothing in the event log, you will get the following output:","nil","Also see","eventlog.all()","eventlog.clear()","eventlog.count","eventlog.enable","eventlog.overwritemethod","eventlog.next()","14761.html");
+Page[153]=new Array("This attribute controls how the event log processes events if the event log is full.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Recall setup","Not saved ","1 (eventlog.DISCARD_OLDEST)","Usage","method = eventlog.overwritemethod","eventlog.overwritemethod = method","method","Set to one of the following values:","0 or eventlog.DISCARD_NEWEST: New entries are not logged","1 or eventlog.DISCARD_OLDEST: Old entries are deleted as new events are logged","Details","When this attribute is set to eventlog.DISCARD_NEWEST, new entries are not logged.","When this attribute is set to eventlog.DISCARD_OLDEST, the oldest entry is discarded when a new entry is added.","Example","eventlog.overwritemethod = 0","When the log is full, the event log will ignore new entries.","Also see","eventlog.all()","eventlog.clear()","eventlog.count","eventlog.enable","eventlog.next()","eventlog.overwritemethod","14759.html");
+Page[154]=new Array("This function stops a script that is presently running.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","exit()","Details","Terminates script execution when called from a script that is being executed.","This command does not wait for overlapped commands to complete before terminating script execution. If overlapped commands are required to finish, use the waitcomplete() function before calling exit().","Also see","waitcomplete()","exit()","14769.html");
+Page[155]=new Array("This function closes the file that is represented by the fileVar variable.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","fileVar:close()","fileVar","The file descriptor variable to close","Details","This command is equivalent to io.close(fileVar).","Note that files are automatically closed when the file descriptors are garbage collected.","Also see","fileVar:flush()","fileVar:read()","fileVar:seek()","fileVar:write()","io.close()","io.open()","fileVar:close()","14772.html");
+Page[156]=new Array("This function writes buffered data to a file.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","fileVar:flush()","fileVar","The file descriptor variable to flush","Details","The fileVar:write() or io.write() functions buffer data, which may not be written immediately to the USB flash drive. Use this function to flush this data. Using this function removes the need to close a file after writing to it, allowing it to be left open to write more data. Data may be lost if the file is not closed or flushed before a script ends. ","If there is going to be a time delay before more data is written to a file, and you want to keep the file open, flush the file after you write to it to prevent loss of data.","Also see","fileVar:write()","io.open()","io.write()","fileVar:flush()","14786.html");
+Page[157]=new Array("This function reads data from a file.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","data1 = fileVar:read() ","data1 = fileVar:read(format1) ","data1, data2 = fileVar:read(format1, format2) ","data1, ..., datan = fileVar:read(format1, ..., formatn) ","data1","First data read from the file","data2","Second data read from the file","datan","Last data read from the file","fileVar","The descriptor of the file to be read","format1","A string or number indicating the first type of data to be read","format2","A string or number indicating the second type of data to be read","formatn","A string or number indicating the last type of data to be read","...","One or more entries (or values) separated by commas","Details","The format parameters may be any of the following:",""*n": Returns a number.",""*a": Returns the whole file, starting at the current position (returns an empty string if the current file position is at the end of the file).",""*l": Returns the next line, skipping the end of line; returns nil if the current file position is at the end of file.","n: Returns a string with up to n characters; returns an empty string if n is zero; returns nil if the current file position is at the end of file.","If no format parameters are provided, the function will perform as if the function is passed the value "*l".","Any number of format parameters may be passed to this command, each corresponding to a returned data value.","Also see","fileVar:write()","io.input()","io.open()","fileVar:read()","14787.html");
+Page[158]=new Array("This function sets and gets a file's current position.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","position, errorMsg = fileVar:seek()","position, errorMsg = fileVar:seek(whence)","position, errorMsg = fileVar:seek(whence, offset)","position","The new file position, measured in bytes from the beginning of the file","errorMsg","A string containing the error message","fileVar","The file descriptor variable","whence","A string indicating the base against which offset is applied; the default is "cur"","offset","The intended new position, measured in bytes from a base indicated by whence (default is 0)","Details","The whence parameters may be any of the following:",""set": Beginning of file",""cur": Current position",""end": End of file","If an error is encountered, it is logged to the error queue, and the command returns nil and the error string.","Also see","io.open()","fileVar:seek()","14788.html");
+Page[159]=new Array("This function writes data to a file.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","fileVar:write(data)","fileVar:write(data1, data2)","fileVar:write(data1, ..., datan)","fileVar","The file descriptor variable","data","Write all data to the file","data1","The first data to write to the file","data2","The second data to write to the file","datan","The last data to write to the file","...","One or more entries (or values) separated by commas","Details","This function may buffer data until a flush (fileVar:flush() or io.flush()) or close (fileVar:close() or io.close()) operation is performed.","Also see","fileVar:close()","fileVar:flush()","io.close()","io.open()","fileVar:write()","14789.html");
+Page[160]=new Array("This attribute sets the precision (number of digits) for all numbers printed with the ASCII format.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","No","Instrument reset Recall setup","Not saved ","6","Usage","precision = format.asciiprecision","format.asciiprecision = precision","precision","A number representing the number of digits to be printed for numbers printed with the print(), printbuffer(), and printnumber() functions; must be a number between 1 and 16","Details","This attribute specifies the precision (number of digits) for numeric data printed with the print(), printbuffer(), and printnumber() functions. The format.asciiprecision attribute is only used with the ASCII format. The precision value must be a number between 1 and 16.","Note that the precision is the number of significant digits printed. There is always one digit to the left of the decimal point; be sure to include this digit when setting the precision.","Example","format.asciiprecision = 10","x = 2.54","printnumber(x)","format.asciiprecision = 3","printnumber(x)","Output:","2.540000000e+00","2.54e+00","Also see","format.byteorder","format.data","print()","printbuffer()","printnumber()","format.asciiprecision","14797.html");
+Page[161]=new Array("This attribute sets the binary byte order for data printed using the printnumber() and printbuffer() functions.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Recall setup","Not saved","1 (format.LITTLEENDIAN)","Usage","order = format.byteorder","format.byteorder = order","order","Byte order value as follows:","Most significant byte first: 0, format.NORMAL, format.NETWORK, or format.BIGENDIAN","Least significant byte first: 1, format.SWAPPED or format.LITTLEENDIAN","Details","This attribute selects the byte order in which data is written when printing data values with the printnumber() and printbuffer() functions. The byte order attribute is only used with the format.SREAL, format.REAL, format.REAL32, and format.REAL64 data formats.","format.NORMAL, format.BIGENDIAN, and format.NETWORK select the same byte order. format.SWAPPED and format.LITTLEENDIAN select the same byte order. Selecting which to use is a matter of preference.","Select the format.SWAPPED or format.LITTLEENDIAN byte order when sending data to a computer with a Microsoft Windows operating system.","Example","x = 1.23","format.data = format.REAL32","format.byteorder = format.LITTLEENDIAN","printnumber(x)","format.byteorder = format.BIGENDIAN","printnumber(x)","Output depends on the terminal program you use, but will look something like:","#0¤p??","#0??p¤","Also see","format.asciiprecision","format.data","printbuffer()","printnumber()","format.byteorder","14801.html");
+Page[162]=new Array("This attribute sets the data format for data printed using the printnumber() and printbuffer() functions.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","No","Instrument reset Recall setup","Not saved ","1 (format.ASCII)","Usage","value = format.data","format.data = value","value","The format to use for data, set to one of the following values:","ASCII format: 1 or format.ASCII","Single‑precision IEEE Std 754 binary format: 2, format.SREAL, or format.REAL32","Double‑precision IEEE Std 754 binary format: 3, format.REAL, format.REAL64, or format.DREAL","Details","The precision of numeric values can be controlled with the format.asciiprecision attribute. The byte order of format.SREAL, format.REAL, format.REAL32, and format.REAL64 can be selected with the format.byteorder attribute.","REAL32 and SREAL select the same single precision format. REAL and REAL64 select the same double precision format. They are alternative identifiers. Selecting which to use is a matter of preference.","The IEEE Std 754 binary formats use four bytes each for single‑precision values and eight bytes each for double‑precision values.","When data is written with any of the binary formats, the response message starts with “#0” and ends with a new line. When data is written with the ASCII format, elements are separated with a comma and space.","@ Binary formats are not intended to be interpreted by humans.","Example","format.asciiprecision = 10","x = 3.14159265","format.data = format.ASCII","printnumber(x)","format.data = format.REAL64","printnumber(x)","Output a number represented by x in ASCII using a precision of 10, then output the same number in binary using double precision format.","Output:","3.141592650e+00","#0ñÔÈSû! @","Also see","format.asciiprecision","format.byteorder","printbuffer()","printnumber()","format.data","14803.html");
+Page[163]=new Array("This function sets the current working directory.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","workingDirectory = fs.chdir(path)","workingDirectory","Returned value containing the working path","path","A string indicating the new working directory path","Details","The new working directory path may be absolute or relative to the current working directory.","An error is logged to the error queue if the given path does not exist.","Example","testPath = fs.chdir("/usb1/")","Change the working directory to usb1.","Also see","None","fs.chdir()","14808.html");
+Page[164]=new Array("This function returns the absolute path of the current working directory.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","path = fs.cwd()","path","The absolute path of the current working directory","Also see","None","fs.cwd()","14810.html");
+Page[165]=new Array("This function tests whether or not the specified path refers to a directory.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","status = fs.is_dir(path)","status","Whether or not the given path is a directory (true or false)","path","The path of the file system entry to test","Details","The file system path may be absolute or relative to the current working system path.","Also see","fs.is_file()","fs.is_dir()","14811.html");
+Page[166]=new Array("Tests whether the specified path refers to a file (as opposed to a directory).","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","status = fs.is_file(path)","status","true if the given path is a file; otherwise, false","path","The path of the file system entry to test","Details","The file system path may be absolute or relative to the current working system path.","Also see","fs.is_dir()","fs.is_file()","14824.html");
+Page[167]=new Array("This function creates a directory at the specified path.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","path = fs.mkdir(newPath)","path","The returned path of the new directory","newpath","Location (path) of where to create the new directory","Details","The directory path may be absolute or relative to the current working directory.","An error is logged to the error queue if the parent folder of the new directory does not exist, or if a file system entry already exists at the given path.","Also see","fs.rmdir()","fs.mkdir()","14812.html");
+Page[168]=new Array("This function returns a list of the file system entries in the directory.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","files = fs.readdir(path)","files","A table containing the names of all the file system entries in the specified directory","path","The directory path","Details","The directory path may be absolute or relative to the current working directory.","This command is nonrecursive. For example, entries in subfolders are not returned.","An error is logged to the error queue if the given path does not exist or does not represent a directory.","Also see","None","fs.readdir()","14814.html");
+Page[169]=new Array("This function removes a directory from the file system.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","fs.rmdir(path)","path","The path of the directory to remove","Details","This path may be absolute or relative to the current working directory.","An error is logged to the error queue if the given path does not exist, or does not represent a directory, or if the directory is not empty.","Also see","fs.mkdir()","fs.rmdir()","14815.html");
+Page[170]=new Array("This function retrieves the local time zone.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","timeZone = gettimezone()","timeZone","The local timezone of the instrument","Details","See settimezone() for additional details on the time zone format and a description of the fields. timeZone can be in either of the following formats:","If one argument was used with settimezone(), the format used is: GMThh:mm:ss","If four arguments were used with settimezone(), the format used is: GMThh:mm:ssGMThh:mm:ss,Mmm.w.dw/hh:mm:ss,Mmm.w.dw/hh:mm:ss","Example","timezone = gettimezone()","Reads the value of the local timezone.","Also see","settimezone()","gettimezone()","15011.html");
+Page[171]=new Array("This KIParlib factory script function performs a linear current sweep and calculates the transconductance (Gm) at each point.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","gm_array, vbuf, ibuf = gm_isweep(smu, start_i, stop_i, points)","gm_array","A Lua table containing the calculated Gm values at each point","vbuf","A reading buffer containing the measured voltage at each point","ibuf","A reading buffer containing the measured current at each point","smu","System SourceMeter® instrument channel (set to smua)","start_i","Starting current level of the sweep ","stop_i","Ending current level of the sweep ","points","Number of measurements between start_i and stop_i (must be ³ 2)","Details","Output data includes transconductance values, reading buffer with measured voltages, reading buffer with measured voltages and currents.","If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.","The gm_isweep() function performs a linear current sweep, measuring voltage and current, and then calculating the transconductance (Gm) at each point using the central difference method. It can return an array of Gm values, a reading buffer with the measured voltages, and a reading buffer with the measured currents.","Example","gm_array = gm_isweep(smua, 0, 0.01, 20)","gm_array, vbuf = gm_isweep(smua, 0, 0.01, 20)","gm_array, vbuf, ibuf = gm_isweep(smua, 0,"," 0.01, 20)","Source‑measure unit (SMU) A returns Gm values only.","SMU A returns Gm and reading buffer with measured voltages.","SMU A returns Gm and reading buffers with measured voltages and currents.","Also see","gm_vsweep()","gm_isweep()","12957.html");
+Page[172]=new Array("This KIParlib factory script function performs a linear voltage sweep and calculates the transconductance (Gm) at each point.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","gm_array, ibuf, vbuf = gm_vsweep(smu, start_v, stop_v, points)","gm_array","A Lua table containing the calculated Gm values at each point","ibuf","A reading buffer containing the measured current at each point","vbuf","A reading buffer containing the measured voltage at each point","smu","System SourceMeter® instrument channel (set to smua)","start_v","Starting voltage level of the sweep ","stop_v","Ending voltage level of the sweep ","points","Number of measurements between start_v and stop_v (must be ³ 2)","Details","Output data includes transconductance values, reading buffer with measured currents, reading buffer with measured currents and voltages.","The gm_vsweep() function performs a linear voltage sweep, measuring voltage and current, and then calculating the transconductance (Gm) at each point using the central difference method. It can return an array of Gm values, a reading buffer with the measured currents, and a reading buffer with the measured voltages.","Example","gm_array = gm_vsweep(smua, 0, 10, 5)","gm_array, ibuf = gm_vsweep(smua, 0, 10, 5)","gm_array, ibuf, vbuf = gm_vsweep(smua, 0, 10, 5)","SMU A returns Gm values only.","SMU A returns Gm and reading buffer with measured currents.","SMU A returns Gm and reading buffers with measured currents and voltages.","Also see","gm_isweep()","gm_vsweep()","12955.html");
+Page[173]=new Array("This attribute contains the GPIB address.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Not applicable","Nonvolatile memory","26","Usage","address = gpib.address","gpib.address = address","address","GPIB address (0 to 30)","Details","A new GPIB address takes effect when the command to change it is processed. If there are response messages in the output queue when this command is processed, they must be read at the new address.","If command messages are being queued (sent before this command has executed), the new settings may take effect in the middle of a subsequent command message, so care should be exercised when setting this attribute from the GPIB interface.","You should allow ample time for the command to be processed before attempting to communicate with the instrument again. After sending this command, make sure to use the new address to communicate with the instrument.","The GPIB address is stored in nonvolatile memory. The reset() function has no effect on the address.","Example","gpib.address = 26","address = gpib.address","print(address)","Sets the GPIB address and reads the address.","Output:","2.600000e+01","Also see","GPIB operation","gpib.address","14860.html");
+Page[174]=new Array("This KIHighC factory script function performs a current leakage measurement after stepping the output voltage.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","imeas = i_leakage_measure(smu, levelv, limiti, sourcedelay, measurei, measuredelay)","imeas","The measured current","smu","System SourceMeter® instrument channel (set to smua)","levelv","Voltage level to step to when this function is called","limiti","Current limit setting for the voltage step","sourcedelay","Delay to wait before lowering the current limit for measurement","measurei","Current limit (and measure range); note the current limit is lower at this level and because high-capacitance mode is active, the measure range will follow","measuredelay","Delay to wait after lowering the current limit before taking the measurement","Details","This function causes the smu to:","Change its current limit to limiti with a voltage output of levelv for sourcedelay time, and then changes its current limit to measurei (that also changes the measurement range to measurei) for measuredelay time ","When measuredelay time expires, a measurement is taken and returned as imeas.","When measuring leakage current:","Charge the capacitor before calling this function (the instrument's output is usually at a nonzero voltage prior to calling this function; when measuring leakage, this function does not charge the capacitor). ","Set levelv = 0","Example","smua.source.levelv = 500","smua.source.output = smua.OUTPUT_ON","delay(1)","imeas = i_leakage_measure(smua, 0, 20e-3,"," 500e-3, 10e-6, .1)","Charge the capacitor at 500 V for 1 second set by delay(1).","The parameters passed on to the i_leakage_measure() function in this example are:","smu = smua","levelv = 0 V","limiti = 20 mA","sourcedelay = 500 ms","measurei = 10 mA range","measuredelay = 100 ms","The levels and delays will depend on the value and type of capacitor used.","Also see","i_leakage_threshold()","i_leakage_measure()","12951.html");
+Page[175]=new Array("This KIHighC factory script function measures the current and compares it to a threshold until either the measured current drops below the threshold or the timeout expires.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","f = i_leakage_threshold(smu, levelv, limiti, sourcedelay, measurei, measuredelay, threshold, timeout)","f","A Boolean flag; this flag will be true when the current is below the threshold, false if threshold is not reached before timeout expires","smu","System SourceMeter® instrument channel (set to smua)","levelv","Voltage level to step to when this function is called","limiti","Current limit setting for the voltage step","sourcedelay","Delay to wait before lowering the current limit for measurement","measurei","Current limit (and measure range); note the current limit is lower at this level and because high-capacitance mode is active, the measure range will follow","measuredelay","Delay before the first measurement after measure range is changed","threshold","The specified current that establishes the test limit","timeout","Amount of time (in seconds) to wait for the current to drop to threshold after all the delays have occurred","Details","This function causes the smu to:","Change its current limit to limiti with a voltage output of levelv for sourcedelay time, and then changes its current limit to measurei (that also changes the measurement range to measurei) for measuredelay time ","When measuredelay time expires, measurements are taken at a rate determined by the smuX.measure.nplc setting","The function returns true if threshold is reached; the function returns false if threshold is not reached before timeout expires.","When testing the leakage current threshold:","Charge the capacitor before calling this function (the instrument's output is usually at a non-zero voltage prior to calling this function; when measuring leakage, this function does not charge the capacitor).","If testing the device's leakage current threshold, set levelv = 0.","Example","smua.source.levelv = 500","smua.source.output = smua.OUTPUT_ON","delay(1)","pass = i_leakage_threshold(smua, 0, 20e-3,"," 500e-3, 10e-6, 100e-3, 1e-6, 5)","Charge the capacitor. ","The parameters passed on to the i_threshold_measure() function in this example are:","smu = smua","levelv = 0 V","limiti = 20 mA","sourcedelay = 500 ms","measurei = 10 mA range","measuredelay = 100 ms","threshold = 1 mA","timeout = 5 s","The levels and delays will depend on the value and type of capacitor used.","Sets pass = true if the current is measured below 1 mA in less than 1 second.","Also see","i_leakage_measure()","i_leakage_threshold()","12953.html");
+Page[176]=new Array("This KIPulse factory script function initiates the pulse configuration assigned to tag.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","f, msg = InitiatePulseTest(tag)","f","A Boolean flag; this flag will be true when the pulse was successfully configured, false when errors were encountered","msg","A string message; if the f flag is false, msg will contain an error message; if it is true, msg will contain a string indicating successful configuration","tag","Numeric identifier of the pulse configuration to be initiated","Details","This function will only initiate configured pulse trains assigned to a valid tag. Configure the pulse before initiating it using one of the ConfigurePulse* functions (refer to the Also see section).","Example","smua.reset()","smua.source.rangev = 200","smua.source.rangei = 0.01","smua.source.levelv = 0","smua.measure.rangev = 200","smua.measure.rangei = 0.01","smua.measure.nplc = 1","smua.measure.autozero = smua.AUTOZERO_ONCE","smua.nvbuffer1.clear()","smua.nvbuffer1.appendmode = 1","smua.source.output = smua.OUTPUT_ON","f1, msg1 = ConfigPulseVMeasureI(smua, 0,"," 100, 1e-3, 10e-3, 0.2, 10,"," smua.nvbuffer1, 1) ","if f1 == true then"," f2, msg2 = InitiatePulseTest(1)"," print("Initiate message:", msg2)","else"," print("Config errors:", msg1)","end","Configure System SourceMeter® instrument channel A to generate a pulse train. If no errors are encountered, initiate the pulse train. Channel A will pulse voltage from a bias level of 0 V to a pulse level of 100 V. The pulse level will be present for 10 ms and the bias level for 200 ms, with a 1 mA limit setting. A total of 10 pulses will be generated, and the measurement data will be stored in smua.nvbuffer1. This pulse train will be assigned to tag = 1.","Also see","ConfigPulseIMeasureV()","ConfigPulseVMeasureI()","ConfigPulseIMeasureVSweepLin()","ConfigPulseVMeasureISweepLin()","ConfigPulseIMeasureVSweepLog()","ConfigPulseVMeasureISweepLog()","InitiatePulseTest()","12929.html");
+Page[177]=new Array("This function closes a file.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes (see Details)","Usage","io.close()","io.close(file)","file","The descriptor of the file to close","Details","If a file is not specified, the default output file closes.","Only io.close(), used without specifying a parameter, can be accessed from a remote node.","Example","testFile, testError = io.open("testfile.txt", "w")","if nil == testError then"," testFile:write("This is my test file")"," io.close(testFile)","end","Opens file testfile.txt for writing. If no errors were found while opening, writes "This is my test file" and closes the file.","Also see","io.open()","io.close()","14868.html");
+Page[178]=new Array("This function saves buffered data to a file.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","io.flush()","Details","You must use the io.flush() or io.close() functions to write data to the file system.","@ Data is not automatically written to a file when you use the io.write() function. The io.write() function buffers data; it may not be written to the USB drive immediately. Use the io.flush() function to immediately write buffered data to the drive.","This function only flushes the default output file.","Using this command removes the need to close a file after writing to it and allows it to be left open to write more data. Data may be lost if the file is not closed or flushed before an application ends. To prevent the loss of data if there is going to be a time delay before more data is written (and when you want to keep the file open and not close it), flush the file after writing to it.","Also see","fileVar:flush()","fileVar:write()","io.write()","io.flush()","14870.html");
+Page[179]=new Array("This function assigns a previously opened file, or opens a new file, as the default input file.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes (see Details)","Usage","fileVar = io.input()","fileVar = io.input(newfile)","fileVar","The descriptor of the input file or an error message (if the function fails)","newfile","A string representing the path of a file to open as the default input file, or the file descriptor of an open file to use as the default input file","Details","The newfile path may be absolute or relative to the current working directory.","When using this function from a remote TSP-Link® node, this command does not accept a file descriptor and does not return a value.","If the function fails, an error message is returned.","Also see","io.open()","io.output()","io.input()","14871.html");
+Page[180]=new Array("This function opens a file for later reference.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","fileVar, errorMsg = io.open(path)","fileVar, errorMsg = io.open(path, mode)","fileVar","The descriptor of the opened file","errorMsg","Indicates whether an error was encountered while processing the function","path","The path of the file to open","mode","A string representing the intended access mode ("r" = read, "w" = write, and "a" = append)","Details","The path to the file to open may be absolute or relative to the current working directory. If you successfully open the file, errorMsg is nil and fileVar has the descriptor that can be used to access the file.","If an error is encountered, the command returns nil for fileVar and an error string.","Example","testFile, testError = io.open("testfile.txt", "w")","if testError == nil then"," testFile:write("This is my test file")"," io.close(testFile)","end","Opens file testfile.txt for writing. If no errors were found while opening, writes "This is my test file" and closes the file.","Also see","io.close()","io.open()","14872.html");
+Page[181]=new Array("This function assigns a previously opened file, or opens a new file, as the default output file.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes (see Details)","Usage","fileVar = io.output()","fileVar = io.output(newfile)","fileVar","The descriptor of the output file or an error message (if the function fails)","newfile","A file descriptor to assign (or the path of a file to open) as the default output file","Details","The path of the file to open may be absolute or relative to the current working directory.","When accessed from a remote node using the TSP-Link network, this command does not accept a file descriptor parameter and does not return a value.","If the function fails, an error message is returned.","Also see","io.input()","io.open()","io.output()","14873.html");
+Page[182]=new Array("This function reads data from the default input file.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","data1 = io.read()","data1 = io.read(format1)","data1, data2 = io.read(format1, format2)","data1, ..., dataN = io.read(format1, ..., formatN)","data1","The data read from the file","data2","The data read from the file","dataN","The data read from the file; the number of return values matches the number of format values given","format1","A string or number indicating the type of data to be read","format2","A string or number indicating the type of data to be read","formatN","A string or number indicating the type of data to be read","...","One or more entries (or values) separated by commas","Details","The format parameters may be any of the following:","Format parameter","Description",""*N"","Returns a number",""*a"","Returns the whole file, starting at the current position; returns an empty string if it is at the end of file",""*l"","Returns the next line, skipping the end of line; returns nil if the current file position is at the end of file","N","Returns a string with up to N characters; returns an empty string if N is zero (0); returns nil if the current file position is at the end of file","Any number of format parameters may be passed to this command, each corresponding to a returned data value.","If no format parameters are provided, the function will perform as if the function was passed the value "*l".","Also see","None","io.read()","14874.html");
+Page[183]=new Array("This function checks whether or not a given object is a file handle.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","type = io.type(obj)","type","Indicates whether the object is an open file handle","obj","Object to check","Details","Returns the string "file" if the object is an open file handle. If it is not an open file handle, nil is returned.","Also see","io.open()","io.type()","14875.html");
+Page[184]=new Array("This function writes data to the default output file.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","io.write()","io.write(data1)","io.write(data1, data2)","io.write(data1, ..., dataN)","data1","The data to be written","data2","The data to be written","dataN","The data to be written","...","One or more values separated by commas","Details","All data parameters must be either strings or numbers.","@ Data is not immediately written to a file when you use the io.write() function. The io.write() function buffers data; it may not be written to the USB drive immediately. Use the io.flush() function to immediately write buffered data to the drive.","Also see","io.flush()","io.write()","14877.html");
+Page[185]=new Array("This function re-initializes the LAN interface with new settings.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","lan.applysettings()","Details","Disconnects all existing LAN connections to the instrument and re-initializes the LAN with the current configuration settings.","This function initiates a background operation. LAN configuration could be a lengthy operation. Although the function returns immediately, the LAN initialization will continue to run in the background.","Even though the LAN configuration settings may not have changed since the LAN was last connected, new settings may take effect due to the dynamic nature of dynamic host configuration protocol (DHCP) or dynamic link local addressing (DLLA) configuration.","Re-initialization takes effect even if the configuration has not changed since the last time the instrument connected to the LAN.","Example","lan.applysettings()","Re-initialize the LAN interface with new settings.","Also see","None","lan.applysettings()","14890.html");
+Page[186]=new Array("This attribute is used to enable or disable link monitoring.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","LAN restore defaults","Nonvolatile memory","1 (lan.ENABLE)","Usage","state = lan.autoconnect","lan.autoconnect = state","state","LAN link monitoring state:","1 or lan.ENABLE: Enables automatic link reconnection and monitoring","0 or lan.DISABLE: Disables automatic link reconnection and monitoring","Details","This attribute sets the LAN link monitoring and automatic connection state.","When this is set to lan.ENABLE, all connections are closed if the link to the LAN is lost for more than the time specified by lan.linktimeout.","Set this attribute to lan.ENABLE to automatically reset the LAN connection after the LAN link is established.","Also see","lan.linktimeout","lan.restoredefaults()","lan.autoconnect","14891.html");
+Page[187]=new Array("Configures DNS server IP addresses.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","LAN restore defaults","Nonvolatile memory",""0.0.0.0"","Usage","dnsAddress = lan.config.dns.address[N]","lan.config.dns.address[N] = dnsAddress","dnsAddress","DNS server IP address","N","Entry index (1 or 2)","Details","This attribute is an array of DNS (domain name system) server addresses. These addresses take priority for DNS lookups and are consulted before any server addresses that are obtained using DHCP. This allows local DNS servers to be specified that take priority over DHCP‑configured global DNS servers.","You can specify up to two addresses. The address specified by 1 is consulted first for DNS lookups.","Unused entries will be returned as "0.0.0.0" when read. dnsAddress must be a string specifying the DNS server’s IP address in dotted decimal notation. To disable an entry, set its value to "0.0.0.0" or the empty string "".","Although only two address may be manually specified here, the instrument will use up to three DNS server addresses. If two are specified here, only one that is given by a DHCP server is used. If no entries are specified here, up to three addresses that are given by a DHCP server are used.","Example","dnsaddress = "164.109.48.173"","lan.config.dns.address[1] = dnsaddress","Configure DNS address 1 to "164.109.48.173"","Also see","lan.config.dns.domain","lan.config.dns.dynamic","lan.config.dns.hostname","lan.config.dns.verify","lan.restoredefaults()","lan.config.dns.address[N]","14898.html");
+Page[188]=new Array("Configures the dynamic DNS domain.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","LAN restore defaults","Nonvolatile memory","""","Usage","domain = lan.config.dns.domain","lan.config.dns.domain = domain","domain","Dynamic DNS registration domain; use a string of 255 characters or less","Details","This attribute holds the domain to request during dynamic DNS registration. Dynamic DNS registration works with DHCP to register the domain specified in this attribute with the DNS server.","The length of the fully qualified host name (combined length of the domain and host name with separator characters) must be less than or equal to 255 characters. Although up to 255 characters are allowed, you must make sure the combined length is also no more than 255 characters.","Example","print(lan.config.dns.domain)","Outputs the present dynamic DNS domain. For example, if the domain is "Matrix", the response would be:","Matrix","Also see","lan.config.dns.dynamic","lan.config.dns.hostname","lan.config.dns.verify","lan.restoredefaults()","lan.config.dns.domain","14899.html");
+Page[189]=new Array("Enables or disables the dynamic DNS registration.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","LAN restore defaults","Nonvolatile memory","1 (lan.ENABLE)","Usage","state = lan.config.dns.dynamic","lan.config.dns.dynamic = state","state","The dynamic DNS registration state. It may be one of the following values:","1 or lan.ENABLE: Enabled 0 or lan.DISABLE: Disabled","Details","Dynamic DNS registration works with DHCP to register the host name with the DNS server. The host name is specified in the lan.config.dns.hostname attribute.","Example","print(lan.config.dns.dynamic)","Outputs the dynamic registration state.","If dynamic DNS registration is enabled, the response is:","1.00000e+00","Also see","lan.config.dns.hostname","lan.restoredefaults()","lan.config.dns.dynamic","14900.html");
+Page[190]=new Array("This attribute defines the dynamic DNS host name.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Not applicable","Nonvolatile memory","Instrument specific (see Details)","Usage","hostName = lan.config.dns.hostname","lan.config.dns.hostname = hostName","hostName","The host name to use for dynamic DNS registration; the host name must:","be a string of 15 characters or less","start with a letter","end with a letter or digit","contain only letters, digits, and hyphens","Details","This attribute holds the host name to request during dynamic DNS registration. Dynamic DNS registration works with DHCP to register the host name specified in this attribute with the DNS server.","The factory default value for hostName is "k‑<model number>‑<serial number>", where <model number> and <serial number> are replaced with the actual model number and serial number of the instrument (for example, "k‑2657A‑1234567"). Note that hyphens separate the characters of hostName. ","The length of the fully qualified host name (combined length of the domain and host name with separator characters) must be less than or equal to 255 characters. Although up to 15 characters can be entered here, care must be taken to be sure the combined length is no more than 255 characters.","Setting this attribute to an empty string (in other words, setting this attribute to a string of length zero, or one consisting entirely of whitespace characters) will revert the host name to the factory default value.","Example","print(lan.config.dns.hostname)","Outputs the present dynamic DNS host name.","Also see","lan.config.dns.dynamic","lan.restoredefaults()","lan.config.dns.hostname","14901.html");
+Page[191]=new Array("This attribute defines the DNS host name verification state.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","LAN restore defaults","Nonvolatile memory","1 (lan.ENABLE)","Usage","state = lan.config.dns.verify","lan.config.dns.verify = state","state","DNS hostname verification state:","1 or lan.ENABLE: DNS host name verification enabled 0 or lan.DISABLE: DNS host name verification disabled","Details","When this is enabled, the instrument performs DNS lookups to verify that the DNS host name matches the value specified by lan.config.dns.hostname.","Example","print(lan.config.dns.verify)","Outputs the present DNS host name verification state.","If it is enabled, the output is:","1.00000e+00","Also see","lan.config.dns.hostname","lan.restoredefaults()","lan.config.dns.verify","14902.html");
+Page[192]=new Array("This attribute defines the LAN duplex mode.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","LAN restore defaults","Nonvolatile memory","1 (lan.FULL)","Usage","duplex = lan.config.duplex","lan.config.duplex = duplex","duplex","LAN duplex setting can be one of the following values:","1 or lan.FULL: Selects full-duplex operation 0 or lan.HALF: Selects half-duplex operation","Details","This attribute does not indicate the actual setting currently in effect. Use the lan.status.duplex attribute to determine the current operating state of the LAN.","Also see","lan.restoredefaults()","lan.config.duplex","14903.html");
+Page[193]=new Array("This attribute contains the LAN default gateway address.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","LAN restore defaults","Nonvolatile memory",""0.0.0.0"","Usage","gatewayAddress = lan.config.gateway","lan.config.gateway = gatewayAddress","gatewayAddress","LAN default gateway address; must be a string specifying the default gateway’s IP address in dotted decimal notation","Details","This attribute specifies the default gateway IP address to use when manual or DLLA configuration methods are used to configure the LAN. If DHCP is enabled, this setting is ignored.","This attribute does not indicate the actual setting currently in effect. Use the lan.status.gateway attribute to determine the current operating state of the LAN.","The IP address must be formatted in four groups of numbers each separated by a decimal.","Example","print(lan.config.gateway)","Outputs the default gateway address. For example, you might see the output:","192.168.0.1","Also see","lan.status.gateway","lan.restoredefaults()","lan.config.gateway","14904.html");
+Page[194]=new Array("This attribute specifies the LAN IP address.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","LAN restore defaults","Nonvolatile memory",""192.168.0.2"","Usage","ipAddress = lan.config.ipaddress","lan.config.ipaddress = ipAddress","ipAddress","LAN IP address; must be a string specifying the IP address in dotted decimal notation","Details","This attribute specifies the LAN IP address to use when the LAN is configured using the manual configuration method. This setting is ignored when DLLA or DHCP is used.","This attribute does not indicate the actual setting currently in effect. Use the lan.status.ipaddress attribute to determine the current operating state of the LAN.","Example","ipaddress = lan.config.ipaddress","Retrieves the presently set LAN IP address.","Also see","lan.restoredefaults()","lan.status.ipaddress","lan.config.ipaddress","14905.html");
+Page[195]=new Array("This attribute contains the LAN settings configuration method.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","LAN restore defaults","Nonvolatile memory","0 (lan.AUTO)","Usage","method = lan.config.method","lan.config.method = method","method","The method for configuring LAN settings; it can be one of the following values:","0 or lan.AUTO: Selects automatic sequencing of configuration methods","1 or lan.MANUAL: Use only manually specified configuration settings","Details","This attribute controls how the LAN IP address, subnet mask, default gateway address, and DNS server addresses are determined.","When method is lan.AUTO, the instrument first attempts to configure the LAN settings using dynamic host configuration protocol (DHCP). If DHCP fails, it tries dynamic link local addressing (DLLA). If DLLA fails, it uses the manually specified settings.","When method is lan.MANUAL, only the manually specified settings are used. Neither DHCP nor DLLA are attempted.","Example","print(lan.config.method)","Outputs the current method.","For example:","1.00000e+00","Also see","lan.restoredefaults()","lan.config.method","14906.html");
+Page[196]=new Array("This attribute contains the LAN speed used when restarting in manual configuration mode.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","LAN restore defaults","Nonvolatile memory","100 (100 Mbps)","Usage","speed = lan.config.speed","lan.config.speed = speed","speed","LAN speed setting in Mbps (10 or 100)","Details","This attribute does not indicate the actual setting currently in effect. Use the lan.status.speed attribute to determine the current operating state of the LAN.","This attribute stores the speed that will be used if the LAN is restarted for manual configuration operation.","The LAN speed is measured in megabits per second (Mbps).","Example","lan.config.speed = 100","Configure LAN speed for 100.","Also see","lan.restoredefaults()","lan.status.speed","lan.config.speed","14907.html");
+Page[197]=new Array("This attribute contains the LAN subnet mask.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","LAN restore defaults","Nonvolatile memory",""255.255.255.0"","Usage","mask = lan.config.subnetmask","lan.config.subnetmask = mask","mask","LAN subnet mask value string that specifies the subnet mask in dotted decimal notation","Details","This attribute specifies the LAN subnet mask to use when the manual configuration method is used to configure the LAN. This setting is ignored when DLLA or DHCP is used.","This attribute does not indicate the actual setting currently in effect. Use the lan.status.subnetmask attribute to determine the current operating state of the LAN.","Example","print(lan.config.subnetmask)","Outputs the LAN subnet mask, such as:","255.255.255.0","Also see","lan.restoredefaults()","lan.status.subnetmask","lan.config.subnetmask","14908.html");
+Page[198]=new Array("This attribute contains the LAN link timeout period.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","LAN restore defaults","Nonvolatile memory","20 (20 s)","Usage","timeout = lan.linktimeout ","lan.linktimeout = timeout","timeout","The LAN link monitor time-out period (in seconds)","Details","You must enable the command lan.autoconnect before you can use this attribute.","The timeout value represents the amount of time that passes before the instrument disconnects from the LAN due to the loss of the LAN link integrity.","The LAN interface does not disconnect if the connection to the LAN is reestablished before the timeout value expires.","If the LAN link integrity is not restored before the timeout value expires, the instrument begins to monitor for a new connection.","Example","print(lan.linktimeout)","Outputs the present LAN link timeout setting.","Also see","lan.autoconnect","lan.restoredefaults()","lan.linktimeout","14892.html");
+Page[199]=new Array("This attribute contains the LXI domain.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","LAN restore defaults","Nonvolatile memory","0","Usage","domain = lan.lxidomain","lan.lxidomain = domain","domain","The LXI domain number (0 to 255)","Details","This attribute sets the LXI domain number.","All outgoing LXI packets will be generated with this domain number. All inbound LXI packets will be ignored unless they have this domain number.","Example","print(lan.lxidomain)","Displays the LXI domain.","Also see","lan.restoredefaults()","lan.lxidomain","14893.html");
+Page[200]=new Array("This attribute controls the state of the LAN Nagle algorithm.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Power cycle","Not saved","0 (lan.DISABLE)","Usage","state = lan.nagle","lan.nagle = state","state","1 or lan.ENABLE: Enable the LAN Nagle algorithm for TCP connections","0 or lan.DISABLE: Disable the Nagle algorithm for TCP connections","Details","This attribute enables or disables the use of the LAN Nagle algorithm on transmission control protocol (TCP) connections.","Also see","lan.restoredefaults()","lan.nagle","14894.html");
+Page[201]=new Array("This function resets the LAN interface.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","lan.reset()","Details","This function resets the LAN interface. It performs the commands lan.restoredefaults() and lan.applysettings().","Also see","lan.applysettings()","lan.restoredefaults()","lan.reset()","14895.html");
+Page[202]=new Array("This function resets LAN settings to default values.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","lan.restoredefaults()","Details","The settings that are restored are shown in the following table.","Settings that are restored to default","Attribute","Default setting","lan.autoconnect","lan.ENABLE","lan.config.dns.address[N]",""0.0.0.0"","lan.config.dns.domain","""","lan.config.dns.dynamic","lan.ENABLE","lan.config.dns.verify","lan.ENABLE","lan.config.duplex","lan.FULL","lan.config.gateway",""0.0.0.0"","lan.config.ipaddress",""192.168.0.2"","lan.config.method","lan.AUTO","lan.config.speed","100","lan.config.subnetmask",""255.255.255.0"","lan.linktimeout","20 (seconds)","lan.lxidomain","0","lan.nagle","lan.DISABLE","lan.timedwait","20 (seconds)","The lan.restoredefaults() function does not reset the LAN password. The localnode.password attribute controls the web password, which can be reset separately.","This command is run when lan.reset() is sent.","Example","lan.restoredefaults()","Restores the LAN defaults.","Also see","lan.reset()","localnode.password","lan.restoredefaults()","14896.html");
+Page[203]=new Array("This attribute contains the DNS server IP addresses.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not applicable","Not applicable","Usage","dnsAddress = lan.status.dns.address[N]","dnsAddress","DNS server IP address","N","Entry index (1, 2, or 3)","Details","This attribute is an array of DNS server addresses. The instrument can use up to three addresses.","Unused or disabled entries are returned as "0.0.0.0" when read. The dnsAddress returned is a string specifying the IP address of the DNS server in dotted decimal notation.","You can only specify two addresses manually. However, the instrument uses up to three DNS server addresses. If two are specified, only the one given by a DHCP server is used. If no entries are specified, up to three address given by a DHCP server are used.","The value of lan.status.dns.address[1] is referenced first for all DNS lookups. The values of lan.status.dns.address[2] and lan.status.dns.address[3] are referenced second and third, respectively.","Example","print(lan.status.dns.address[1])","Outputs DNS server address 1, for example:","164.109.48.173","Also see","lan.status.dns.name","lan.status.dns.address[N]","14909.html");
+Page[204]=new Array("This attribute contains the present DNS fully qualified host name.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not applicable","Not applicable","Usage","hostName = lan.status.dns.name","hostName","Fully qualified DNS host name that can be used to connect to the instrument","Details","A fully qualified domain name (FQDN), sometimes referred to as an absolute domain name, is a domain name that specifies its exact location in the tree hierarchy of the Domain Name System (DNS).","A FQDN is the complete domain name for a specific computer or host on the LAN. The FQDN consists of two parts: the host name and the domain name.","If the DNS host name for an instrument is not found, this attribute stores the IP address in dotted decimal notation.","Example","print(lan.status.dns.name)","Outputs the dynamic DNS host name.","Also see","lan.config.dns.address[N]","lan.config.dns.hostname","lan.status.dns.name","14910.html");
+Page[205]=new Array("This attribute contains the duplex mode presently in use by the LAN interface.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not applicable","Not applicable","Usage","duplex = lan.status.duplex","duplex","LAN duplex setting can be one of the following values: 0 or lan.HALF: half-duplex operation 1 or lan.FULL: full-duplex operation","Example","print(lan.status.duplex)","Outputs the present LAN duplex mode, such as:","1.00000e+00","Also see","None","lan.status.duplex","14911.html");
+Page[206]=new Array("This attribute contains the gateway address presently in use by the LAN interface.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not applicable","Not applicable","Usage","gatewayAddress = lan.status.gateway","gatewayAddress","LAN gateway address presently being used","Details","The value of gatewayAddress is a string that indicates the IP address of the gateway in dotted decimal notation.","Example","print(lan.status.gateway)","Outputs the gateway address, such as:","192.168.0.1","Also see","lan.config.gateway","lan.status.gateway","14912.html");
+Page[207]=new Array("This attribute contains the LAN IP address presently in use by the LAN interface.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not applicable","Not applicable","Usage","ipAddress = lan.status.ipaddress","ipAddress","LAN IP address specified in dotted decimal notation","Details","The IP address is a character string that represents the IP address assigned to the instrument.","Example","print(lan.status.ipaddress)","Outputs the LAN IP address currently in use, such as:","192.168.0.2","Also see","lan.config.ipaddress","lan.status.ipaddress","14913.html");
+Page[208]=new Array("This attribute contains the LAN MAC address.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not applicable","Not applicable","Usage","macAddress = lan.status.macaddress","macAddress","The instrument MAC address","Details","The MAC address is a character string representing the instrument's MAC address in hexadecimal notation. The string includes colons that separate the address octets (see Example).","Example","print(lan.status.macaddress)","Outputs the MAC address of the instrument, for example:","00:60:1A:00:00:57","Also see","None","lan.status.macaddress","14914.html");
+Page[209]=new Array("This attribute contains the LAN dead socket termination port number.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not applicable","Not applicable","Usage","port = lan.status.port.dst","port","Dead socket termination socket port number","Details","This attribute holds the TCP port number used to reset all other LAN socket connections.","To reset all LAN connections, open a connection to the DST port number.","Example","print(lan.status.port.dst)","Outputs the LAN dead socket termination port number, such as:","5.03000e+03","Also see","None","lan.status.port.dst","14915.html");
+Page[210]=new Array("This attribute contains the LAN raw socket connection port number.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not applicable","Not applicable","Usage","port = lan.status.port.rawsocket","port","Raw socket port number","Details","Stores the TCP port number used to connect the instrument and to control the instrument over a raw socket communication interface.","Example","print(lan.status.port.rawsocket)","Outputs the LAN raw socket port number, such as:","5.02500e+03","Also see","None","lan.status.port.rawsocket","14916.html");
+Page[211]=new Array("This attribute contains the LAN Telnet connection port number.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not applicable","Not applicable","Usage","port = lan.status.port.telnet","port","Telnet port number","Details","This attribute holds the TCP port number used to connect to the instrument to control it over a Telnet interface.","Example","print(lan.status.port.telnet)","Get the LAN Telnet connection port number.","Output:","2.30000e+01","Also see","None","lan.status.port.telnet","14917.html");
+Page[212]=new Array("This attribute contains the LAN VXI-11 connection port number.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not applicable","Not applicable","Usage","port = lan.status.port.vxi11","port","LAN VXI-11 port number","Details","This attribute stores the TCP port number used to connect to the instrument over a VXI-11 interface.","Example","print(lan.status.port.vxi11)","Outputs the VXI-11 number, such as:","1.02400e+03","Also see","None","lan.status.port.vxi11","14918.html");
+Page[213]=new Array("This attribute contains the LAN speed.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not applicable","Not applicable","Usage","speed = lan.status.speed","speed","LAN speed in Mbps, either 10 or 100","Details","This attribute indicates the transmission speed currently in use by the LAN interface.","Example","print(lan.status.speed)","Outputs the instrument's transmission speed presently in use, such as:","1.00000e+02","Also see","None","lan.status.speed","14919.html");
+Page[214]=new Array("This attribute contains the LAN subnet mask that is presently in use by the LAN interface.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not applicable","Not applicable","Usage","mask = lan.status.subnetmask","mask","A string specifying the subnet mask in dotted decimal notation","Details","Use this attribute to determine the present operating state of the LAN. This attribute will return the present LAN subnet mask value if the LAN is manually configured, or when DLLA or DHCP is used.","Example","print(lan.status.subnetmask)","Outputs the subnet mask of the instrument that is presently in use, such as:","255.255.255.0","Also see","lan.config.subnetmask","lan.status.subnetmask","14920.html");
+Page[215]=new Array("This attribute contains the LAN timed-wait state interval.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","LAN restore defaults","Nonvolatile memory","20 (20 s)","Usage","timeout = lan.timedwait","lan.timedwait = timeout","timeout","The LAN timed-wait state interval in seconds","Details","This attribute controls the amount of time that resources are allocated to closed TCP connections. When a TCP connection is closed, the connection is put in a timed-wait state and resources remain allocated for the connection until the timed-wait state ends. During the timed-wait interval, the instrument processes delayed packets that arrive after the connection is closed.","Use this attribute to tailor the timed-wait state interval for the instrument.","Also see","lan.restoredefaults()","lan.timedwait","14897.html");
+Page[216]=new Array("This function simulates the occurrence of the trigger and generates the corresponding event ID.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","lan.trigger[N].assert()","N","The LAN event number (1 to 8)","Details","Generates and sends a LAN trigger packet for the LAN event number specified.","Sets the pseudostate to the appropriate state.","The following indexes provide the listed events:","1:LAN0","2:LAN1","3:LAN2","…","8:LAN7","Example","lan.trigger[5].assert()","Creates a trigger with LAN packet 5.","Also see","lan.lxidomain","lan.trigger[N].clear()","lan.trigger[N].mode","lan.trigger[N].overrun","lan.trigger[N].stimulus","lan.trigger[N].wait()","lan.trigger[N].assert()","14921.html");
+Page[217]=new Array("This function clears the event detector for a trigger.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","lan.trigger[N].clear()","N","The LAN event number to clear (1 to 8)","Details","A trigger’s event detector remembers if an event has been detected since the last call. This function clears a trigger’s event detector and discards the previous history of the trigger packet.","This function clears all overruns associated with this LAN trigger.","Example","lan.trigger[5].clear()","Clears the event detector with LAN packet 5.","Also see","lan.trigger[N].assert()","lan.trigger[N].overrun","lan.trigger[N].stimulus","lan.trigger[N].wait()","lan.trigger[N].clear()","14922.html");
+Page[218]=new Array("This function prepares the event generator for outgoing trigger events.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","lan.trigger[N].connect()","N","The LAN event number (1 to 8)","Details","Prepares the event generator to send event messages. For TCP connections, this opens the TCP connection.","The event generator automatically disconnects when either the lan.trigger[N].protocol or lan.trigger[N].ipaddress attributes for this event are changed.","Example","lan.trigger[1].protocol = lan.MULTICAST","lan.trigger[1].connect()","lan.trigger[1].assert()","Set the protocol for LAN trigger 1 to be multicast when sending LAN triggers. Then, after connecting the LAN trigger, send a message on LAN trigger 1 by asserting it.","Also see","lan.trigger[N].assert()","lan.trigger[N].ipaddress","lan.trigger[N].overrun","lan.trigger[N].protocol","lan.trigger[N].stimulus","lan.trigger[N].wait()","lan.trigger[N].connect()","14923.html");
+Page[219]=new Array("This attribute stores the LAN event connection state.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not applicable","Not applicable","Usage","connected = lan.trigger[N].connected","connected","The LAN event connection state:","true: Connected","false: Not connected","N","The LAN event number (1 to 8)","Details","This read-only attribute is set to true when the LAN trigger is connected and ready to send trigger events following a successful lan.trigger[N].connect() command; if the LAN trigger is not ready to send trigger events, this value is false.","This attribute is also false when either lan.trigger[N].protocol or lan.trigger[N].ipaddress attributes are changed or the remote connection closes the connection.","Example","lan.trigger[1].protocol = lan.MULTICAST","print(lan.trigger[1].connected)","Outputs true if connected, or false if not connected.","Example output:","false","Also see","lan.trigger[N].connect()","lan.trigger[N].ipaddress","lan.trigger[N].protocol","lan.trigger[N].connected","14924.html");
+Page[220]=new Array("This function disconnects the LAN trigger.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","lan.trigger[N].disconnect()","N","The LAN event number (1 to 8)","Details","For TCP connections, this closes the TCP connection.","The LAN trigger automatically disconnects when either the lan.trigger[N].protocol or lan.trigger[N].ipaddress attributes for this event are changed.","Also see","lan.trigger[N].ipaddress","lan.trigger[N].protocol","lan.trigger[N].disconnect()","14925.html");
+Page[221]=new Array("This constant is the event identifier used to route the LAN trigger to other subsystems (using stimulus properties).","Type","TSP-Link accessible","Affected by","Where saved","Default value","Constant","Yes","Usage","lan.trigger[N].EVENT_ID","N","The LAN event number (1 to 8)","Details","Set the stimulus of any trigger event detector to the value of this constant to have it respond to incoming LAN trigger packets.","Example","digio.trigger[14].stimulus = lan.trigger[1].EVENT_ID","Route occurrences of triggers on LAN trigger 1 to digital I/O trigger 14.","Also see","None","lan.trigger[N].EVENT_ID","14926.html");
+Page[222]=new Array("This attribute specifies the address (in dotted‑decimal format) of UDP or TCP listeners.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset LAN trigger N reset Recall setup","Not saved ",""0.0.0.0"","Usage","ipAddress = lan.trigger[N].ipaddress","lan.trigger[N].ipaddress = ipAddress","ipAddress","The LAN address for this attribute as a string in dotted decimal notation","N","A number specifying the LAN event number (1 to 8)","Details","Sets the IP address for outgoing trigger events.","Set to "0.0.0.0" for multicast.","After changing this setting, the lan.trigger[N].connect() command must be called before outgoing messages can be sent.","Example","lan.trigger[3].protocol = lan.TCP","lan.trigger[3].ipaddress = "192.168.1.100"","lan.trigger[3].connect()","Set the protocol for LAN trigger 3 to be lan.TCP when sending LAN triggers.","Use IP address "192.168.1.100" to connect the LAN trigger.","Also see","lan.trigger[N].connect()","lan.trigger[N].ipaddress","14927.html");
+Page[223]=new Array("This attribute sets the trigger operation and detection mode.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset LAN trigger N reset Recall setup","Not saved ","0 (lan.TRIG_EITHER)","Usage","mode = lan.trigger[N].mode","lan.trigger[N].mode = mode","mode","A number representing the trigger mode (0 to 7); see the Details section for more information","N","A number representing the LAN event number (1 to 8)","Details","This attribute controls the mode in which the trigger event detector and the output trigger generator operate on the given trigger. These settings are intended to provide behavior similar to the digital I/O triggers.","Lan trigger mode values","Mode ","Number","Trigger packets detected as input","LAN trigger packet generated for output with a…","lan.TRIG_EITHER","0","Rising or falling edge (positive or negative state)","negative state","lan.TRIG_FALLING","1","Falling edge (negative state)","negative state","lan.TRIG_RISING","2","Rising edge (positive state)","positive state","lan.TRIG_RISINGA","3","Rising edge (positive state)","positive state","lan.TRIG_RISINGM","4","Rising edge (positive state)","positive state","lan.TRIG_SYNCHRONOUS","5","Falling edge (negative state)","positive state","lan.TRIG_SYNCHRONOUSA","6","Falling edge (negative state)","positive state","lan.TRIG_SYNCHRONOUSM","7","Rising edge (positive state)","negative state","lan.TRIG_RISING and lan.TRIG_RISINGA are the same.","lan.TRIG_RISING and lan.TRIG_RISINGM are the same.","Use of either lan.TRIG_SYNCHRONOUSA or lan.TRIG_SYNCHRONOUSM over lan.TRIG_SYNCHRONOUS is preferred, as lan.TRIG_SYNCHRONOUS is provided for compatibility with other Keithley Instruments products.","Example","print(lan.trigger[1].mode)","Outputs the present LAN trigger mode of LAN event 1.","Also see","Digital I/O","TSP-Link system expansion interface","lan.trigger[N].mode","14928.html");
+Page[224]=new Array("This attribute contains the event detector's overrun status.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","LAN trigger N clear LAN trigger N reset Instrument reset Recall setup","Not applicable","Not applicable","Usage","overrun = lan.trigger[N].overrun","overrun","The trigger overrun state for the specified LAN packet (true or false)","N","A number representing the LAN event number (1 to 8)","Details","This attribute indicates whether an event has been ignored because the event detector was already in the detected state when the event occurred.","This is an indication of the state of the event detector built into the synchronization line itself. It does not indicate if an overrun occurred in any other part of the trigger model, or in any other construct that is monitoring the event.","It also is not an indication of an output trigger overrun. Output trigger overrun indications are provided in the status model.","Example","overrun = lan.trigger[5].overrun","print(overrun)","Checks the overrun status of a trigger on LAN5 and outputs the value, such as:","false","Also see","lan.trigger[N].assert()","lan.trigger[N].clear()","lan.trigger[N].stimulus","lan.trigger[N].wait()","lan.trigger[N].overrun","14929.html");
+Page[225]=new Array("This attribute sets the LAN protocol to use for sending trigger messages.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset LAN trigger N reset Recall setup","Not saved ","0 (lan.TCP)","Usage","protocol = lan.trigger[N].protocol","lan.trigger[N].protocol = protocol","protocol","The protocol to use for the trigger's messages:","0 or lan.TCP","1 or lan.UDP","2 or lan.MULTICAST","N","A number representing the LAN event number (1 to 8)","Details","The LAN trigger listens for trigger messages on all supported protocols, but uses the designated protocol for sending outgoing messages. After changing this setting, lan.trigger[N].connect() must be called before outgoing event messages can be sent.","When the lan.MULTICAST protocol is selected, the lan.trigger[N].ipaddress attribute is ignored and event messages are sent to the multicast address 224.0.23.159.","Example","print(lan.trigger[1].protocol)","Get LAN protocol to use for sending trigger messages for LAN event 1.","Also see","lan.trigger[N].connect()","lan.trigger[N].ipaddress","lan.trigger[N].protocol","14930.html");
+Page[226]=new Array("This attribute sets the simulated line state for the LAN trigger.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset LAN trigger N reset Recall setup","Not saved ","1","Usage","pseudostate = lan.trigger[N].pseudostate","lan.trigger[N].pseudostate = pseudostate","pseudostate","The simulated line state (0 or 1)","N","A number representing the LAN event number (1 to 8)","Details","This attribute can be set to initialize the pseudo state to a known value.","Setting this attribute will not cause the LAN trigger to generate any events or output packets.","Example","print(lan.trigger[1].pseudostate)","Get the present simulated line state for the LAN event 1.","Also see","None","lan.trigger[N].pseudostate","14931.html");
+Page[227]=new Array("This attribute specifies events that cause this trigger to assert.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset LAN trigger N reset Recall setup","Not saved","0","Usage","triggerStimulus = lan.trigger[N].stimulus","lan.trigger[N].stimulus = triggerStimulus","triggerStimulus","The LAN event identifier used to trigger the event.","N","A number specifying the trigger packet over the LAN for which to set or query the trigger source (1 to 8).","Details","This attribute specifies which event causes a LAN trigger packet to be sent for this trigger. Set triggerStimulus to one of the existing trigger event IDs shown in the following table.","Trigger event IDs*","Event ID","Event description","smua.trigger.SWEEPING_EVENT_ID","Occurs when the source‑measure unit (SMU) transitions from the idle state to the arm layer of the trigger model","smua.trigger.ARMED_EVENT_ID","Occurs when the SMU moves from the arm layer to the trigger layer of the trigger model","smua.trigger.SOURCE_COMPLETE_EVENT_ID","Occurs when the SMU completes a source action","smua.trigger.MEASURE_COMPLETE_EVENT_ID","Occurs when the SMU completes a measure action","smua.trigger.PULSE_COMPLETE_EVENT_ID","Occurs when the SMU completes a pulse","smua.trigger.SWEEP_COMPLETE_EVENT_ID","Occurs when the SMU completes a sweep","smua.trigger.IDLE_EVENT_ID","Occurs when the SMU returns to the idle state","digio.trigger[N].EVENT_ID","Occurs when an edge is detected on a digital I/O line","tsplink.trigger[N].EVENT_ID","Occurs when an edge is detected on a TSP‑Link line","lan.trigger[N].EVENT_ID","Occurs when the appropriate LXI trigger packet is received on LAN trigger object N","display.trigger.EVENT_ID","Occurs when the TRIG key on the front panel is pressed","trigger.EVENT_ID","Occurs when a *TRG command is received on the remote interface","GPIB only: Occurs when a GET bus command is received","VXI-11 only: Occurs with the VXI-11 command device_trigger; reference the VXI-11 standard for additional details on the device trigger operation","trigger.blender[N].EVENT_ID","Occurs after a collection of events is detected","trigger.timer[N].EVENT_ID","Occurs when a delay expires","* Use the name of the trigger event ID to set the stimulus value rather than the numeric value. Using the name makes the code compatible for future upgrades (for example, if the numeric values must change when enhancements are added to the instrument).","Setting this attribute to zero disables automatic trigger generation.","If any events are detected prior to calling lan.trigger[N].connect(), the event is ignored and the action overrun is set.","Example","lan.trigger[5].stimulus = trigger.timer[1].EVENT_ID","Use timer 1 trigger event as the source for LAN packet 5 trigger stimulus.","Also see","lan.trigger[N].assert()","lan.trigger[N].clear()","lan.trigger[N].connect()","lan.trigger[N].overrun","lan.trigger[N].wait()","lan.trigger[N].stimulus","17679.html");
+Page[228]=new Array("This function waits for an input trigger.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","triggered = lan.trigger[N].wait(timeout)","triggered","Trigger detection indication","N","The trigger packet over LAN to wait for (1 to 8)","timeout","Maximum amount of time in seconds to wait for the trigger event","Details","If one or more trigger events have been detected since the last time lan.trigger[N].wait() or lan.trigger[N].clear() was called, this function returns immediately.","After waiting for a LAN trigger event with this function, the event detector is automatically reset and rearmed regardless of the number of events detected.","Example","triggered = lan.trigger[5].wait(3)","Wait for a trigger with LAN packet 5 with a timeout of 3 seconds.","Also see","lan.trigger[N].assert()","lan.trigger[N].clear()","lan.trigger[N].overrun","lan.trigger[N].stimulus","lan.trigger[N].wait()","14933.html");
+Page[229]=new Array("This attribute stores a user-defined description and mDNS service name of the instrument.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Not applicable","Nonvolatile memory","Instrument specific (see Details)","Usage","localnode.description = description","description = localnode.description","description","User-defined description and mDNS service name of the instrument; use a string of 63 characters or less","Details","This attribute stores a string that contains a description of the instrument. This value appears on instrument's LXI welcome page. The value of this attribute is also used as the instrument's mDNS service name.","This attribute's factory default value is "Keithley Instruments SMU <model number> - <serial number>", where <model number> and <serial number> are replaced with the actual model number and serial number of the instrument (for example, "Keithley Instruments SMU 2657A - 1349810"). Setting this attribute to an empty string (in other words, setting this attribute to a string of length zero, or one consisting entirely of whitespace characters) will revert the description to the factory default value.","When using this command from a remote node, localnode should be replaced with the node reference, for example node[5].description.","Example","description = "System in Lab 05"","localnode.description = description","Set description equal to "System in Lab 05".","Also see","None","localnode.description","15008.html");
+Page[230]=new Array("This attribute contains the power line frequency setting used for NPLC calculations.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Not applicable","Nonvolatile memory","Country specific (50 Hz or 60 Hz)","Usage","frequency = localnode.linefreq","localnode.linefreq = frequency","frequency","An integer representing the specified power line frequency","Details","To achieve optimum noise rejection when performing measurements at integer NPLC apertures, set the line frequency attribute to match the frequency (50 Hz or 60 Hz) of the AC power line. ","When using this command from a remote node, localnode should be replaced with the node reference, for example node[5].linefreq.","Example 1","frequency = localnode.linefreq","Reads line frequency setting.","Example 2","localnode.linefreq = 60","Sets the line frequency to 60 Hz.","Also see","None","localnode.linefreq","24985.html");
+Page[231]=new Array("This attribute stores the model number.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not applicable","Not applicable","Usage","model = localnode.model","model","The model number of the instrument","Details","When using this command from a remote node, localnode should be replaced with the node reference, for example node[5].model.","Example","print(localnode.model)","Outputs the model number.","Also see","localnode.description","localnode.revision","localnode.serialno","localnode.model","15013.html");
+Page[232]=new Array("This attribute stores the remote access password.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (W)","Yes","LAN reset LAN restore defaults","Nonvolatile memory","""","Usage","localnode.password = passWord","passWord","String containing the remote interface password","Details","This write-only attribute stores the password that is set for any remote interface. When password usage is enabled (localnode.passwordmode), you must supply this password to change the configuration or to control an instrument from a web page or other remote command interface.","The instrument continues to use the old password for all interactions until the command to change it executes. When changing the password, give the instrument time to execute the command before attempting to use the new password.","You cannot retrieve a lost password from any command interface.","The password can be reset by resetting the LAN from the front panel or by using the lan.reset() command.","When using this command from a remote node, localnode should be replaced with the node reference, for example node[5].password.","Example","localnode.password = "N3wpa55w0rd"","Changes the remote interface password to N3wpa55w0rd.","Also see","lan.reset()","localnode.passwordmode","localnode.password","15014.html");
+Page[233]=new Array("This attribute stores the remote access password enable mode.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Not applicable","Nonvolatile memory","1 (localnode.PASSWORD_WEB)","Usage","mode = localnode.passwordmode","localnode.passwordmode = mode","mode","The remote password enable mode","Details","This attribute controls if and where remote access passwords are required. Set this attribute to one of the values below to enable password checking:","localnode.PASSWORD_NONE or 0: Disable passwords everywhere","localnode.PASSWORD_WEB or 1: Use passwords on the web interface only","localnode.PASSWORD_LAN or 2: Use passwords on the web interface and all LAN interfaces","localnode.PASSWORD_ALL or 3: Use passwords on the web interface and all remote command interfaces","When using this command from a remote node, localnode should be replaced with the node reference, for example node[5].passwordmode.","Example","mode = localnode.PASSWORD_WEB","localnode.passwordmode = mode","Sets value of mode to PASSWORD_WEB.","Allows use of passwords on the web interface only.","Also see","localnode.password","localnode.passwordmode","15015.html");
+Page[234]=new Array("This attribute sets and reads the local node prompting state (enabled or disabled).","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Power cycle","Not saved","0 (disabled)","Usage","prompting = localnode.prompts","localnode.prompts = prompting","prompting","Prompting state (0 to disable or 1 to enable)","Details","The command messages do not generate prompts. The instrument generates prompts in response to command messages.","When the prompting mode is enabled (set to 1), the instrument generates prompts in response to command messages. There are three prompts that might be generated:","TSP> is the standard prompt. This prompt indicates that everything is normal and the command is done processing.","TSP? is issued if there are entries in the error queue when the prompt is issued. Like the TSP> prompt, it indicates the command is done processing. It does not mean the previous command generated an error, only that there are still errors in the queue when the command was done processing.",">>>> is the continuation prompt. This prompt is used when downloading scripts. When downloading scripts, many command messages must be sent as a group. The continuation prompt indicates that the instrument is expecting more messages as part of the current command.","When using this command from a remote node, localnode should be replaced with the node reference, for example, node[5].prompts.","@ Do not disable prompting when using Test Script Builder. Test Script Builder requires prompts and sets the prompting mode behind the scenes. If you disable prompting, using Test Script Builder causes the instrument to stop responding because it is waiting for the prompt that lets it know that the command is done executing.","Example","localnode.prompts = 1","Enable prompting.","Also see","localnode.prompts4882","localnode.showerrors","localnode.prompts","15016.html");
+Page[235]=new Array("This attribute enables and disables the generation of prompts for IEEE Std 488.2 common commands.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Power cycle","Not saved","1 (enabled)","Usage","prompting = localnode.prompts4882","localnode.prompts4882 = prompting","prompting","IEEE Std 488.2 prompting mode","Details","When set to 1, the IEEE Std 488.2 common commands generate prompts if prompting is enabled with the localnode.prompts attribute. If set to 1, limit the number of *trg commands sent to a running script to 50 regardless of the setting of the localnode.prompts attribute.","When set to 0, IEEE Std 488.2 common commands will not generate prompts. When using the *trg command with a script that executes trigger.wait() repeatedly, set localnode.prompts4882 to 0 to avoid problems associated with the command interface input queue filling.","This attribute resets to the default value each time the instrument power is cycled.","When using this command from a remote node, localnode should be replaced with the node reference, for example node[5].prompts4882.","Example","localnode.prompts4882 = 0","Disables IEEE Std 488.2 common command prompting.","Also see","localnode.prompts","localnode.prompts4882","15017.html");
+Page[236]=new Array("This function resets the local node instrument.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","localnode.reset()","Details","If you want to reset a specific instrument or a subordinate node, use the node[X].reset() command.","A local node reset includes:","Source‑measure unit (SMU) attributes affected by a SMU reset are reset","Other settings are restored back to factory default settings","A localnode.reset() is different than a reset() because reset() resets the entire system. ","When using this command from a remote node, localnode should be replaced with the node reference, for example node[5].reset().","Example","localnode.reset()","Resets the local node.","Also see","reset()","smuX.reset()","localnode.reset()","16978.html");
+Page[237]=new Array("This attribute stores the firmware revision level.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not applicable","Not applicable","Usage","revision = localnode.revision","revision","Firmware revision level","Details","This attribute indicates the firmware revision number currently running in the instrument.","When using this command from a remote node, localnode should be replaced with the node reference, for example node[5].revision.","Example","print(localnode.revision)","Outputs the present revision level. Sample output:","1.1.0","Also see","localnode.description","localnode.model","localnode.serialno","localnode.revision","15018.html");
+Page[238]=new Array("This attribute stores the instrument's serial number.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not applicable","Not applicable","Usage","serialno = localnode.serialno","serialno","The serial number of the instrument","Details","This read-only attribute indicates the instrument serial number.","When using this command from a remote node, localnode should be replaced with the node reference, for example node[5].serialno.","Example","display.clear()","display.settext(localnode.serialno)","Clears the instrument's display.","Places the instrument's serial number on the top line of its display.","Also see","localnode.description","localnode.model","localnode.revision","localnode.serialno","15019.html");
+Page[239]=new Array("This attribute sets whether or not the instrument automatically sends generated errors.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Power cycle","Not saved","0 (disabled)","Usage","errorMode = localnode.showerrors","localnode.showerrors = errorMode","errorMode","Enables (1) or disables (0) the show errors state","Details","If this attribute is set to 1, the instrument automatically sends any generated errors stored in the error queue, and then clears the queue. Errors are processed after executing a command message (just before issuing a prompt, if prompts are enabled).","If this attribute is set to 0, errors are left in the error queue and must be explicitly read or cleared.","When using this command from a remote node, localnode should be replaced with the node reference, for example, node[5].showerrors.","Example","localnode.showerrors = 1","Enables sending of generated errors.","Also see","localnode.prompts","localnode.showerrors","15022.html");
+Page[240]=new Array("This function creates a function to get the value of an attribute.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","getter = makegetter(table, attributeName)","getter","The return value","table","Read‑only table where the attribute is located","attributeName","A string representing the name of the attribute","Details","This function is useful for aliasing attributes to improve execution speed. Calling the function created with makegetter() executes faster than accessing the attribute directly.","Creating a getter function is only useful if it is going to be called several times. Otherwise, the overhead of creating the getter function outweighs the overhead of accessing the attribute directly.","Example","getlevel = makegetter(smua.source, "levelv")","v = getlevel()","Creates a getter function called getlevel.","When getlevel() is called, it returns the value of smua.source.levelv. "," ","Also see","makesetter()","makegetter()","15041.html");
+Page[241]=new Array("This function creates a function that, when called, sets the value of an attribute.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","setter = makesetter(table, attributeName)","setter","Function that sets the value of the attribute","table","Read-only table where the attribute is located","attributeName","The string name of the attribute","Details","This function is useful for aliasing attributes to improve execution speed. Calling the setter function will execute faster than accessing the attribute directly.","Creating a setter function is only useful if it is going to be called several times. If you are not calling the setter function several times, it is more efficient to access the attribute directly. ","Example","setlevel = makesetter(smua.source, "levelv")","for v = 1, 10 do"," setlevel(v)","end","Creates a setter function called setlevel.","Using setlevel() in the loop sets the value of smua.source.levelv, ","performing a source sweep.","Also see","makegetter()","makesetter()","15042.html");
+Page[242]=new Array("This function returns the current amount of available memory and the total amount of memory in the instrument.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","freeMem, totalMem = meminfo()","freeMem","The amount of free dynamically allocated memory available","totalMem","The total amount of dynamically allocated memory in the instrument","Details","This function returns two values:","The amount of free dynamically allocated memory available in kilobytes","The total amount of dynamically allocated memory on the instrument in kilobytes","The difference between the two values is the amount currently used.","Also see","None","meminfo()","15050.html");
+Page[243]=new Array("This function starts test scripts from a remote node.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes (see Details)","Usage","node[N].execute(scriptCode)","N","The node number of this instrument","scriptCode","A string containing the source code","Details","Only the remote master node can use the execute command to run a script on this node. This function does not run test scripts on the master node, only on this node when initiated by the master node.","This function may only be called when the group number of the node is different than the node of the master.","This function will not wait for the script to finish execution.","This function cannot be used from the local node. This command should only be used from a remote master when controlling this instrument over a TSP-link®.","Example 1","node[2].execute(sourcecode)","Runs script code on node 2. The code is in a string variable called sourcecode.","Example 2","node[3].execute("x = 5")","Runs script code in string constant ("x = 5") to set x","equal to 5 on node 3.","Example 3","node[32].execute(TestDut.source)","Runs the test script stored in the variable TestDut","(previously stored on the master node) on node 32.","Also see","tsplink.group","TSP advanced features","node[N].execute()","15009.html");
+Page[244]=new Array("This function returns the value of a global variable.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes (see Details)","Usage","value = node[N].getglobal(name)","value","The value of the variable","N","The node number of this instrument","name","The global variable name","Details","Use this function to have the remote master node retrieve the value of a global variable from this node's run-time environment.","Do not use this command to retrieve the value of a global variable from the local node (access the global variable directly). This command should only be used from a remote master when controlling this instrument over a TSP-link®.","Example","print(node[5].getglobal("test_val"))","Retrieves and outputs the value of the global variable named test_val from node 5.","Also see","node[N].setglobal()","TSP advanced features","node[N].getglobal()","15010.html");
+Page[245]=new Array("This function sets the value of a global variable.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes (see Details)","Usage","node[N].setglobal(name, value)","N","The node number of this instrument","name","The global variable name to set","value","The value to assign to the variable","Details","From a remote node, use this function to assign the given value to a global variable.","Do not use this command to create or set the value of a global variable from the local node (set the global variable directly instead). This command should only be used from a remote master when controlling this instrument over a TSP-link®.","Example","node[3].setglobal("x", 5)","Sets the global variable x on node 3 to the value of 5.","Also see","node[N].getglobal()","TSP advanced features","node[N].setglobal()","15020.html");
+Page[246]=new Array("This function sets the operation complete status bit when all overlapped commands are completed.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","opc()","Details","This function causes the operation complete bit in the Standard Event Status Register to be set when all previously started local overlapped commands are complete. ","Note that each node independently sets its operation complete bits in its own status model. Any nodes not actively performing overlapped commands will set their bits immediately. All remaining nodes will set their own bits as they complete their own overlapped commands.","Also see","waitcomplete()","Status model","opc()","15054.html");
+Page[247]=new Array("This function deletes the file or directory with a given name.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","success, msg = os.remove(filename)","success","A success indicator (true or nil)","msg","A message value (nil or an error message)","filename","A string representing the name of the file or directory to delete","Details","Directories must be empty before using the os.remove() function to delete them.","If this function fails, it returns nil (for success) and an error message string (for msg).","Example","os.remove("testFile")","Delete the file named testFile.","Also see","os.rename()","os.remove()","19929.html");
+Page[248]=new Array("This function renames an existing file or directory.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","success, msg = os.rename(oldname, newname)","success","A success indicator (true or nil)","msg","A message value (nil or an error message)","oldname","String representing the name of the file or directory to rename","newname","String represent the new name of the file or directory","Details","If this function fails, it returns nil (for success) and an error message string (for msg).","Example","os.rename("testFile", "exampleFile")","Changes the name of the existing file testFile to the name exampleFile.","Also see","os.remove()","os.rename()","19930.html");
+Page[249]=new Array("This function generates a response message.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","print(value1)","print(value1, value2)","print(value1, ..., valueN)","value1","The first argument to output","value2","The second argument to output","valueN","The last argument to output","...","One or more values separated with commas","Details","TSP-enabled instruments do not have inherent query commands. Like any other scripting environment, the print() command and other related print() commands generate output. The print() command creates one response message.","The output from multiple arguments are separated with a tab character.","Numbers are printed using the format.asciiprecision attribute. If you want use Lua formatting, print the return value from the tostring() function.","Example 1","x = 10","print(x)","Example of an output response message:","1.00000e+01","Note that your output might be different if you set your ASCII precision setting to a different value.","Example 2","x = 10","print(tostring(x))","Example of an output response message:","10","Also see","format.asciiprecision","print()","17645.html");
+Page[250]=new Array("This function prints data from tables or reading buffer subtables.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","printbuffer(startIndex, endIndex, buffer1)","printbuffer(startIndex, endIndex, buffer1, buffer2)","printbuffer(startIndex, endIndex, buffer1, ..., bufferN)","startIndex","Beginning index of the buffer to print","endIndex","Ending index of the buffer to print","buffer1","First table or reading buffer subtable to print","buffer2","Second table or reading buffer subtable to print","bufferN","The last table or reading buffer subtable to print","...","One or more tables or reading buffer subtables separated with commas","Details","The correct usage of this function for a buffer containing n elements is:","1 ≤ startIndex ≤ endIndex ≤ n","Where n refers to the index of the last entry in the tables to be printed.","If endIndex < startIndex or n < startIndex, no data is printed. If startIndex ≤ 1, 1 is used as startIndex. If n < endIndex, n is used as endIndex.","When any given reading buffers are used in overlapped commands that have not yet completed (at least to the desired index), this function outputs data as it becomes available.","When there are outstanding overlapped commands to acquire data, n refers to the index that the last entry in the table will have after all the measurements have completed.","If you pass a reading buffer instead of a reading buffer subtable, the default subtable for that reading buffer will be used.","This command generates a single response message that contains all data. The response message is stored in the output queue.","The format.data attribute controls the format of the response message.","Example","format.data = format.ASCII","format.asciiprecision = 6","printbuffer(1, rb1.n, rb1)","This assumes that rb1 is a valid reading buffer in the run-time environment. The use of rb1.n (bufferVar.n) indicates that the instrument should output all readings in the reading buffer. In this example, rb1.n equals 10.","Example of output data (rb1.readings):","4.07205e-05, 4.10966e-05, 4.06867e-05, 4.08865e-05, 4.08220e-05, 4.08988e-05, 4.08250e-05, 4.09741e-05, 4.07174e-05, 4.07881e-05","Also see","bufferVar.n","format.asciiprecision","format.byteorder","format.data","print()","printnumber()","printbuffer()","15057.html");
+Page[251]=new Array("This function prints numbers using the configured format.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","printnumber(value1)","printnumber(value1, value2)","printnumber(value1, ..., valueN)","value1","First value to print in the configured format","value2","Second value to print in the configured format","valueN","Last value to print in the configured format","...","One or more values separated with commas","Details","There are multiple ways to use this function, depending on how many numbers are to be printed.","This function prints the given numbers using the data format specified by format.data and format.asciiprecision.","Example","format.asciiprecision = 10","x = 2.54","printnumber(x)","format.asciiprecision = 3","printnumber(x, 2.54321, 3.1)","Configure the ASCII precision to 10 and set x to 2.54.","Read the value of x based on these settings.","Change the ASCII precision to 3.","View how the change affects the output of x and some numbers.","Output:","2.540000000e+00","2.54e+00, 2.54e+00, 3.10e+00","Also see","format.asciiprecision","format.byteorder","format.data","print()","printbuffer()","printnumber()","15058.html");
+Page[252]=new Array("This KIPulse factory script function performs a specified number of pulse I, measure V cycles.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","PulseIMeasureV(smu, bias, level, ton, toff, points)","smu","System SourceMeter® instrument channel (set to smua)","bias","Bias level in amperes","level","Pulse level in amperes","ton","Pulse on time in seconds","toff","Pulse off time in seconds","points","Number of pulse-measure cycles","Details","Data for pulsed voltage measurements, current levels, and timestamps are stored in smua.nvbuffer1.","If any parameters are omitted or nil, the operator will be prompted to enter them using the front panel.","To perform the specified number of pulse I, measure V cycles, this function:","1. Sets the smu to output bias amperes and dwell for toff seconds.","2. Sets the smu to output level amperes and dwell for ton seconds.","3. Performs voltage measurement with source at level amperes.","4. Sets the smu to output bias amperes for toff seconds.","5. Repeats steps 2 through 4 for all remaining points pulse-measure cycles.","Example","PulseIMeasureV(smua, 0.001, 0.01, "," 20e-3, 40e-3, 10)","SMU A will output 1 mA and dwell for 40 ms, output 10 mA and dwell for 20 ms. The voltage measurements occur during each 20 ms dwell period. After the measurement, the output will return to 1 mA and dwell for 40 ms. This pulse‑measure process will repeat nine more times.","Also see","None","PulseIMeasureV()","12918.html");
+Page[253]=new Array("This KIPulse factory script function performs a specified number of pulse V, measure I cycles.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","PulseVMeasureI(smu, bias, level, ton, toff, points)","smu","System SourceMeter® instrument channel (set to smua)","bias","Bias level in volts","level","Pulse level in volts","ton","Pulse on time in seconds","toff","Pulse off time in seconds","points","Number of pulse-measure cycles","Details","If any parameters are omitted or nil, the operator will be prompted to enter them using the front panel. Data for pulsed current measurements, voltage levels, and timestamps are stored in smuX.nvbuffer1.","To perform the specified number of pulse V, measure I cycles, this function:","Sets the smu to output bias volts and dwell for toff seconds","Sets the smu to output level volts and dwell for ton seconds","Performs voltage measurement with source at level volts","Sets the smu to output bias volts for toff seconds","Repeats steps 2 through 4 for the remaining points pulse-measure cycles","Example 1","smua.measure.nplc = 0.001","PulseVMeasureI(smua, -50, 125, 10e-3, 20e-3, 10)","SMU A will output -50 V and dwell for 10 ms, output 125 V and dwell for 20 ms. The current measurement occurs during the dwell period. After the measurement, the output will return to -50 V and dwell for 10 ms. This pulse-measure process will repeat 9 more times.","Also see","None","PulseVMeasureI()","12923.html");
+Page[254]=new Array("This KIPulse factory script function allows you to inspect the settings of the preconfigured pulse train assigned to tag.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","tbl = QueryPulseConfig(tag)","tag","Numeric identifier to be assigned to the defined pulse train","tbl","Returned table","Details","Once a pulse train has been configured and assigned to a tag, it is often desirable to inspect the settings of this preconfigured pulse train. The QueryPulseConfig() command can be used for this purpose. ","This function will return a table containing the various settings associated with the tag input parameter.","Return values:","tostring()","A function that returns most elements in a string convenient for printing","tag","Identifying tag for this pulse train","smu","The SMU configured for pulsing","func","Pulse function: ","smua.OUTPUT_DCAMPS or ","smua.OUTPUT_DCVOLTS","bias","Pulse bias level","level","Pulse level for non sweeping pulses","start","Starting level for sweep pulses","stop","Ending level for sweep pulses","limit","Limit value","ton","On time in seconds","toff","Off time in seconds","points","The number of points in this pulse train","buf","Reference to buffer containing measurement data","sync_in","The sync_in digio line, if used","sync_out","The sync_out digio line, if used","sourcevalues","A table containing the source value for each point in the pulse train","Example","smua.reset()","smua.source.rangev = 500","smua.source.rangei = 0.1","smua.source.levelv = 0","smua.measure.rangev = 500","smua.measure.rangei = 0.1","smua.measure.nplc = 0.01","smua.measure.autozero = smua.AUTOZERO_ONCE","smua.nvbuffer1.clear()","smua.nvbuffer1.appendmode = 1","smua.source.output = smua.OUTPUT_ON","f1, msg1 = ConfigPulseVMeasureI(smua, 0,"," 300, 0.1, 5e-3, 0.2, 10,"," smua.nvbuffer1, 1)","print(QueryPulseConfig(1).tostring())","Configure channel A to generate a pulse train, query configuration, and then display as a string. Channel A will pulse voltage from a bias level of 0 V to a pulse level of 300 V. The pulse level will be present for 5 ms, and the bias level for 200 ms with a 100 mA limit setting. A total of 10 pulses will be generated, and the measurement data will be stored in smua.nvbuffer1. This pulse train will be assigned to tag = 1.","Output:",">> tag = 1",">> smu = smua",">> func = volts",">> type = pulse",">> bias = 0",">> level = 300",">> limit = 0.1",">> time on = 0.005",">> time off = 0.2",">> points = 10",">> measure = yes",">> sync_in = 0",">> sync_out = 0",">> sync_in_timeout = 0",">> sync_out_abort = 0",">> { 300, 300, 300, 300, 300, 300, "," 300, 300, 300, 300 }","Also see","ConfigPulseIMeasureV()","ConfigPulseIMeasureVSweepLin()","ConfigPulseIMeasureVSweepLog()","ConfigPulseVMeasureI()","ConfigPulseVMeasureISweepLin()","ConfigPulseVMeasureISweepLog()","QueryPulseConfig()","12949.html");
+Page[255]=new Array("This function resets commands to their default settings.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","reset()","reset(system)","system","true: If the node is the master, the entire system is reset","false: Only the local group is reset","Details","The reset() command in its simplest form resets the entire TSP‑enabled system, including the controlling node and all subordinate nodes.","If you want to reset a specific instrument, use either the localnode.reset() or node[X].reset() command. The localnode.reset() command is used for the local instrument. The node[X].reset() command is used to reset an instrument on a subordinate node.","When no value is specified for system, the default value is true.","Resetting the entire system using reset(true) is permitted only if the node is the master. If the node is not the master node, executing this command generates an error.","Example","reset(true)","If the node is the master node, the entire system is reset; if the node is not the master node, an error is generated.","Also see","localnode.reset()","reset()","13933.html");
+Page[256]=new Array("This KISavebuffer factory script function saves reading buffers as either a .CSV file or an .XML file.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","savebuffer(buffer, formatType, fileName)","buffer","The reading buffer to save","formatType","A string indicating which file type to use: .csv or .xml","fileName","The file name of the saved buffer","Details","Use this function to save the specified buffer to a USB flash drive.","This function will only save to a USB flash drive. ","You are not required to qualify the path to the USB flash drive, but if you wish to, add /usb1/ before the fileName (see Example 2).","Example 1","savebuffer(smua.nvbuffer1, "csv","," "mybuffer.csv") ","Save smua dedicated reading buffer 1 as a .CSV file named mybuffer.csv.","Example 2","savebuffer(smua.nvbuffer1, "csv","," "/usb1/mybuffer.csv") ","Save smua dedicated reading buffer 1 to an installed USB flash drive as a .CSV file named mybuffer.csv.","Also see","smuX.savebuffer()","savebuffer()","12959.html");
+Page[257]=new Array("This is a reference to the anonymous script.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","No","See Details","See Details","Not applicable","Usage","scriptVar = script.anonymous","scriptVar","The name of the variable that references the script","Details","You can use the script.anonymous script like any other script. Also, you can save the anonymous script as a user script by giving it a name.","This script is replaced by loading a script with the loadscript or loadandrunscript commands when they are used without a name. ","Example 1","script.anonymous.list()","Displays the content of the anonymous script.","Example 2","print(script.anonymous.source)","Retrieves the source of the anonymous script.","Also see","Anonymous scripts","scriptVar.autorun","scriptVar.list()","scriptVar.name","scriptVar.run()","scriptVar.save()","scriptVar.source","script.anonymous","17040.html");
+Page[258]=new Array("This function deletes a script from nonvolatile memory.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","script.delete(scriptName)","scriptName","The string that represents the name of the script","Example","script.delete("test8")","Deletes a user script named "test8" from nonvolatile memory.","Also see","Delete user scripts","Delete user scripts from the instrument","scriptVar.save()","script.delete()","16853.html");
+Page[259]=new Array("This function returns an iterator that can be used in a for loop to iterate over all the factory scripts.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","for name in script.factory.catalog() do body end","name","String representing the name of the script","body","Code that implements the body of the for loop to process the names in the catalog","Details","Accessing this catalog of scripts allows you to process the factory scripts. The entries will be enumerated in no particular order.","Each time the body of the function executes, name takes on the name of one of the factory scripts. The for loop repeats until all scripts have been iterated.","Example","for name in script.factory.catalog() do"," print(name)","end","Retrieve the catalog listing for factory scripts.","Also see","None","script.factory.catalog()","19931.html");
+Page[260]=new Array("This function creates a script from a specified file.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","scriptVar = script.load(file)","scriptVar = script.load(file, name)","scriptVar","The created script. This is nil if an error is encountered","file","The path and file name of the script file to load","name","The name of the script to be created","Details","The file path may be absolute or relative to the current working directory. The root folder of the USB flash drive has the absolute path "/usb1/". Both the forward slash (/) and backslash (\\) are supported as directory separators.","The file to be loaded must start with the loadscript or loadandrunscript keywords, contain the body of the script, and end with the endscript keyword.","Script naming:","If the name parameter is an empty string, or name is absent (or nil) and the script name cannot be extracted from the file, scriptVar is the only handle to the created script.","If name is given (and not nil), any script name embedded in the file is ignored.","If name conflicts with the name of an existing script in the script.user.scripts table, the existing script’s name attribute is set to an empty string before it is replaced in the script.user.scripts table by the new script.","If name is absent or nil, the command attempts to extract the name of the script from the file. Any conflict between the extracted name and that of an existing script in the scripts table generates an error. If the script name cannot be extracted, the created script's name attribute is initialized to the empty string, and must be set to a valid nonempty string before saving the script to nonvolatile memory.","Example","myTest8 = script.load("/usb1/filename.tsp", "myTest8")","Loads the script myTest8 from the USB flash drive.","Also see","script.new()","script.load()","15063.html");
+Page[261]=new Array("This function creates a script.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","scriptVar = script.new(code)","scriptVar = script.new(code, name)","scriptVar","The name of the variable that will reference the script","code","A string containing the body of the script","name","The name of the script","Details","The name parameter is the name that is added to the script.user.scripts table. If name is not given, an empty string will be used, and the script will be unnamed. If the name already exists in script.user.scripts, the existing script's name attribute is set to an empty string before it is replaced by the new script.","Note that name is the value that is used for the instrument front panel display. If this value is not defined, the script will not be available from the instrument front panel. ","You must save the new script into nonvolatile memory to keep it when the instrument is turned off.","Example 1","myTest8 = script.new("," "display.clear() display.settext('Hello from myTest8')", "myTest8")","myTest8()","Creates a new script referenced by the variable myTest8 with the name "myTest8".","Runs the script. The instrument displays "Hello from myTest8".","Example 2","autoexec = script.new("," "display.clear() display.settext('Hello from autoexec')", 'autoexec')","Creates a new autoexec script that clears the display when the instrument is turned on and displays "Hello from autoexec".","Also see","Create a script using the script.new() command","Global variables and the script.user.scripts table","Named scripts","scriptVar.save()","script.newautorun()","script.new()","15064.html");
+Page[262]=new Array("This function is identical to the script.new() function, but it creates a script with the autorun attribute set to "yes".","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","scriptVar = script.newautorun(code)","scriptVar = script.newautorun(code, name)","scriptVar","The name of the variable that will reference the script","code","A string containing the body of the script","name","The name of the script","Details","The script.newautorun() function is identical to the script.new()function, except that the autorun attribute of the script is set to yes. The script is also automatically run immediately after it is created.","Example","NewAuto = script.newautorun("print('Hello from new auto run command')", 'NewAuto')","print(NewAuto.autorun)","print(NewAuto.name)","Creates a new script called NewAuto that automatically has the autorun attribute set to yes after it is created. The name attribute's value is set to "NewAuto".","Output:","Hello from new auto run command","yes","NewAuto","Also see","Create a script using the script.new() command","Global variables and the script.user.scripts table","Named scripts","scriptVar.save()","script.new()","script.newautorun()","18832.html");
+Page[263]=new Array("This function restores a script that was removed from the run-time environment.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","script.restore(name)","name","The name of the script to be restored","Details","This command copies the script from nonvolatile memory back into the run-time environment, and it creates a global variable with the same name as the name of the script.","Example","script.restore("test9")","Restores a script named "test9" from nonvolatile memory.","Also see","script.delete()","script.restore()","16851.html");
+Page[264]=new Array("This function runs the anonymous script.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","script.run()","run()","Details","Each time the script.run() command is given, the anonymous script is executed. This script can be run using this command many times without having to re-send it. ","Example","run()","Runs the anonymous script.","Also see","script.anonymous","script.run()","18833.html");
+Page[265]=new Array("This function returns an iterator that can be used in a for loop to iterate over all the scripts stored in nonvolatile memory.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","for name in script.user.catalog() do body end","name","String representing the name of the script","body","Code that implements the body of the for loop to process the names in the catalog","Details","Accessing the catalog of scripts stored in nonvolatile memory allows you to process all scripts in nonvolatile memory. The entries will be enumerated in no particular order.","Each time the body of the function executes, name takes on the name of one of the scripts stored in nonvolatile memory. The for loop repeats until all scripts have been iterated.","Example","for name in script.user.catalog() do"," print(name)","end","Retrieve the catalog listing for user scripts.","Also see","None","script.user.catalog()","16862.html");
+Page[266]=new Array("This attribute controls the autorun state of a script.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","No","Not applicable","See Details","See Details","Usage","scriptVar.autorun = state","state = scriptVar.autorun","scriptVar","The name of the variable that references the script","state","Whether or not the script runs automatically when powered on:",""yes" (script runs automatically)",""no" (script does not run automatically)","Details","Autorun scripts run automatically when the instrument is turned on. You can set any number of scripts to autorun.","The run order for autorun scripts is arbitrary, so make sure the run order is not important.","The default value for scriptVar.autorun depends on how the script was loaded. The default is "no" if the script was loaded with loadscript or script.new(). It is "yes" for scripts loaded with loadandrunscript or script.newautorun().","@ Make sure to save the script in nonvolatile memory after setting the autorun attribute so that the instrument will retain the setting.","Example","test5.autorun = "yes"","test5.save()","Assume a script named "test5" is in the run-time environment.","The next time the instrument is turned on, "test5" script automatically loads and runs.","Also see","None","scriptVar.autorun","16852.html");
+Page[267]=new Array("This function generates a script listing.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","scriptVar.list()","scriptVar","The name of variable that references the script","Details","This function generates output in the form of a sequence of response messages (one message for each line of the script). It also generates output of the script control messages (loadscript or loadandrunscript, and endscript).","Example","test7 = script.new("display.clear() display.settext('Hello from my test')", "test7")","test7()","test7.save()","test7.list()","The above example code creates a script named "test7" that displays text on the front panel, lists the script with the following output:","loadscript test7","display.clear() display.settext("Hello from my test")","endscript","Also see","Load a script by sending commands over the remote interface","Retrieve source code one line at a time","scriptVar.list()","17785.html");
+Page[268]=new Array("This attribute contains the name of a script in the run-time environment.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","No","Not applicable","Not applicable","Not applicable","Usage","scriptVar.name = scriptName","scriptName = scriptVar.name","scriptVar","Name of the variable that references the script","scriptName","A string that represents the name of the script","Details","When setting the script name, this attribute renames the script that the variable scriptVar references.","This attribute must be either a valid Lua identifier or the empty string. Changing the name of a script changes the index used to access the script in the script.user.scripts table. Setting the attribute to an empty string removes the script from the table completely, and the script becomes an unnamed script.","As long as there are variables referencing an unnamed script, the script can be accessed through those variables. When all variables that reference an unnamed script are removed, the script will be removed from the run‑time environment.","If the new name is the same as a name that is already used for another script, the name of the other script is set to an empty string, and that script becomes unnamed. ","@ Changing the name of a script does not change the name of any variables that reference that script. The variables will still reference the script, but the names of the script and variables may not match.","Example","test7 = script.new("display.clear() display.settext('Hello from my test')", "")","test7()","print(test7.name)","test7.name = "test7"","print(test7.name) ","test7.save()","The above example calls the script.new() function to create a script with no name, runs the script, names the script "test7", and then saves the script in nonvolatile memory.","Also see","script.new()","scriptVar.save()","Rename a script","scriptVar.name","2589.html");
+Page[269]=new Array("This function runs a script.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","scriptVar.run()","scriptVar()","scriptVar","The name of the variable that references the script","Details","The scriptVar.run() function runs the script; you can also run the script by using scriptVar().","To run a factory script, use script.factory.scripts.scriptName(), replacing scriptName with the name of the desired factory script.","Example","test8.run()","Runs the script referenced by the variable test8.","Also see","None","scriptVar.run()","16856.html");
+Page[270]=new Array("This function saves the script to nonvolatile memory or to a USB flash drive.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","scriptVar.save()","scriptVar.save(filename)","scriptVar","The name of variable that references the script","filename","The file name to use when saving the script to a USB flash drive","Details","The scriptVar.save() function only saves a script to nonvolatile memory or a USB flash drive.","If no filename is given, the script will be saved to internal nonvolatile memory. Only a named script (the script's name attribute is not an empty string) can be saved to internal nonvolatile memory. If a filename is given, the script will be saved to the USB flash drive. ","You are not required to add the file extension, but if you would like to, the only allowed extension is .tsp (see Example 2). ","Example 1","test8.save()","Saves the script referenced by the variable test8 to nonvolatile memory.","Example 2","test8.save("/usb1/myScript.tsp")","Saves the script referenced by the variable test8 to a file named myScript.tsp on your flash drive.","Also see","Save a user script","scriptVar.save()","16863.html");
+Page[271]=new Array("This attribute holds the source code of a script.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","(see Details)","No","Not applicable","Not saved","Not applicable","Usage","code = scriptVar.source","scriptVar.source = nil","scriptVar","The name of the variable that references the script that contains the source code","code","The body of the script","Details","The loadscript or loadandrunscript and endscript keywords are not included in the source code. ","The body of the script is a single string with lines separated by the new line character.","The instrument automatically keeps the source for all scripts loaded on the instrument. To free up memory or to obfuscate the code, assign nil to the source attribute of the script. Although this attribute is writable, it can only be set to the nil value.","Example","test7 = script.new("display.clear() display.settext('Hello from my test')", "")","print(test7.source)","The above example creates a script called "test7" that displays a message on the front panel.","Retrieve the source code.","Output:","display.clear() display.settext('Hello from my test')","Also see","scriptVar.list()","scriptVar.source","16867.html");
+Page[272]=new Array("This attribute configures the baud rate for the RS-232 port.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Not applicable","Nonvolatile memory","9600","Usage","baud = serial.baud","serial.baud = baud","baud","The baud rate (300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600 or 115200)","Details","A new baud rate setting takes effect when the command to change it is processed.","@ Allow ample time for the command to be processed before attempting to communicate with the instrument again. If possible, set the baud rate from one of the other command interfaces or from the front panel.","The reset function has no effect on data bits.","Example","serial.baud = 1200","Sets the baud rate to 1200.","Also see","RS-232 interface operation","serial.databits","serial.flowcontrol","serial.parity","serial.baud","15068.html");
+Page[273]=new Array("This attribute configures character width (data bits) for the RS-232 port.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Not applicable","Nonvolatile memory","8","Usage","bits = serial.databits","serial.databits = bits","bits","An integer representing the character width (7 or 8)","Details","A new data width setting takes effect when the command to change it is processed.","@ Allow ample time for the command to be processed before attempting to communicate with the instrument again. If possible, set the character width from one of the other command interfaces or from the front panel.","The reset function has no effect on data bits.","Example","serial.databits = 8","Sets data width to 8.","Also see","RS-232 interface operation","serial.baud","serial.flowcontrol","serial.parity","serial.databits","15069.html");
+Page[274]=new Array("This attribute configures flow control for the RS-232 port.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Not applicable","Nonvolatile memory",""none" (serial.FLOW_NONE)","Usage","flow = serial.flowcontrol","serial.flowcontrol = flow","flow","A string representing flow control configuration; set to:",""none" or serial.FLOW_NONE (selects no flow control)",""hardware" or serial.FLOW_HARDWARE (selects hardware flow control)","Details","A new flow control setting takes effect when the command to change it is processed.","@ Allow ample time for the command to be processed before attempting to communicate with the instrument again. If possible, set the flow control from one of the other command interfaces or from the front panel.","The reset function has no effect on flow control.","Example","serial.flowcontrol = serial.FLOW_NONE","Sets flow control to none.","Also see","serial.baud","serial.databits","serial.parity","serial.flowcontrol","15070.html");
+Page[275]=new Array("This attribute configures parity for the RS-232 port.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Not applicable","Nonvolatile memory",""none" (serial.PARITY_NONE)","Usage","parity = serial.parity","serial.parity = parity","parity","Set parity to one of the following values:","Select no parity ("none" or serial.PARITY_NONE)","Select even parity ("even" or serial.PARITY_EVEN)","Select odd parity ("odd" or serial.PARITY_ODD)","Details","A new parity setting takes effect when the command to change it is processed.","@ Allow ample time for the command to be processed before attempting to communicate with the instrument again. If possible, set parity from one of the other command interfaces or from the front panel.","The reset function has no effect on parity.","Example","serial.parity = serial.PARITY_NONE","Sets parity to none.","Also see","RS-232 interface operation","serial.baud","serial.databits","serial.flowcontrol","serial.parity","15071.html");
+Page[276]=new Array("This function reads available characters (data) from the serial port.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","data = serial.read(maxchars)","data","A string consisting of all data read from the serial port","maxchars","An integer that specifies the maximum number of characters to read","Details","This function will read available characters from the serial port. It will not wait for new characters to arrive. As long as maxchars is less than 200 characters, all characters received by the serial port (before the serial.read() command is executed) are returned. If too many characters are received between calls to this function, the RS-232 buffers will overflow and some characters may be lost.","Call this function as many times as necessary to receive the required number of characters. For optimal performance, use a small delay between repeated calls to this function.","The data returned is the raw data stream read from the port. No characters, such as control characters or terminator characters, are interpreted nor will the data stream be altered.","This function cannot be used if the serial port is enabled as a command interface; a settings conflict error will be generated.","Example","data = serial.read(200)","print(data)","Read data from the serial port.","Output:","John Doe","The above output indicates that the string "John Doe" was read from the serial port.","Also see","serial.write()","serial.read()","15072.html");
+Page[277]=new Array("This function writes data to the serial port.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","serial.write(data)","data","A string representing the data to write","Details","This function writes the specified string to the serial port, where it can be read by connected equipment (for example, a component handler). ","No terminator characters are added to the data, and data is written exactly as specified by the data parameter.","Example","serial.write("1 2 3 4")","Write data string "1 2 3 4" to the serial port.","Also see","serial.read()","serial.write()","15073.html");
+Page[278]=new Array("This function sets the real-time clock (sets current time of the system).","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","settime(time)","time","The time in seconds since January 1, 1970 UTC","Details","This function sets the date and time of the instrument based on the time parameter (specified in UTC time). UTC time is specified as the number of seconds since Jan 1, 1970, UTC. You can use UTC time from a local time specification, or you can use UTC time from another source (for example, your computer). ","To use the Lua os.time() function to generate a time value in UTC time, use the following format: ","os.time({year = year, month = month, day = day, hour = hour, min = min, sec = sec})","Where:","year","= A full year (2006 or later)","month","= The desired month (1 to 12)","day","= The desired day (1 to 31)","hour","= The desired hour (00 to 23)","min","= The desired minute (00 to 59)","sec","= The desired second (00 to 59)","When you are using the os.time() function, make sure that you include the year, month, and day parameters, which are mandatory (the rest are optional). If the other parameters are not used, they default to noon for that day. ","Set the time zone before calling the os.time() function.","Example","systemTime = os.time({year = 2010,"," month = 3,"," day = 31,"," hour = 14,"," min = 25})","settime(systemTime)","Sets the date and time to Mar 31, 2010 at 2:25 pm.","Also see","gettimezone()","settimezone()","settime()","13943.html");
+Page[279]=new Array("This function sets the local time zone.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","settimezone(offset)","settimezone(offset, dstOffset, dstStart, dstEnd)","offset","String representing offset from UTC","dstOffset","String representing daylight savings offset from UTC","dstStart","String representing when daylight savings time starts","dstEnd","String representing when daylight savings time ends","Details","The time zone is only used when converting between local time and UTC time when using the os.time() and os.date() functions.","If only one parameter is given, the same time offset is used throughout the year. If four parameters are given, time is adjusted twice during the year for daylight savings time.","offset and dstOffset are strings of the form "[+|-]hh[:mm[:ss]]" that indicate how much time must be added to the local time to get UTC time: hh is a number between 0 and 23 that represents hours; mm is a number between 0 and 59 that represents minutes; ss is a number between 0 and 59 that represents seconds. The minutes and seconds fields are optional.","The UTC-5 time zone would be specified with the string "5" because UTC-5 is 5 hours behind UTC and one must add 5 hours to the local time to get UTC time. The time zone UTC4 would be specified as "-4" because UTC4 is 4 hours ahead of UTC and 4 hours must be subtracted from the local time to get UTC.","dstStart and dstEnd are strings of the form "MM.w.dw/hh[:mm[:ss]]" that indicate when daylight savings time begins and ends respectively: MM is a number between 1 and 12 that represents the month; w is a number between 1 and 5 that represents the week within the month; dw is a number between 0 and 6 that represents the day of the week (where 0 is Sunday). The rest of the fields represent the time of day that the change takes effect: hh represents hours; mm represents minutes; ss represents seconds. The minutes and seconds fields are optional. The week of the month and day of the week fields are not specific dates.","Example","settimezone("8", "1", "3.3.0/02", "11.2.0/02")
","settimezone(offset)","Sets offset to equal +8 hours, +1 hour for DST, starts on Mar 14 at 2:00 a.m, ends on Nov 7 at 2:00 a.m.","Sets local time zone to offset.","Also see","gettimezone()","settime()","settimezone()","15021.html");
+Page[280]=new Array("This attribute specifies which saved setup to recall when the instrument is turned on.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Not applicable","Nonvolatile memory","0","Usage","N = setup.poweron","setup.poweron = N","N","An integer that specifies the setup to recall when the instrument power is turned on (0 to 5)","Details","When N = 0, the instrument uses the factory default setup when it is turned on. When N is set to 1 to 5, it uses the setup saved with setup.save().","Only setups stored in nonvolatile memory are available (you cannot recall a script from a USB flash drive with this command) . To save a script to be used when the instrument is powered on, you can create a configuration script and name it autoexec.","Example","setup.poweron = 0","Set the instrument to use the factory default setup when power is turned on.","Also see","setup.save() ","Start-up (power-on) configuration","setup.poweron","15081.html");
+Page[281]=new Array("This function recalls settings from a saved setup.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","setup.recall(id)","id","An integer or string specifying the location of the setup to recall:","Factory default setup (0)","User-saved setup in nonvolatile memory (1 to 5 )","User-saved setup on a USB flash drive ("/path/filename")","Details","When the id parameter is an integer (n), it is interpreted as the setup number to restore from the instrument's nonvolatile memory. When n = 0, the instrument recalls the factory default setup; when n = 1 to 5, the instrument recalls a user-saved setup from nonvolatile memory. ","When the id parameter is a string, it is interpreted as the path and file name of the setup to restore from a file on a USB flash drive. The path may be absolute or relative to the current working directory.","Before a setup is recalled, an instrument reset is performed.","Example 1","setup.recall(1)","Recall the user-saved setup at location 1 .","Example 2","setup.recall("/usb1/KEITHLEY_30730.set")","Recall a user-saved setup stored in a file named KEITHLEY_30730 on a USB flash drive.","Also see","setup.save()","User setup","setup.recall()","15082.html");
+Page[282]=new Array("This function saves the present setup as a user-saved setup.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","setup.save(id)","id","An integer or string specifying where to save the user setup:","Save in nonvolatile memory (1 to 5)","Save as user-saved setup on a USB flash drive ("/path/filename")","When the id parameter is an integer (n), it is interpreted as the setup number to save to the instrument's nonvolatile memory.","@ When you save to a specified integer (1 to 5) in nonvolatile memory, the previous setup at that same location is overwritten.","When the id parameter is a string, it is interpreted as the path and file name of the location to save the present setup on a USB flash drive. The path may be absolute or relative to the current working directory.","Example","setup.save(5)","Saves the present setup to the internal memory of the instrument at location 5.","Also see","setup.recall()","User setup","setup.save()","15083.html");
+Page[283]=new Array("This function terminates all overlapped operations on the specified source‑measure unit (SMU).","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.abort()","X","SMU channel (for example, smua.abort() specifies SMU channel A).","Details","The smuX.abort() function will not turn the output off or change any settings.","If used to abort a sweep, when executed, the SMU will exit its trigger model immediately and return to the trigger model's idle state.","Example","smua.abort()","Terminates all overlapped operations on SMU channel A.","Also see","smuX.measure.overlappedY()","smuX.trigger.initiate()","smuX.abort()","15088.html");
+Page[284]=new Array("This function returns a specified reading buffer's statistics.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","statistics = smuX.buffer.getstats(bufferVar)","statistics","The reading buffer's statistics","X","Source‑measure unit (SMU) channel (for example, smua.buffer.getstats() specifies SMU channel A)","bufferVar","The reading buffer to process","Details","This function returns a table with statistical data about the data placed in the buffer.","The SMU will automatically update reading buffer statistics as data is added to the reading buffer. When the reading buffer is configured to wrap around and overwrite older data with new data, the buffer statistics will include the data that was overwritten.","The table returned from this function is a snapshot. Although the SMU continues to update the statistics, the table returned will not be updated. To get fresh statistics, call this function again.","The statistics parameter has the following attributes:","Attribute","When returned","Description","n","Always","The number of data points on which the statistics are based","mean","When n > 0","The average of all readings added to the buffer","stddev","When n > 1","The standard deviation of all readings (samples) added to the buffer","min","When n > 0","A table containing data about the minimum reading value added to the buffer","max","When n > 0","A table containing data about the maximum reading value added to the buffer","If n equals zero (0), all other attributes will be nil because there is no data to base any statistics on. If n equals 1, the stddev attribute will be nil because the standard deviation of a sample size of 1 is undefined.","The min and max entries each have the following attributes:","Attribute","Description","measurefunction","String indicating the function measured for the reading (current, voltage, ohms or watts)","measurerange","The full-scale range value for the measure range used when the measurement was made","reading","The reading value","sourcefunction","String indicating the source function at the time of the measurement (current or voltage)","sourceoutputstate","String indicating the state of the source (off or on)","sourcerange","Full-scale range value for the source range used when the measurement was made","sourcevalue","If bufferVar.collectsourcevalues is enabled, the sourced value in effect at the time of the reading","status","Status value for the reading; the status value is a floating-point number that encodes the status value into a floating-point value","timestamp","If bufferVar.collecttimestamps is enabled, the timestamp, in seconds, between when the reading was acquired and when the first reading in the buffer was acquired; adding this value to the base timestamp will give the actual time the measurement was acquired","Also see","smuX.buffer.recalculatestats()","smuX.buffer.getstats()","18554.html");
+Page[285]=new Array("This function recalculates the specified reading buffer's statistics.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.buffer.recalculatestats(bufferVar)","X","Source‑measure unit (SMU) channel (for example, smua.buffer.recalculatestats() specifies SMU channel A)","bufferVar","The reading buffer to process","Details","This function will cause the SMU to regenerate the reading buffer statistics on the specified reading buffer. As the SMU automatically updates reading buffer statistics as data is added to the reading buffer, this function is generally not needed. When the reading buffer is configured to wrap around and overwrite older data with new data, the buffer statistics will include the data that was overwritten. Use this function to recalculate the statistics including only the data that is currently stored in the buffer.","Also see","bufferVar.fillmode","smuX.buffer.getstats()","smuX.buffer.recalculatestats()","18556.html");
+Page[286]=new Array("This attribute stores the date of the last calibration adjustment.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU cal. restore","SMU nonvolatile memory","Initially set to factory calibration date","Usage","adjustDate = smuX.cal.adjustdate","smuX.cal.adjustdate = adjustDate","adjustDate","Date of the last calibration adjustment","X","Source‑measure unit (SMU) channel (for example, smua.cal.adjustdate applies to SMU channel A)","Details","This attribute stores the adjustment date associated with the active calibration set. The adjustment date can be read at any time, but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function.","You cannot change the adjust date without first making a change to the calibration constants.","Once you change any calibration constants, you must set the adjustment date before being allowed to save the calibration data to the SMU's nonvolatile memory.","This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute will reflect the date stored with that set.","smuX.cal.adjustdate must be set to the date the adjustment was done using the UTC time and date. The date is stored as the number of seconds since UTC, 12:00 am Jan 1, 1970.","Due to the internal storage format, smuX.cal.adjustdate is only accurate to within a few minutes of the value set.","Example","smua.cal.adjustdate = os.time()","Sets the adjustment date for SMU channel A to the current time set on the instrument.","Also see","Adjustment","smuX.cal.date","smuX.cal.due","smuX.cal.lock()","smuX.cal.restore()","smuX.cal.save()","smuX.cal.state","smuX.cal.unlock()","smuX.cal.adjustdate","15093.html");
+Page[287]=new Array("This attribute stores the calibration date of the active calibration set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU cal. restore","SMU nonvolatile memory","Initially set to factory calibration date","Usage","calDate = smuX.cal.date","smuX.cal.date = calDate","calDate","The active calibration set's calibration date","X","Source‑measure unit (SMU) channel (for example, smua.cal.date applies to SMU channel A)","Details","This attribute stores the calibration date associated with the active calibration set. The calibration date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function.","This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute will reflect the date stored with that set.","smuX.cal.date must be set to the date the calibration was done using the UTC time and date. The date is stored as the number of seconds since UTC 12:00 am Jan 1, 1970.","Due to the internal storage format, smuX.cal.date is accurate to within a few minutes of the value set.","Example","smua.cal.date = os.time()","Sets calibration date for SMU channel A to the current time set on the instrument.","Also see","Adjustment","smuX.cal.adjustdate","smuX.cal.due","smuX.cal.lock()","smuX.cal.restore()","smuX.cal.save()","smuX.cal.state","smuX.cal.unlock()","smuX.cal.date","15094.html");
+Page[288]=new Array("This attribute stores the calibration due date for the next calibration.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU cal. restore","SMU nonvolatile memory","0","Usage","calDue = smuX.cal.due","smuX.cal.due = calDue","calDue","Due date of next calibration (0 indicates that no date is set)","X","Source‑measure unit (SMU) channel (for example, smua.cal.due applies to SMU channel A)","Details","This attribute stores the calibration due date associated with the active calibration set. The calibration due date can be read at any time but can only be assigned a new value when calibration has been enabled with the smuX.cal.unlock() function.","This attribute is stored with the active calibration set. If a different calibration set is restored, this attribute will reflect the due date stored with that set.","smuX.cal.due must be set to the date the next calibration is required using the UTC time and date. The date is stored as the number of seconds since UTC 12:00 am Jan 1, 1970.","Due to the internal storage format, smuX.cal.due is only accurate to within a few minutes of the value set.","Example","smua.cal.due = os.time() + 365 * 24 * 60 * 60","Sets the SMU channel A calibration due date equal to one year from the current time set on the instrument.","Also see","Adjustment","smuX.cal.adjustdate","smuX.cal.date","smuX.cal.lock()","smuX.cal.restore()","smuX.cal.state","smuX.cal.unlock()","smuX.cal.due","15095.html");
+Page[289]=new Array("This function performs calibration of the fast analog-to-digital converter (fast ADC).","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.cal.fastadc()","X","Source‑measure unit (SMU) channel (for example, smua.cal.fastadc() specifies SMU channel A)","Details","This function automatically performs all the steps required to calibrate the fast ADC. This function uses the readings obtained when calibrating the measure ranges (make sure both voltage and current calibration has been completed before calling this function).","Example","smua.cal.fastadc()","Performs fast ADC calibration for SMU Channel A.","Also see","Adjustment","smuX.measure.calibrateY()","smuX.cal.fastadc()","19478.html");
+Page[290]=new Array("This function disables commands that change calibration settings.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.cal.lock()","X","Source‑measure unit (SMU) channel (for example, smua.cal.lock() specifies SMU channel A)","Details","This function disables calibration functions that can change calibration settings. The calibration constants must be written to nonvolatile memory, or a previous calibration set must be restored prior to locking calibration. Error code 5012, "Cal data not saved - save or restore before lock," will result if this function is called when the calibration state is smuX.CALSTATE_CALIBRATING. ","Example","smua.cal.lock()","Disables calibration functions for SMU channel A.","Also see","Adjustment","smuX.cal.restore()","smuX.cal.save()","smuX.cal.state","smuX.cal.lock()","15089.html");
+Page[291]=new Array("This function performs calibration of the overvoltage protection limit (OVP).","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.cal.ovp()","X","Source‑measure unit (SMU) channel (for example, smua.cal.ovp() specifies SMU channel A)","Details","This function automatically performs all the steps required to calibrate the overvoltage protection (OVP) limit circuit. Since this function uses the readings obtained during calibration of the measure ranges, make sure voltage calibration has been completed before calling this function.","Example","smua.cal.ovp()","Performs OVP calibration for SMU Channel A.","Also see","Adjustment","smuX.measure.calibrateY()","smuX.cal.ovp()","21474.html");
+Page[292]=new Array("This attribute stores the password required to enable calibration.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (W)","Yes","Not applicable","SMU nonvolatile memory",""KI0026XX"","Usage","smuX.cal.password = newPassword","X","SMU channel (for example, smua.cal.password applies to SMU channel A)","newPassword","The new password (string)","Details","A new password can only be assigned when calibration has been unlocked.","The calibration password is write-only and cannot be read.","Example","smua.cal.password = "LetMeIn"","Assigns a new calibration password for SMU channel A.","Also see","Adjustment","smuX.cal.unlock()","smuX.cal.password","15096.html");
+Page[293]=new Array("This attribute controls which calibration constants are used for all subsequent measurements.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset SMU reset SMU cal. lock Recall setup","Not saved","0 (smuX.CAL_AUTO)","Usage","calPolarity = smuX.cal.polarity","smuX.cal.polarity = calPolarity","calPolarity","The polarity to use for measurements. Set to one of the following values:","0 or smuX.CAL_AUTO: Automatic polarity detection","1 or smuX.CAL_POSITIVE: Measure with positive polarity calibration constants","2 or smuX.CAL_NEGATIVE: Measure with negative polarity calibration constants","X","SMU channel (for example, smua.cal.polarity applies to SMU channel A)","Details","This attribute controls which polarity calibration constants are used to make all subsequent measurements. This attribute does not affect the smuX.measure.calibrateY() or smuX.source.calibrateY() commands. The polarity for those commands are dictated by the range parameter given to the command. The measurement calibration commands require the measurements provided to have been made using the polarity being calibrated. ","When making those measurements with calibration points far away from zero, the desired polarity constants are inherently used. When measuring near zero, it is possible for the measurement to be made using the calibration constants from either polarity without knowing which was used. Setting this attribute to positive or negative forces measurements to be made using the calibration constants for a given polarity rather than basing the choice on the raw measurement data.","This attribute can only be set to positive or negative when calibration is unlocked. This attribute will automatically be set to smuX.CAL_AUTO when calibration is locked.","Example","smua.cal.polarity = smua.CAL_POSITIVE","Selects positive calibration constants for all subsequent measurements on SMU channel A.","Also see","Adjustment","reset()","smuX.cal.lock()","smuX.cal.unlock()","smuX.measure.calibrateY()","smuX.reset()","smuX.source.calibrateY()","smuX.cal.polarity","15097.html");
+Page[294]=new Array("This function loads a stored set of calibration constants.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.cal.restore()","smuX.cal.restore(calset)","X","Source‑measure unit (SMU) channel (for example, smua.cal.restore() applies to SMU channel A)","calset","The calibration set to be loaded. Set calset to one of the following values:","0 or smuX.CALSET_NOMINAL: A set of calibration constants that are uncalibrated, but set to nominal values to allow rudimentary functioning of the instrument","1 or smuX.CALSET_FACTORY: The calibration constants when the instrument left the factory","2 or smuX.CALSET_DEFAULT: The normal calibration set","3 or smuX.CALSET_PREVIOUS: The calibration set that was used before the last default set was overwritten","Details","This function will overwrite the current set of calibration constants with constants read from nonvolatile memory.","This function will be disabled until a successful call to smuX.cal.unlock() is made.","If calset is not specified, smuX.CALSET_DEFAULT will be used.","Example","smua.cal.restore()","Restores factory calibration constants for SMU channel A.","Also see","Adjustment","smuX.cal.lock()","smuX.cal.unlock()","smuX.cal.restore()","15090.html");
+Page[295]=new Array("This function stores the active calibration constants to nonvolatile memory.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.cal.save()","X","Source‑measure unit (SMU) channel (for example, smua.cal.save() applies to SMU channel A)","Details","This function will store the active set of calibration constants to nonvolatile memory. The previous calibration constants (from the default calibration set) will be copied to the previous calibration set (smuX.CALSET_PREVIOUS) prior to overwriting the default calibration set.","This function will be disabled until a successful call to smuX.cal.unlock() is made. If any of the calibration constants have been changed, this function will be disabled unless the calibration date, the calibration due date, and the calibration adjust date have been assigned new values.","Example","smua.cal.save()","Stores calibration constants for SMU channel A in nonvolatile memory.","Also see","Adjustment","smuX.cal.adjustdate","smuX.cal.date","smuX.cal.due","smuX.cal.lock()","smuX.cal.restore()","smuX.cal.unlock()","smuX.cal.save()","15091.html");
+Page[296]=new Array("This attribute stores the present calibration state.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not saved","Not applicable","Usage","calState = smuX.cal.state","calState","The present calibration state. When reading this read-only attribute, calState will have one of the following values:","0 or smuX.CALSTATE_LOCKED: Calibration is locked","1 or smuX.CALSTATE_CALIBRATING: The calibration constants or dates have been changed but not yet saved to nonvolatile memory","2 or smuX.CALSTATE_UNLOCKED: Calibration is unlocked but none of the calibration constants or dates have changed since the last save/restore","X","SMU channel (for example, smua.cal.state applies to SMU Channel A)","Details","This read-only attribute indicates the calibration state of the instrument: locked, unlocked, or calibrating.","Example","calstate = smua.cal.state","print(calstate)"," ","Reads calibration state for SMU Channel A.","Output: 0.000000e+00","The above output indicates that calibration is locked.","Also see","Adjustment","smuX.cal.lock()","smuX.cal.restore()","smuX.cal.save()","smuX.cal.unlock()","smuX.cal.state","15098.html");
+Page[297]=new Array("This function enables the commands that change calibration settings.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.cal.unlock(password)","X","Source‑measure unit (SMU) channel (for example, smua.cal.unlock() applies to SMU channel A)","password","Calibration password","Details","This function enables the calibration functions to change the calibration settings.","The password when the instrument is shipped from the factory is "KI0026XX".","Example","smua.cal.unlock("KI0026XX")","Unlocks calibration for SMU channel A.","Also see","Adjustment","smuX.cal.lock()","smuX.cal.password","smuX.cal.state","smuX.cal.unlock()","15092.html");
+Page[298]=new Array("This function calibrates the high/sense high contact check measurement.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.contact.calibratehi(cp1Measured, cp1Reference, cp2Measured, cp2Reference)","X","Source‑measure unit (SMU) channel (for example, smua.contact.calibratehi() applies to SMU channel A)","cp1Measured","The value measured by this SMU for calibration point 1","cp1Reference","The reference measurement for calibration point 1 as measured externally","cp2Measured","The value measured by this SMU for calibration point 2","cp2Reference","The reference measurement for calibration point 2 as measured externally","Details","Contact check measurement calibration does not require range information.","Typically, calibration points one and two will be near 0 W and 50 W, respectively.","All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the active calibration set. If not, corruption of the calibration constants may result.","The new calibration constants will be activated immediately but are not written to nonvolatile storage. Use smuX.cal.save() to save the new constants to nonvolatile storage. The active calibration constants will stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile storage with the smuX.cal.restore() function.","This function will be disabled until a successful call to smuX.cal.unlock() is made.","Example","-- Short SENSE LO and LO terminals","-- Short SENSE HI and HI terminals","-- Allow readings to settle, then get measurements","r0_hi, r0_lo = smua.contact.r()","-- Connect 50 OHM resistor between SENSE LO and LO","-- Connect 50 OHM resistor between SENSE HI and HI","-- Allow readings to settle, then get measurements","r50_hi, r50_lo = smua.contact.r()","smua.contact.calibratelo(r0_lo, Z_actual_lo, r50_lo,"," 50_ohm_actual_lo)","smua.contact.calibratehi(r0_hi, Z_actual_hi, r50_hi,"," 50_ohm_actual_hi)","Performs contact","check on SMU","channel A.","Install and measure","two resisters.","Sends contact check LO calibration","command."," ","Send contact check HI calibration command.","Also see","Adjustment","smuX.cal.restore()","smuX.cal.save()","smuX.cal.unlock()","smuX.contact.calibratelo()","smuX.contact.calibratehi()","15099.html");
+Page[299]=new Array("This function calibrates the low/sense low contact check measurement.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.contact.calibratelo(cp1Measured, cp1Reference, cp2Measured, cp2Reference)","X","Source‑measure unit (SMU) channel (for example, smua.contact.calibratelo() applies to SMU channel A)","cp1Measured","The value measured by this SMU for calibration point 1","cp1Reference","The reference measurement for calibration point 1 as measured externally","cp2Measured","The value measured by this SMU for calibration point 2","cp2Reference","The reference measurement for calibration point 2 as measured externally","Details","Contact check measurement calibration does not require range information.","Typically, calibration points one and two will be near 0 W and 50 W, respectively.","All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the active calibration set. If not, corruption of the calibration constants may result.","The new calibration constants will be activated immediately but are not written to nonvolatile storage. Use smuX.cal.save() to save the new constants to nonvolatile storage. The active calibration constants will stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile storage with the smuX.cal.restore() function.","This function will be disabled until a successful call to smuX.cal.unlock() is made.","Example","-- Short SENSE LO and LO terminals","-- Short SENSE HI and HI terminals","-- Allow readings to settle, then get measurements","r0_hi, r0_lo = smua.contact.r()","-- Connect 50 OHM resistor between SENSE LO and LO","-- Connect 50 OHM resistor between SENSE HI and HI","-- Allow readings to settle, then get measurements","r50_hi, r50_lo = smua.contact.r()","smua.contact.calibratelo(r0_lo, Z_actual_lo, r50_lo,"," 50_ohm_actual_lo)","smua.contact.calibratehi(r0_hi, Z_actual_hi, r50_hi,"," 50_ohm_actual_hi)","Performs contact","check on SMU","channel A.","Install and measure","two resisters.","Sends contact check LO calibration","command.","Send contact check HI calibration command.","Also see","Adjustment","smuX.cal.restore()","smuX.cal.save()","smuX.cal.unlock()","smuX.contact.calibratehi()","smuX.contact.calibratelo()","15100.html");
+Page[300]=new Array("This function determines if contact resistance is lower than the threshold.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.contact.check()","X","Source‑measure unit (SMU) channel (for example, smua.contact.check() applies to SMU channel A)","Details","This function returns true if the contact resistance is below the threshold; this function returns false if it is above the threshold. The threshold value is set by the smuX.contact.threshold attribute.","Attempting to perform a contact check measurement when any of the following conditions exist will generate errors:","When output is on and any of the following:","SMU is a current source with current range set to less than 1 mA (error code 5065, "I range too low for contact check")","SMU is a voltage source with current limit set to less than 1 mA (error code 5050, "I limit too low for contact check")","When output is off and any of the following:","The output off mode is High-Z (error code 5048, "Contact check not valid with HIGH-Z OUTPUT off")","The output off mode is Normal with the smuX.source.offfunc attribute set to smuX.OUTPUT_DCVOLTS and the off current limit set to less than 1 mA (error code 5066, "source.offlimiti too low for contact check")","The output off mode is Normal with the smuX.source.offfunc attribute set to smuX.OUTPUT_DCAMPS and the source range is less than 1 mA (error code 5065, "I range too low for contact check")","Example","if not smua.contact.check() then"," -- take action","end","Takes action if contact check on SMU channel A fails.","Also see","Contact check connections","Contact check measurements","smuX.contact.speed","smuX.contact.threshold","smuX.source.offfunc","smuX.contact.check()","15101.html");
+Page[301]=new Array("This function measures aggregate contact resistance.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","rhi, rlo = smuX.contact.r()","rhi","The measured aggregate contact resistance on the high/sense high side","rlo","The measured aggregate contact resistance on the low/sense low side","X","Source‑measure unit (SMU) channel (for example, smua.contact.r() applies to SMU channel A)","Details","Attempting to perform a contact resistance measurement when any of the following conditions exist will generate an error:","When output is on and any of the following:","SMU is a current source with current range set to less than 1 mA (error code 5065, "I range too low for contact check")","SMU is a voltage source with current limit set to less than 1 mA (error code 5050, "I limit too low for contact check")","When output is off and any of the following:","The output off mode is High-Z (error code 5048, "Contact check not valid with HIGH-Z OUTPUT off")","The output off mode is Normal with the smuX.source.offfunc attribute set to smuX.OUTPUT_DCVOLTS and the off current limit set to less than 1 mA (error code 5066, "source.offlimiti too low for contact check")","The output off mode is Normal with the smuX.source.offfunc attribute set to smuX.OUTPUT_DCAMPS and the source range is less than 1 mA (error code 5065, "I range too low for contact check")","Example","if not smua.contact.check() then"," smua.contact.speed = smua.CONTACT_SLOW"," rhi, rlo = smua.contact.r()"," print(rhi, rlo)"," exit()","end","Check contacts against threshold.","Set speed for SMU channel A to slow.","Get resistance readings.","Output contact resistances to the host.","Terminate execution.","Also see","Contact check connections","Contact check measurements","smuX.contact.check()","smuX.contact.speed","smuX.contact.r()","15102.html");
+Page[302]=new Array("This attribute stores the speed setting for contact check measurements.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset SMU reset Recall setup","Not saved","0 (smuX.CONTACT_FAST)","Usage","speedSetting = smuX.contact.speed","smuX.contact.speed = speedSetting","speedSetting","The speed setting. Set to one of the following:","0 or smuX.CONTACT_FAST","1 or smuX.CONTACT_MEDIUM","2 or smuX.CONTACT_SLOW","X","SMU channel (for example, smua.contact.speed applies to SMU channel A)","Details","This setting controls the aperture of measurements made for contact check. It does not affect the smuX.measure.nplc aperture setting.","The speed setting can have a dramatic effect on the accuracy of the measurement (see specifications).","Example","smua.contact.speed = smua.CONTACT_SLOW","Configure contact check for higher accuracy on SMU channel A.","Also see","Contact check connections","Contact check measurements","reset()","smuX.contact.check()","smuX.contact.r()","smuX.reset()","smuX.contact.speed","15103.html");
+Page[303]=new Array("This attribute stores the resistance threshold for the smuX.contact.check() function.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset SMU reset Recall setup","Not saved","100 (100 W)","Usage","rValue = smuX.contact.threshold","smuX.contact.threshold = rValue","rValue","The resistance above which contact check should fail (measured in ohms)","X","SMU channel (for example, smua.contact.threshold applies to SMU channel A)","Details","The threshold should be set to less than 1 kW.","Example","smua.contact.threshold = 5","Set the contact check threshold for SMU channel A to 5 W.","Also see","Contact check connections","Contact check measurements","reset()","smuX.contact.check()","smuX.reset()","smuX.contact.threshold","15104.html");
+Page[304]=new Array("This function creates a reading buffer.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","bufferVar = smuX.makebuffer(bufferSize)","bufferVar","The created reading buffer","X","Source‑measure unit (SMU) channel (for example, smua.makebuffer() applies to SMU channel A)","bufferSize","Maximum number of readings that can be stored","Details","Reading buffers can be created and allocated dynamically using this function. Use bufferSize to designate the number of readings the buffer can store.","Dynamically allocated reading buffers can be used interchangeably with the smuX.nvbufferY buffers.","A reading buffer can be deleted by setting all references to the reading buffer equal to nil, then running the garbage collector (see the collectgarbage() function in Standard libraries).","Example","mybuffer2 = smua.makebuffer(200)","Creates a 200 element reading buffer (mybuffer2)for SMU channel A .","Also see","collectgarbage() in Base library functions","Remote reading buffer programming","savebuffer()","smuX.nvbufferY","smuX.makebuffer()","15105.html");
+Page[305]=new Array("This attribute contains the analog-to-digital converter selection.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset SMU reset Recall setup","Saved setup","0 (smuX.ADC_INTEGRATE)","Usage","adc = smuX.measure.adc","smuX.measure.adc = adc","adc","The analog-to-digital (A/D) converter used for measurements. Set to one of the following:","0 or smuX.ADC_INTEGRATE: Integrating A/D converter","1 or smuX.ADC_FAST: Fast A/D converter","X","Source‑measure unit (SMU) channel (for example, smua.measure.adc applies to SMU channel A).","Details","When making measurements, the SMU uses one of two types of analog-to-digital converters. This attribute controls which analog to converter is used.","Example","smua.measure.adc = smua.ADC_FAST","Selects the fast A/D converter for SMU channel A.","Also see","Analog-to-digital converter","smuX.measure.nplc","smuX.measure.adc","17114.html");
+Page[306]=new Array("This attribute stores the measurement autorange setting.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset SMU reset Recall setup","Saved setup","1 (smuX.AUTORANGE_ON)","Usage","autoRange = smuX.measure.autorangeY","smuX.measure.autorangeY = autoRange","autoRange","The state of the measurement autorange setting; set to one of the following values:","0 or smuX.AUTORANGE_OFF: Disabled","1 or smuX.AUTORANGE_ON: Enabled","2 or smuX.AUTORANGE_FOLLOW_LIMIT: Measure range automatically set to the limit range","X","Source‑measure unit (SMU) channel (for example, smua.measure.autorangev applies to SMU channel A)","Y","SMU measure function (v = voltage, i = current)","Details","This attribute indicates the measurement autorange state. Its value will be smuX.AUTORANGE_OFF when the SMU measure circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.","Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed range. The fixed range will be the present SMU measure range.","Setting this attribute to smuX.AUTORANGE_ON puts the SMU measure circuit into autorange mode. It will remain on its present measure range until the next measurement is requested.","Example","smua.measure.autorangev = 1","Enables voltage measurement autoranging for SMU channel A. Alternatively, the value 1 may be replaced with smua.AUTORANGE_ON.","Also see","Range","reset()","setup.recall()","smuX.measure.rangeY","smuX.reset()","smuX.measure.autorangeY","15107.html");
+Page[307]=new Array("This attribute sets the behavior of the source-measure unit's (SMU's) A/D internal reference measurements (autozero).","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset SMU reset Recall setup","Saved setup","2 (smuX.AUTOZERO_AUTO)","Usage","azMode = smuX.measure.autozero","smuX.measure.autozero = azMode","azMode","Indicates status of autozero; set to one of the following values:","0 or smuX.AUTOZERO_OFF: Autozero disabled","1 or smuX.AUTOZERO_ONCE: Performs autozero once, then disables autozero","2 or smuX.AUTOZERO_AUTO: Automatic checking of reference and zero measurements; an autozero is performed when needed","X","SMU channel (for example, smua.measure.autozero applies to SMU channel A)","Details","The integrating analog-to-digital converter (ADC) uses a ratiometric A/D conversion technique. To ensure the accuracy of readings, the instrument must periodically obtain fresh measurements of its internal ground and voltage reference. The time interval between updates to these reference measurements is determined by the integration aperture being used for measurements. Separate reference and zero measurements are used for each aperture.","By default, the instrument automatically checks these reference measurements whenever a signal measurement is made. If the reference measurements have expired when a signal measurement is made, the instrument will automatically take two more A/D conversions, one for the reference and one for the zero, before returning the result. Thus, occasionally, a measurement takes longer than normal.","This additional time can cause problems in sweeps and other test sequences in which measurement timing is critical. To avoid the extra time for the reference measurements in these situations, the smuX.measure.autozero attribute can be used to disable the automatic reference measurements. Keep in mind that disabling automatic reference measurements may allow the instrument to gradually drift out of specification.","To minimize the drift, a reference and zero measurement should be made just prior to the critical test sequence. The smuX.AUTOZERO_ONCE setting can be used to force a refresh of the reference and zero measurements used for the current aperture setting.","Autozero reference measurements for the last 10 used NPLC settings are stored in a reference cache. If an NPLC setting is selected and an entry for it is not in the cache, the oldest (least recently used) entry will be discarded to make room for the new entry.","The fast ADC (analog-to-digital converter) does not need or use the reference measurements associated with this attribute (only the integrating ADC). When this attribute is set to smuX.AUTOZERO_AUTO, the fast ADC will not require these reference measurements. However, if the fast ADC is selected, setting this attribute to smuX.AUTOZERO_ONCE will cause the integrating ADC to acquire a new set of reference measurements.","Example","smua.measure.autozero = 1","Performs autozero once for SMU channel A. Alternatively, the value 1 may be replaced with smua.AUTOZERO_ONCE.","Also see","Autozero","reset()","smuX.measure.nplc","setup.recall()","smuX.reset()","smuX.measure.autozero","15108.html");
+Page[308]=new Array("This function generates and activates new measurement calibration constants.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.measure.calibrateY(range, cp1Measured, cp1Reference, cp2Measured, cp2Reference)","X","Source‑measure unit (SMU) channel (for example, smua.measure.calibratev() applies to SMU channel A)","Y","SMU measurement function (v = voltage, i = current)","range","The measurement range to calibrate","cp1Measured","The value measured by this SMU for calibration point 1","cp1Reference","The reference measurement for calibration point 1 as measured externally","cp2Measured ","The value measured by this SMU for calibration point 2","cp2Reference ","The reference measurement for calibration point 2 as measured externally","Details","This function generates and activates new calibration constants for the given range. The positive and negative polarities of the instrument must be calibrated separately. Use a positive value for range to calibrate the positive polarity and a negative value for range to calibrate the negative polarity.","Typically the two calibration points used will be near zero for calibration point 1 and 90% of full scale for calibration point 2.","All four measurements (cp1Measured, cp1Reference, cp2Measured, and cp2Reference) must be made with the active calibration set. Corruption of the calibration constants may result if this is not heeded.","The new calibration constants will be activated immediately but they will not be written to nonvolatile storage. Use smuX.cal.save() to commit the new constants to nonvolatile storage. The active calibration constants will stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile storage with the smuX.cal.restore() function.","This function will be disabled until a successful call to smuX.cal.unlock() is made.","Example","smua.measure.calibratev(200, 1e-4, 1e-5, 178.8, 179.8)","SMU channel A calibrates voltage measurement using following values: 200 V calibration range, 1e-4 for +zero measurement reading, 1e-5 for +zero DMM measurement reading, 178.8 for +FS measurement reading, and 179.8 for the +FS DMM measurement reading.","Also see","Adjustment","smuX.cal.lock()","smuX.cal.restore()","smuX.cal.save()","smuX.cal.unlock()","smuX.source.calibrateY()","smuX.measure.calibrateY()","15109.html");
+Page[309]=new Array("This attribute sets the number of measurements performed when a measurement is requested.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset SMU reset Recall setup","Saved setup","1","Usage","count = smuX.measure.count","smuX.measure.count = count","count","Number of measurements","X","Source‑measure unit (SMU) channel (for example, smua.measure.count applies to SMU channel A)","Details","This attribute controls the number of measurements taken any time a measurement is requested. When using a reading buffer with a measure command, this attribute also controls the number of readings to be stored.","If smuX.measure.count is set to a value greater than 1, any measurement delay set by smuX.measure.delay will only occur before the first measurement, while the smuX.measure.interval controls the interval between successive measurements.","Example","smua.measure.count = 10","Sets the SMU channel A measure count to 10.","Also see","reset()","setup.recall()","smuX.measure.delay","smuX.measure.interval","smuX.measure.overlappedY()","smuX.measure.Y()","smuX.reset()","smuX.measure.count","15110.html");
+Page[310]=new Array("This attribute controls the measurement delay.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset SMU reset Recall setup","Saved setup","smuX.DELAY_AUTO ","Usage","mDelay = smuX.measure.delay","smuX.measure.delay = mDelay","mDelay","Set to your desired measurement delay value in seconds (for example, to specify an additional 10 ms measurement delay, set the value to 0.010)","You can also set it one of the following values:","0 or smuX.DELAY_OFF: No delay","-1 or smuX.DELAY_AUTO: Automatic delay value","X","Source‑measure unit (SMU) channel (for example, smua.measure.delay applies to SMU channel A)","Details","This attribute allows for additional delay (settling time) before taking a measurement. You can set mDelay to smuX.DELAY_OFF, smuX.DELAY_AUTO, or to a user-defined value (in seconds). A user‑defined value will set the delay used, regardless of range.","The smuX.DELAY_AUTO setting also causes a current range-dependent delay to be inserted when a current measurement is requested. This happens when a current measurement command is executed, when the measure action is being performed in a sweep, or after changing ranges during an autoranged measurement.","If smuX.measure.count is greater than 1, the measurement delay is only inserted before the first measurement.","Example","smua.measure.delay = 0.010","Sets a 10 ms measurement delay for SMU channel A.","Also see","Measure auto delay","reset()","smuX.measure.count","smuX.measure.delayfactor","smuX.source.delay","smuX.reset()","smuX.measure.delay","15111.html");
+Page[311]=new Array("This attribute stores a multiplier to the delays that are used when smuX.measure.delay is set to smuX.DELAY_AUTO.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset SMU reset Recall setup","Not saved","1","Usage","delayFactor = smuX.measure.delayfactor","smuX.measure.delayfactor = delayFactor","delayFactor","The delay factor multiplier","X","Source‑measure unit (SMU) channel (for example, smua.measure.delayfactor applies to SMU channel A)","Details","The delay factor is only applied when smuX.measure.delay = smuX.DELAY_AUTO.","This attribute can be set to a value less than 1 (for example, 0.5) to decrease the automatic delay.","This attribute can be set to a value greater than 1 (for example, 1.5 or 2.0) to increase the automatic delay.","Setting this attribute to zero disables delays when smuX.measure.delay = smuX.DELAY_AUTO.","Example","smua.measure.delayfactor = 2.0","Doubles the measure delay for SMU channel A.","Also see","Measure auto delay","reset()","smuX.measure.delay","smuX.reset()","smuX.measure.delayfactor","15112.html");
+Page[312]=new Array("This attribute sets the number of measured readings that are required to yield one filtered measurement.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset SMU reset Recall setup","Saved setup","1","Usage","filterCount = smuX.measure.filter.count","smuX.measure.filter.count = filterCount","filterCount","The number of readings required for each filtered measurement (1 to 100)","X","Source‑measure unit (SMU) channel (for example, smua.measure.filter.count applies to SMU channel A)","Details","This attribute sets the size of the stack used for filtered measurements.","Example","smua.measure.filter.count = 10","Sets the filter count for SMU channel A to 10.","Also see","reset()","setup.recall()","smuX.measure.filter.enable","smuX.measure.filter.type","smuX.reset()","Filters","smuX.measure.filter.count","15113.html");
+Page[313]=new Array("This attribute enables or disables filtered measurements.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset SMU reset Recall setup","Saved setup","0 (smuX.FILTER_OFF)","Usage","filterState = smuX.measure.filter.enable","smuX.measure.filter.enable = filterState","filterState","The filter status. Set to one of the following values:","0 or smuX.FILTER_OFF: Disables the filter","1 or smuX.FILTER_ON: Enables the filter","X","SMU channel (for example, smua.measure.filter.enable applies to SMU channel A)","Details","This attribute enables or disables the filter.","Example","smua.measure.filter.enable = 1","Enables the filter for SMU channel A. Alternatively, the value 1 may be replaced with smua.FILTER_ON.","Also see","reset()","setup.recall()","smuX.measure.filter.count","smuX.measure.filter.type","smuX.reset()","Filters","smuX.measure.filter.enable","15114.html");
+Page[314]=new Array("This attribute sets the type of filter used for measurements when smuX.measure.filter.enable is enabled.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset SMU reset Recall setup","Saved setup","1 (smuX.FILTER_REPEAT_AVG)","Usage","filterType = smuX.measure.filter.type","smuX.measure.filter.type = filterType","filterType","The filter type to use when filtering is enabled. Set to one of the following values:","0 or smuX.FILTER_MOVING_AVG: Selects the moving average filter","1 or smuX.FILTER_REPEAT_AVG: Selects the repeat filter","2 or smuX.FILTER_MEDIAN: Selects the median filter","X","SMU channel (for example, smua.measure.filter.type applies to SMU Channel A)","Details","There are two averaging filter types and one median filter type available. For averaging filters, both repeating and moving filter types are available. ","For the repeating filter (which is the power-on default), the stack (filter count) is filled, and the conversions are averaged to yield a reading. The stack is then cleared, and the process starts over. ","The moving average filter uses a first-in, first-out stack. When the stack (filter count) becomes full, the measurement conversions are averaged, yielding a reading. For each subsequent conversion placed into the stack, the oldest conversion is discarded. The stack is re-averaged, yielding a new reading.","The median filter uses a first-in, first-out stack. When the stack (filter count) becomes full, the “middle-most” reading is returned. For each subsequent conversion placed into the stack, the oldest reading is discarded. The stack is then re-sorted, yielding a new reading. If the filter count is an even number, the reading returned is the average of the two middle readings.","Example","smua.measure.filter.type = 2","Selects the median filter for SMU channel A. Alternatively, the value 2 may be replaced with smua.FILTER_MEDIAN.","Also see","reset()","setup.recall()","smuX.measure.filter.count","smuX.measure.filter.enable","smuX.reset()","Filters","smuX.measure.filter.type","15115.html");
+Page[315]=new Array("This attribute sets the interval between multiple measurements.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset SMU reset Recall setup","Saved setup","0 (0 s)","Usage","interval = smuX.measure.interval","smuX.measure.interval = interval","interval","The interval value (in seconds). Set to a value between 0 and 1","X","Source‑measure unit (SMU) channel (for example, smua.measure.interval applies to SMU channel A)","Details","This attribute sets the time interval between measurements when smuX.measure.count is set to a value greater than 1. The SMU will attempt to start each measurement when scheduled. If the SMU cannot keep up with the interval setting, measurements will be made as fast as possible.","If filtered measurements are being made, this interval is from the start of the first measurement for the filtered reading to the first measurement for a subsequent filtered reading. Extra measurements made to satisfy a filtered reading are not paced by this interval.","Example","smua.measure.interval = 0.5","Sets the measure interval for SMU channel A to 0.5.","Also see","reset()","setup.recall()","smuX.measure.count","smuX.reset()","smuX.measure.interval","15117.html");
+Page[316]=new Array("This attribute sets the lowest measure range that will be used during autoranging.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset SMU reset Recall setup","Saved setup","Current: 1e‑9 (1 nA)","Voltage: 200 (200 V)","Usage","lowRange = smuX.measure.lowrangeY","smuX.measure.lowrangeY = lowRange","lowRange","The lowest voltage or current measure range used during autoranging","X","Source‑measure unit (SMU) channel (for example, smua.measure.lowrangev applies to SMU channel A)","Y","SMU measure function (v = voltage, i = current)","Details","This attribute is used with autoranging to put a lower bound on the range used. Since lower ranges generally require greater settling times, setting a lowest range limit might make measurements require less settling time.","If the instrument is set to autorange and it is on a range lower than the one specified, the range will be changed to the lowRange range value.","Example","smua.measure.lowrangei = 100e-9","Sets current low range for SMU channel A to 100 nA.","Also see","reset()","setup.recall()","smuX.measure.autorangeY","smuX.reset()","Range","smuX.measure.lowrangeY","15118.html");
+Page[317]=new Array("This attribute sets the integration aperture for measurements.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset SMU reset Recall setup","Saved setup","1.0","Usage","nplc = smuX.measure.nplc","smuX.measure.nplc = nplc","nplc","The integration aperture; set from 0.001 to 25","X","Source‑measure unit (SMU) channel (for example, smua.measure.nplc applies to SMU channel A)","Details","When making measurements, the SMU uses one of two types of analog‑to‑digital converters (ADC). This attribute controls the integration aperture for the integrating ADC. This attribute is not used when the fast ADC is selected.","The integration aperture is based on the number of power line cycles (NPLC), where 1 PLC for 60 Hz is 16.67 ms (1/60) and 1 PLC for 50 Hz is 20 ms (1/50).","Example","smua.measure.nplc = 0.5","Sets the integration time for SMU channel A to 0.5/60 seconds.","Also see","reset()","setup.recall()","smuX.measure.adc","smuX.reset()","Speed","smuX.measure.nplc","15119.html");
+Page[318]=new Array("This function starts an asynchronous (background) measurement.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","smuX.measure.overlappedY(rbuffer)","smuX.measure.overlappediv(ibuffer, vbuffer)","X","Source‑measure unit (SMU) channel (for example, smua.measure.overlappedv() applies to SMU channel A)","Y","SMU measurement type (v = voltage, i = current, r = resistance, p = power)","rbuffer","A reading buffer object where the readings will be stored","ibuffer","A reading buffer object where current readings will be stored","vbuffer","A reading buffer object where voltage readings will be stored","Details","This function will start a measurement and return immediately. The measurements, as they are performed, are stored in a reading buffer (along with any ancillary information also being acquired). If the instrument is configured to return multiple readings where one is requested, the readings will be available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.","The smuX.measure.overlappediv() function stores current readings in ibuffer and voltage readings in vbuffer.","This function is an overlapped command. Script execution will continue while the measurements are made in the background. Attempts to access result values that have not yet been generated will cause the script to block and wait for the data to become available. The waitcomplete() function can also be used to wait for the measurements to complete before continuing.","If a given reading buffer contains any data, it will be cleared prior to taking any measurements, unless the reading buffer has been configured to append data.","Example","smua.measure.overlappedv(smua.nvbuffer1)","Starts background voltage measurements for SMU channel A.","Also see","smuX.measure.Y()","smuX.nvbufferY","waitcomplete()","Reading buffers","smuX.measure.overlappedY()","15120.html");
+Page[319]=new Array("This attribute contains the positive full‑scale value of the measurement range for voltage or current.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset SMU reset Recall setup","Saved setup","Current: 120e-3 (120 mA)","Voltage: 200 (200 V)","Usage","rangeValue = smuX.measure.rangeY","smuX.measure.rangeY = rangeValue","rangeValue","Set to the maximum expected voltage or current to be measured","X","Source‑measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)","Y","SMU measurement function (v = voltage, i = current)","Details","Reading this attribute returns the positive full-scale value of the measurement range that the SMU is currently using. Assigning a value to this attribute sets the SMU on a fixed range large enough to measure the assigned value. The instrument will select the best range for measuring a value of rangeValue.","This attribute is primarily intended to eliminate the time that is required by the automatic range selection performed by a measuring instrument. Because selecting a fixed range prevents autoranging, an overrange condition can occur. ","If the source function is the same as the measurement function (for example, sourcing voltage and measuring voltage), the measurement range is locked to be the same as the source range. However, the setting for the measure range is retained. If the source function is changed (for example, from sourcing voltage to sourcing current), the retained measurement range will be used.","Explicitly setting a measure range will disable measure autoranging for that function. Autoranging is controlled separately for each source and measurement function: source voltage, source current, measure voltage and measure current. Autoranging is enabled for all four by default.","Changing the range while the output is off will not update the hardware settings, but querying will return the range setting that will be used once the output is turned on. Setting a range while the output is on will take effect immediately.","With measure autoranging enabled, the range will be changed only when a measurement is taken. Querying the range after a measurement will return the range selected for that measurement.","Example","smua.measure.rangev = 200 ","Selects the 200 V measurement range for SMU channel A.","Also see","reset()","setup.recall()","smuX.measure.autorangeY","smuX.reset()","smuX.source.rangeY","Range","smuX.measure.rangeY","15121.html");
+Page[320]=new Array("This attribute turns relative measurements on or off. ","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset SMU reset Recall setup","Not saved","0 (smuX.REL_OFF)","Usage","relEnable = smuX.measure.rel.enableY","smuX.measure.rel.enableY = relEnable","relEnable","Relative measurement control. Set relEnable to one of the following values:","0 or smuX.REL_OFF: Disables relative measurements","1 or smuX.REL_ON: Enables relative measurements","X","Source‑measure unit (SMU) channel (for example, smua.measure.rel.enablev applies to SMU channel A)","Y","SMU measurement function (v = voltage, i = current, r = resistance, p = power)","Details","This attribute enables or disables relative measurements. When relative measurements are enabled, all subsequent measured readings will be offset by the relative offset value specified by smuX.measure.rel.levelY. Specifically, each returned measured relative reading will be the result of the following calculation:","Relative reading = Actual measured reading - Relative offset value","Example","smua.measure.rel.enablev = smua.REL_ON","Enables relative voltage measurements for SMU channel A.","Also see","reset()","setup.recall()","smuX.measure.rel.levelY","smuX.reset()","Relative offset","smuX.measure.rel.enableY","15123.html");
+Page[321]=new Array("This attribute sets the offset value for relative measurements.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset SMU reset Recall setup","Not saved","0","Usage","relValue = smuX.measure.rel.levelY","smuX.measure.rel.levelY = relValue","relValue","Relative measurement offset value","X","Source‑measure unit (SMU) channel (for example, smua.measure.rel.levelv applies to SMU channel A)","Y","SMU measurement function (v = voltage, i = current, r = resistance, p = power)","Details","This attribute specifies the offset value used for relative measurements. When relative measurements are enabled (see smuX.measure.rel.enableY), all subsequent measured readings will be offset by the value of this attribute. Specifically, each returned measured relative reading will be the result of the following calculation: ","Relative reading = Actual measured reading - Relative offset value","Example","smua.measure.rel.levelv = smua.measure.v()","Performs a voltage measurement using SMU channel A and then uses it as the relative offset value.","Also see","reset()","smuX.measure.rel.enableY","smuX.reset()","Relative offset","smuX.measure.rel.levelY","15124.html");
+Page[322]=new Array("This function performs one or more measurements.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","reading = smuX.measure.Y()","reading = smuX.measure.Y(readingBuffer)","iReading, vReading = smuX.measure.iv()","iReading, vReading = smuX.measure.iv(iReadingBuffer)","iReading, vReading = smuX.measure.iv(iReadingBuffer, vReadingBuffer)","reading","Returned value of the last (or only) reading of the measurement process","X","Source-measure unit (SMU) channel (for example, smua.measure.v() applies to SMU channel A)","Y","SMU measurement function (v = voltage, i = current, r = resistance, p = power)","readingBuffer","A reading buffer object where all readings will be stored","iReading","The last reading of the current measurement process","vReading","The last reading of the voltage measurement process","iReadingBuffer","A reading buffer object where current readings will be stored","vReadingBuffer","A reading buffer object where voltage readings will be stored","Details","This function (without specifying a reading buffer) will only make one measurement and return that measurement as reading. To use the additional information acquired while making a measurement or to return multiple readings, specify a reading buffer. If the instrument is configured to return multiple readings for a measurement and readingBuffer is specified, all readings will be available in readingBuffer, but only the last measurement will be returned as reading.","Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.","The smuX.measure.iv() function returns the last actual current measurement and voltage measurement as iReading and vReading, respectively. Additionally, it can store current and voltage readings if buffers are provided (iReadingBuffer and vReadingBuffer ).","The smuX.measure.count attribute determines how many measurements are performed. When using a reading buffer, it also determines the number of readings to store in the buffer. If a reading buffer is not specified, the SMU will ignore the smuX.measure.count attribute and only make one measurement.","The readingBuffer will be cleared before taking any measurements unless the buffer is configured to append data.","Example","smua.measure.count = 10","smua.measure.v(smua.nvbuffer1)","Performs ten voltage measurements using SMU channel A and stores them in a buffer.","Also see","smuX.measure.count","smuX.measure.overlappedY()","smuX.nvbufferY","Reading buffers","smuX.measure.Y()","15122.html");
+Page[323]=new Array("This function performs one or two measurements and then steps the source.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","reading = smuX.measureYandstep(sourceValue)","iReading, vReading = smuX.measureivandstep(sourceValue)","reading","The measured reading before stepping the source","X","Source‑measure unit (SMU) channel (for example, smua.measurevandstep() applies to SMU channel A)","Y","SMU measurement function (v = voltage, i = current, r = resistance, p = power)","sourceValue","Source value to be set after the measurement is made","iReading","The current reading before stepping the source","vReading","The voltage reading before stepping the source","Details","The smuX.measureYandstep() function performs a measurement and then sets the source to sourceValue. Usage of the smuX.measureivandstep() function is similar, but performs two measurements simultaneously; one for current (i) and one for voltage (v).","Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.","The specified source value should be appropriate for the selected source function. For example, if the source voltage function is selected, then sourceValue is expected to be a new voltage level.","Both source and measure autorange must be disabled before using this function. ","This function is provided for very fast execution of source-measure loops. The measurement will be made prior to stepping the source. Prior to using this function, and before any loop this function may be used in, set the source value to its initial level.","Example","local ivalues = {}","smua.source.rangev = 1500","smua.source.levelv = 0","smua.measure.rangei = 0.01","smua.source.output = smua.OUTPUT_ON","for index = 1, 10 do"," ivalues[index] = smua.measureiandstep(index * 50)","end","ivalues[11] = smua.measure.i()","This use of the SMU channel A measure and step function measures current starting at a source value of 0 V. After each current measurement, the source is stepped 50 V for the next current measurement. The final source level is 500 V, where current is again measured. ","Also see","smuX.measure.Y()","smuX.trigger.source.limitY","smuX.trigger.source.linearY()","smuX.trigger.source.listY()","smuX.trigger.source.logY()","Sweep Operation","smuX.measureYandstep()","15125.html");
+Page[324]=new Array("This attribute contains the dedicated reading buffer.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","See Details","Not applicable","Usage","bufferVar = smuX.nvbufferY","bufferVar","The dedicated reading buffer","X","Source‑measure unit (SMU) channel (for example, smua.nvbuffer1 applies to SMU channel A)","Y","SMU nonvolatile buffer (1 or 2)","Details","Each SMU channel contains two dedicated reading buffers: smuX.nvbuffer1 and smuX.nvbuffer2.","All routines that return measurements can also store them in either reading buffer. Overlapped measurements are always stored in a reading buffer. Synchronous measurements return either a single-point measurement or can be stored in a reading buffer if passed to the measurement command.","The dedicated reading buffers can be saved to internal nonvolatile memory (to retain data between power cycles) using the smuX.savebuffer() function.","Example","smua.measure.overlappedv(smua.nvbuffer1)","Store voltage readings from SMU channel A into SMU channel A dedicated reading buffer 1.","Also see","savebuffer()","smuX.makebuffer()","smuX.measure.overlappedY()","smuX.savebuffer()","smuX.trigger.measure.action","smuX.trigger.measure.set()","smuX.trigger.measure.stimulus","smuX.trigger.measure.Y()","Configuring and running sweeps","Reading buffers","smuX.nvbufferY","15126.html");
+Page[325]=new Array("This function turns off the output and resets the SMU to the default settings.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.reset()","X","Source‑measure unit (SMU) channel (for example, smua.reset() applies to SMU channel A)","Details","This function turns off the output and returns the specified SMU to its default settings.","Example","smua.reset()","Turns off the output and resets SMU channel A to its default settings.","Also see","reset()","smuX.reset()","15136.html");
+Page[326]=new Array("This function saves one source‑measure unit (SMU) dedicated reading buffer to internal memory (there are two dedicated reading buffers per SMU).","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.savebuffer(smuX.nvbufferY)","X","SMU channel (for example, smua.savebuffer(smua.nvbuffer1) applies to SMU channel A)","Y","SMU dedicated reading buffer (1 or 2)","Details","When the unit is turned off and back on, the dedicated reading buffers will be restored (from internal memory) to their last saved values.","Example","smua.savebuffer(smua.nvbuffer1)","Saves buffer 1 (SMU channel A) to internal memory.","Also see","savebuffer()","smuX.nvbufferY","Reading buffers","smuX.savebuffer()","15137.html");
+Page[327]=new Array("This attribute contains the state of the remote/local sense mode.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Saved setup","0 (smuX.SENSE_LOCAL)","Usage","senseMode = smuX.sense","smuX.sense = senseMode","senseMode","The sense mode; set to one of the following:","0 or smuX.SENSE_LOCAL: Selects local sense (2-wire)","1 or smuX.SENSE_REMOTE: Selects remote sense (4-wire)","3 or smuX.SENSE_CALA: Selects calibration sense mode","X","Source‑measure unit (SMU) channel (for example, smua.sense applies to SMU channel A)","Details","Source-measure operations are performed using either 2-wire local sense connections or 4-wire remote sense connections. Writing to this attribute selects the sense mode.","The smuX.SENSE_CALA mode is only used for calibration and may only be selected when calibration is enabled.","The sense mode can be changed between local and remote while the output is on.","The calibration sense mode cannot be selected while the output is on.","Resetting the instrument selects the local sense mode.","Example","smua.sense = smua.SENSE_REMOTE","Selects remote sensing for SMU channel A.","Also see","2-wire local sensing connections","4-wire remote sensing connections","Sense mode selection","smuX.sense","15138.html");
+Page[328]=new Array("This attribute contains the state of the source autorange control (on/off). ","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Saved setup","1 (smuX.AUTORANGE_ON)","Usage","sourceAutorange = smuX.source.autorangeY","smuX.source.autorangeY = sourceAutorange","sourceAutorange","The state of the source autorange control. Set to one of the following:","0 or smuX.AUTORANGE_OFF: Disables source autorange","1 or smuX.AUTORANGE_ON: Enables source autorange","X","Source‑measure unit (SMU) channel (for example, smua.source.autorangev applies to SMU channel A)","Y","SMU source function (v = voltage, i = current)","Details","This attribute indicates the source autorange state. Its value will be smuX.AUTORANGE_OFF when the SMU source circuit is on a fixed range and smuX.AUTORANGE_ON when it is in autorange mode.","Setting this attribute to smuX.AUTORANGE_OFF puts the SMU on a fixed source range. The fixed range used will be the present SMU source circuit range.","Setting this attribute to smuX.AUTORANGE_ON puts the SMU source circuit into autorange mode. If the source output is on, the SMU will immediately change range to the range most appropriate for the value being sourced if that range is different from the present SMU range.","Autorange will disable if the source level is edited from the front panel. Setting the source range turns off autorange when set by using the smuX.source.rangeY attribute as well.","Resetting the instrument selects the smuX.AUTORANGE_ON.","Example","smua.source.autorangev = smua.AUTORANGE_ON","Enables volts source autorange for SMU channel A.","Also see","smuX.measure.autorangeY","smuX.source.rangeY","smuX.source.autorangeY","15139.html");
+Page[329]=new Array("This function generates and activates new source calibration constants.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.source.calibrateY(range, cp1Expected, cp1Reference, cp2Expected, cp2Reference)","X","Source‑measure unit (SMU) channel (for example, smua.source.calibratev() applies to SMU channel A)","Y","SMU source function (v = voltage, i = current)","range","The measurement range to calibrate","cp1Expected","The source value programmed for calibration point 1","cp1Reference","The reference measurement for calibration point 1 as measured externally","cp2Expected","The source value programmed for calibration point 2","cp2Reference","The reference measurement for calibration point 2 as measured externally","Details","This function generates and activates new calibration constants for the given range. ","The positive and negative polarities of the source must be calibrated separately. Use a positive value for range to calibrate the positive polarity and a negative value for range to calibrate the negative polarity. Do not use 0.0 for a negative calibration point as 0.0 is considered a positive number.","Typically, the two calibration points used will be near zero for calibration point 1 and 90% of full scale for calibration point 2. Full scale for calibration point 2 should be avoided if the SMU's source is substantially out of calibration.","The two reference measurements must be made with the source using the active calibration set. For example, source a value, measure it, and do not change the active calibration set before issuing this command.","The new calibration constants will be activated immediately but they will not be written to nonvolatile storage. Use smuX.cal.save() to commit the new constants to nonvolatile storage.","The active calibration constants will stay in effect until the instrument is power cycled or a calibration set is loaded from nonvolatile storage with the smuX.cal.restore() function.","This function will be disabled until a successful call to smuX.cal.unlock() is made.","Example","smua.source.calibratev(200, 1e-30, 1e-5, 180, 179.8)","SMU channel A calibrates voltage source using the following values: calibrate the 200 V range, 1e-30 for +zero source output value, 1e-5 for +zero DMM measurement reading, 180 for +FS source output value, and 179.8 for the +FS DMM measurement reading.","Also see","smuX.cal.restore()","smuX.cal.save()","smuX.cal.unlock()","smuX.measure.calibrateY()","Calibration","smuX.source.calibrateY()","15143.html");
+Page[330]=new Array("This attribute contains the state of source compliance. ","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not saved","Not applicable","Usage","compliance = smuX.source.compliance","compliance","The state of source compliance","X","Source‑measure unit (SMU) channel (for example, smua.source.compliance applies to SMU channel A)","Details","This read-only attribute contains the source compliance state (true or false). ","true indicates that the limit function is in control of the source (source in compliance).","false indicates that the source function is in control of the output (source not in compliance).","Writing to this attribute will generate an error.","Reading this attribute also updates the status model and the front panel with generated compliance information. See Current Limit (ILMT) shown in the status model diagram for the Measurement event registers. The Voltage Limit (VLMT) is not shown in the status model diagram for the Measurement event registers, but is similar to the Current Limit (ILMT).","Example","compliance = smua.source.compliance","print(compliance) ","Reads the source compliance state for SMU channel A.","Output: true","This output indicates that a configured limit has been reached (voltage, current, or power limit).","Also see","smuX.source.limitY","smuX.source.compliance","15141.html");
+Page[331]=new Array("This attribute contains the source delay.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Not saved","0 (smuX.DELAY_OFF)","Usage","sDelay = smuX.source.delay","smuX.source.delay = sDelay","sDelay","Set to your desired source delay value (for example, to specify an additional 10 ms source delay, set the value to 0.010)","Alternatively, you can set it one of the following values:","0 or smuX.DELAY_OFF: No delay","-1 or smuX.DELAY_AUTO: Automatic delay value","X","Source‑measure unit (SMU) channel (for example, smua.source.delay applies to SMU channel A)","Details","This attribute allows for additional delay (settling time) after an output step. Set sDelay to a user-defined value (in seconds). Alternatively, set sDelay to smuX.DELAY_OFF or smuX.DELAY_AUTO.","The smuX.DELAY_AUTO setting causes a range-dependent delay to be inserted when the source is changed. Range-dependent delays are based on the output settling time values of the Model 2657A specifications. ","Example","smua.source.delay = smua.DELAY_AUTO","Sets the delay for SMU channel A to automatic (a range-dependent delay is inserted when ever the source is changed).","Also see","reset()","smuX.measure.count","smuX.measure.delay","smuX.reset()","smuX.source.delay","15142.html");
+Page[332]=new Array("This attribute sets the source function (V source or I source).","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Saved setup","1 (smuX.OUTPUT_DCVOLTS)","Usage","sFunction = smuX.source.func","smuX.source.func = sFunction","sFunction","The source function. Set to one of the following values:","0 or smuX.OUTPUT_DCAMPS: Selects current source function","1 or smuX.OUTPUT_DCVOLTS: Selects voltage source function","X","Source‑measure unit (SMU) channel (for example, smua.source.func applies to SMU channel A)","Details","Reading this attribute indicates the output function of the source for the specified SMU channel. Setting this attribute configures the specified SMU channel as either a voltage source or a current source.","Example","smua.source.func = smua.OUTPUT_DCAMPS","Sets the source function of SMU channel A to be a current source.","Also see","smuX.source.levelY","smuX.source.output","smuX.source.func","15144.html");
+Page[333]=new Array("This attribute sets the source level.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Saved setup","0","Usage","sourceLevel = smuX.source.levelY","smuX.source.levelY = sourceLevel","sourceLevel","The source value; set to one of the following values: Voltage: 0 V to ±3000 V","Current: 0 A to ±120 mA","X","Source‑measure unit (SMU) channel (for example, smua.source.levelv applies to SMU channel A)","Y","SMU source function (v = voltage, i = current)","Details","This attribute configures the output level of the voltage or current source.","If the source is configured as a voltage source and the output is on, the new smuX.source.levelv setting will be sourced immediately. If the output is off or the source is configured as a current source, the voltage level will be sourced when the source is configured as a voltage source and the output is turned on.","If the source is configured as a current source and the output is on, the new smuX.source.leveli setting will be sourced immediately. If the output is off or the source is configured as a voltage source, the current level will be sourced when the source is configured as a current source and the output is turned on.","The sign of sourceLevel dictates the polarity of the source. Positive values generate positive voltage or current from the high terminal of the source relative to the low terminal. Negative values generate negative voltage or current from the high terminal of the source relative to the low terminal.","The reset() function sets the source levels to 0 V and 0 A.","Example","smua.source.levelv = 1","Sets voltage source of SMU channel A to 1 V.","Also see","smuX.source.compliance","smuX.source.func","smuX.source.output","Source-measure concepts","smuX.source.levelY","15146.html");
+Page[334]=new Array("This attribute sets compliance limits.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Saved setup","Limit voltage: 20 (20 V)","Limit current: 1e‑3 (1 mA)","Limit power: 0 (disabled)","Usage","limit = smuX.source.limitY","smuX.source.limitY = limit","limit","The compliance limit value; set to one of the following values: Voltage compliance: 0 V to 3030 V","Current compliance: 0 A to 121.2 mA","Set power compliance in watts: 0 W (minumum). Specifying a 0 disables power limit","X","Source‑measure unit (SMU) channel (for example, smua.source.limitv applies to SMU channel A)","Y","SMU function (v = voltage, i = current, p = power)","Details","Use the smuX.source.limiti attribute to limit the current output of the voltage source. Use smuX.source.limitv to limit the voltage output of the current source. The SMU will always choose (autorange) the source range for the limit setting. Use the smuX.source.limitp attribute to limit the output power of the source.","This attribute should be set in the test sequence before the turning the source on.","Using a limit value of 0 will result in an error code 1102, "Parameter too small," for v and i. Setting this attribute to zero disables power compliance for p. When setting the power compliance limit to a nonzero value, the SMU will adjust the source limit where appropriate to limit the output to the specified power. The SMU will use the lower of the programmed compliance value (the compliance level that would be used if power compliance were disabled) or the limit calculated from the power compliance setting.","Reading this attribute indicates the presently set compliance value. Use smuX.source.compliance to read the state of source compliance.","Example","smua.source.limitv = 30","Sets voltage source compliance of SMU channel A to 30 V.","Also see","DUT test connections","smuX.source.compliance","smuX.source.func","smuX.source.output","smuX.source.limitY","17115.html");
+Page[335]=new Array("This attribute sets the lowest source range that will be used during autoranging.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Saved setup","Current: 1e-9 (1 nA)","Voltage: 200 (200 V)","Usage","sourceRangeLow = smuX.source.lowrangeY","smuX.source.lowrangeY = sourceRangeLow","sourceRangeLow","Set to the lowest voltage (in volts) or current (in amperes) range to be used","X","Source‑measure unit (SMU) channel (for example, smua.source.lowrangev applies to SMU channel A)","Y","SMU source function (v = voltage, i = current)","Details","This attribute is used with source autoranging to put a lower bound on the range used. Lower ranges generally require greater settling times. By setting a low-range value, sourcing small values might be able to be made with less settling time.","If the instrument is set to autorange and it is on a range lower than the one specified by sourceRangeLow, the source range will be changed to the range specified by sourceRangeLow.","Example","smua.source.lowrangei = 1e-6","The lower boundary for current source autoranging is 1 mA. ","Also see","smuX.source.autorangeY","smuX.source.lowrangeY","15148.html");
+Page[336]=new Array("This attribute sets the source function used (source 0 A or 0 V) when the output is turned off and the source‑measure unit (SMU) is in normal output-off mode.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Saved setup","1 (smuX.OUTPUT_DCVOLTS)","Usage","offfunc = smuX.source.offfunc","smuX.source.offfunc = offfunc","offfunc","Set to the source function to be used when the output is off and the SMU is in normal output-off mode. Set to one of the following values:","0 or smuX.OUTPUT_DCAMPS: Source 0 A","1 or smuX.OUTPUT_DCVOLTS: Source 0 V","X","SMU channel (for example, smua.source.offfunc applies to SMU channel A)","Details","This attribute controls the source function used when the output is turned off and the smuX.source.offmode is set to smuX.OUTPUT_NORMAL. Set this attribute to smuX.OUTPUT_DCVOLTS for the source to be a 0 V source when the output is off (smuX.source.offlimiti is used). Set it to smuX.OUTPUT_DCAMPS for the source to be a 0 A source when the output is off (smuX.source.offlimitv is used). ","This attribute is only used when the smuX.source.offmode attribute is set to smuX.OUTPUT_NORMAL.","Example","smua.source.offfunc = smua.OUTPUT_DCVOLTS","Sets the normal output-off mode to source 0 V when the output is turned off for SMU channel A.","Also see","Output-off states","smuX.source.offlimitY","smuX.source.offmode","smuX.source.output","smuX.source.offfunc","19504.html");
+Page[337]=new Array("This attribute sets the limit (current or voltage) used when the source‑measure unit (SMU) is in normal output-off mode.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Saved setup","Current: 1e-3 (1 mA) Voltage: 40 (40 V)","Usage","sourceLimit = smuX.source.offlimitY","smuX.source.offlimitY = sourceLimit","sourceLimit","Set to the limit to be used when the SMU is in normal output-off mode","X","SMU channel (for example, smua.source.offlimiti applies to SMU channel A)","Y","SMU source function (v = voltage, i = current)","Details","Setting the current limit to lower than 1 mA may interfere with operation of the contact check function. See smuX.contact.check() and smuX.contact.r() for details.","Example","smua.source.offlimiti = 10e-3","Changes the normal output-off mode limit to 10 mA for SMU channel A.","Also see","smuX.source.offfunc","smuX.source.offmode","smuX.source.offlimitY","15149.html");
+Page[338]=new Array("This attribute sets the source output-off mode.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Saved setup","0 (smuX.OUTPUT_NORMAL)","Usage","sourceOffMode = smuX.source.offmode","smuX.source.offmode = sourceOffMode","sourceOffMode","The output-off setting; set to one of the following values:","0 or smuX.OUTPUT_NORMAL: Configures the source function according to smuX.source.offfunc attribute","1 or smuX.OUTPUT_ZERO: Configures source to output 0 V as smuX.OUTPUT_NORMAL with different compliance handling (see the Details below)","2 or smuX.OUTPUT_HIGH_Z: Opens the output relay when the output is turned off","X","Source‑measure unit (SMU) channel (for example, smua.source.offmode applies to SMU channel A)","Details","Reading this attribute gives the output-off mode of the source. Setting this attribute configures the SMU output-off mode.","The default sourceOffMode is smuX.OUTPUT_NORMAL. In this mode, the source function will be configured according to the smuX.source.offfunc attribute. The smuX.source.offfunc attribute controls whether the SMU is configured as a 0 V voltage source or a 0 A current source. When the SMU is operating as a 0 A current source, the smuX.source.offlimitv attribute sets the voltage limit, just as the smuX.source.offlimiti attribute sets the current limit when the SMU is operating as a 0 V voltage source.","When the sourceOffMode is set to smuX.OUTPUT_ZERO, the source will be configured to output 0 V just as smuX.OUTPUT_NORMAL mode with smuX.source.offfunc = smuX.OUTPUT_DCVOLTS. If the source function is voltage, the current limit will not be changed. If the source function is current, the current limit will be set to the current source level or 10 percent of the current source range, whichever is greater.","When offmode is set to smuX.OUTPUT_HIGH_Z, the SMU will open the output relay when the output is turned off.","Example","smua.source.offmode = smua.OUTPUT_HIGH_Z","Sets the output‑off mode for SMU channel A to open the output relay when the output is turned off.","Also see","Output-off states","smuX.source.offfunc","smuX.source.offlimitY","smuX.source.output","smuX.source.offmode","15150.html");
+Page[339]=new Array("This attribute sets source output state (on or off).","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Not saved","0 (smuX.OUTPUT_OFF)","Usage","sourceOutput = smuX.source.output","smuX.source.output = sourceOutput","sourceOutput","The source's output state setting; set to one of the following values:","0 or smuX.OUTPUT_OFF: Turns off the source output","1 or smuX.OUTPUT_ON: Turns on the source output","2 or smuX.OUTPUT_HIGH_Z: Turns off the output in high Z mode (allows you to go to high Z mode without first setting the smuX.source.offmode attribute to smuX.OUTPUT_HIGH_Z)","X","Source‑measure unit (SMU) channel (for example, smua.source.output applies to SMU channel A)","Details","Reading this attribute gives the output state of the source. Setting this attribute will turn the output of the source on or off. The default for the source is off. When the output is turned on, the SMU will source either voltage or current as dictated by the smuX.source.func setting.","Setting this attribute equal to smuX.OUTPUT_HIGH_Z will cause the output to turn off and go to the High Z mode. If the smuX.source.output is then read it will return 0.","Example","smua.source.output = smua.OUTPUT_ON","Turns on SMU channel A source output.","Also see","DUT test connections","smuX.source.func","smuX.source.offmode","smuX.source.output","15151.html");
+Page[340]=new Array("This attribute controls the overvoltage protection limit.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Saved setup","0 (disabled)","Usage","limit = smuX.source.protectv","smuX.source.protectv = limit","limit","The overvoltage protection limit.","X","SMU channel (for example, smua.source.protectv applies to SMU channel A).","Details","Reading this attribute returns the overvoltage protection limit the SMU is currently using.","Setting this attribute to zero disables overvoltage protection (OVP). When this attribute is set to a nonzero value, the SMU will limit the voltage on the force leads to the value specified by this attribute.","The valid OVP range is between 300 V and 3000 V. Setting the OVP limit to a value outside of this range will generate standard error code -224, "Illegal parameter value." To disable OVP, either set smua.source.protectv = 0, or disable OVP from the front panel (see Front panel overvoltage protection).","Example","smua.source.protectv = 300","Limits voltage on SMU channel A to 300 V.","Also see","smuX.source.limitY","Overvoltage protection (OVP)","smuX.source.protectv","18604.html");
+Page[341]=new Array("This attribute contains the source range.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Saved setup","Current: 1e-9 (1 nA) Voltage: 200 (200 V)","Usage","rangeValue = smuX.source.rangeY","smuX.source.rangeY = rangeValue","rangeValue","Set to the maximum expected voltage or current to be sourced","X","Source‑measure unit (SMU) channel (for example, smua.measure.rangev applies to SMU channel A)","Y","SMU source function (v = voltage, i = current)","Details","This attribute contains a value that sets the source‑measure unit (SMU) to a fixed range large enough to source the value. When read, the attribute contains the range the instrument is presently on when in autorange.","Assigning a value to this attribute sets the SMU to a fixed range large enough to source the assigned value. The instrument will select the best range for sourcing a value of rangeValue.","Reading this attribute returns the positive full-scale value of the source range the SMU is currently using. With source autoranging enabled, the output level controls the range. Querying the range after the level is set will return the range the unit chose as appropriate for that source level.","This attribute is primarily intended to eliminate the time required by the automatic range selection performed by a sourcing instrument. Because selecting a fixed range will prevent autoranging, an overrange condition can occur. ","Example","smua.source.rangev = 200 ","Selects the 200 V source range for SMU channel A.","Also see","Range","reset()","setup.recall()","smuX.measure.rangeY","smuX.reset()","smuX.source.autorangeY","smuX.source.rangeY","15153.html");
+Page[342]=new Array("This attribute contains the source settling mode.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Not saved","0 (smuX.SETTLE_SMOOTH)","Usage","settleOption = smuX.source.settling","smuX.source.settling = settleOption","settleOption","Set to the source settling mode. Set to one of the following values:","0 or smuX.SETTLE_SMOOTH: Turns off additional settling operations (default)","1 or smuX.SETTLE_FAST_RANGE: Instructs the source‑measure unit (SMU) to use a faster procedure when changing ranges","2 or smuX.SETTLE_FAST_POLARITY: Instructs the SMU to change polarity without going to zero","3 or smuX.SETTLE_DIRECT_IRANGE: Instructs the SMU to change the current range directly","128 or smuX.SETTLE_FAST_ALL: Enables all smuX.SETTLE_FAST_* operations","X","SMU channel (for example, smua.source.settling applies to SMU channel A)","Details","Using smuX.SETTLE_FAST_RANGE may cause the SMU to exceed the range change overshoot specification.","smuX.SETTLE_FAST_POLARITY does not go to zero when changing polarity and may create inconsistencies at the zero crossing.","smuX.SETTLE_DIRECT_IRANGE switches the SMU directly to the target range instead of the default “range-by-range” method. This option is mutually exclusive of any other smuX.SETTLE_FAST_* commands.","Example","smua.source.settling = smua.SETTLE_FAST_POLARITY","Selects fast polarity changing for SMU channel A.","Also see","Range","smuX.source.settling","15154.html");
+Page[343]=new Array("This attribute turns sink mode on or off.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Saved setup","0 (smuX.DISABLE)","Usage","sinkMode = smuX.source.sink","smuX.source.sink = sinkMode","sinkMode","Set to the source sink mode. Set to one of the following values:","0 or smuX.DISABLE: Turns off sink mode","1 or smuX.ENABLE: Turns on sink mode","X","Source‑measure unit (SMU) channel (for example, smua.source.sink applies to SMU channel A)","Details","This attribute enables or disables sink mode. When enabled, sink mode reduces the source limit inaccuracy seen when operating in quadrants II and IV (quadrants I and III will show this source limit inaccuracy).","Example","smua.source.sink = smua.ENABLE","Enables sink mode for SMU channel A.","Also see","Source or sink","smuX.source.sink","15155.html");
+Page[344]=new Array("This attribute sets the arm count in the trigger model.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Not saved","1","Usage","triggerArmCount = smuX.trigger.arm.count","smuX.trigger.arm.count = triggerArmCount","triggerArmCount","The arm count in the trigger model","X","Source‑measure unit (SMU) channel (for example, smua.trigger.arm.count applies to SMU channel A)","Details","During a sweep, the SMU iterates through the arm layer of the trigger model this many times. After performing this many iterations, the SMU returns to an idle state.","If this count is set to zero, the SMU stays in the trigger model indefinitely until aborted.","Example","smua.trigger.arm.count = 5","Sets the SMU channel A to iterate through the arm layer of the trigger model five times and then return to the idle state.","Also see","smuX.trigger.count","smuX.trigger.arm.count","15156.html");
+Page[345]=new Array("This function sets the arm event detector to the detected state.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.trigger.arm.set()","X","Source‑measure unit (SMU) channel (for example, smua.trigger.arm.set() applies to SMU channel A)","Details","The SMU will automatically clear all the event detectors when the smuX.trigger.initiate() function is executed. This function should be called after the sweep is initiated.","A common example of when this function can be used is when you want the SMU to immediately perform an action the first time through the trigger model even if a programmed trigger event does not occur. ","This function can also be used to start actions on the SMU in case of a missed trigger event.","Example","smua.trigger.arm.set()","Sets the arm event detector to the detected state for SMU channel A.","Also see","smuX.trigger.initiate()","smuX.trigger.measure.set()","smuX.trigger.source.set()","smuX.trigger.arm.set()","15157.html");
+Page[346]=new Array("This attribute selects the event that will cause the arm event detector to enter the detected state.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Not saved","0","Usage","eventID = smuX.trigger.arm.stimulus","smuX.trigger.arm.stimulus = eventID","eventID","Event that triggers the arm detector","X","Source‑measure unit (SMU) channel (for example, smua.trigger.arm.stimulus applies to SMU channel A)","Details","Set this attribute to the event ID of any trigger event generator to wait for that event.","Set this attribute to zero to bypass waiting for events at the arm event detector (the SMU continues uninterrupted through the remote trigger model). Set eventID to one of the existing trigger event IDs shown in the following table.","Trigger event IDs*","Event ID","Event description","smua.trigger.SWEEPING_EVENT_ID","Occurs when the source‑measure unit (SMU) transitions from the idle state to the arm layer of the trigger model","smua.trigger.ARMED_EVENT_ID","Occurs when the SMU moves from the arm layer to the trigger layer of the trigger model","smua.trigger.SOURCE_COMPLETE_EVENT_ID","Occurs when the SMU completes a source action","smua.trigger.MEASURE_COMPLETE_EVENT_ID","Occurs when the SMU completes a measure action","smua.trigger.PULSE_COMPLETE_EVENT_ID","Occurs when the SMU completes a pulse","smua.trigger.SWEEP_COMPLETE_EVENT_ID","Occurs when the SMU completes a sweep","smua.trigger.IDLE_EVENT_ID","Occurs when the SMU returns to the idle state","digio.trigger[N].EVENT_ID","Occurs when an edge is detected on a digital I/O line","tsplink.trigger[N].EVENT_ID","Occurs when an edge is detected on a TSP‑Link line","lan.trigger[N].EVENT_ID","Occurs when the appropriate LXI trigger packet is received on LAN trigger object N","display.trigger.EVENT_ID","Occurs when the TRIG key on the front panel is pressed","trigger.EVENT_ID","Occurs when a *TRG command is received on the remote interface","GPIB only: Occurs when a GET bus command is received","VXI-11 only: Occurs with the VXI-11 command device_trigger; reference the VXI-11 standard for additional details on the device trigger operation","trigger.blender[N].EVENT_ID","Occurs after a collection of events is detected","trigger.timer[N].EVENT_ID","Occurs when a delay expires","* Use the name of the trigger event ID to set the stimulus value rather than the numeric value. Using the name makes the code compatible for future upgrades (for example, if the numeric values must change when enhancements are added to the instrument).","Example","smua.trigger.arm.stimulus = "," trigger.timer[1].EVENT_ID","An event on trigger timer 1 causes the arm event detector to enter the detected state.","Also see","Triggering","smuX.trigger.arm.stimulus","15158.html");
+Page[347]=new Array("This constant contains the armed event number.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Constant","Yes","Usage","eventID = smuX.trigger.ARMED_EVENT_ID","eventID","The armed event number","X","Source‑measure unit (SMU) channel (for example, smua.trigger.ARMED_EVENT_ID applies to SMU channel A)","Details","Set the stimulus of any trigger event detector to the value of this constant to have it respond to armed events from this SMU.","Example","trigger.timer[1].stimulus = smua.trigger.ARMED_EVENT_ID","Trigger timer when the SMU passes through the ARM layer.","Also see","Triggering","smuX.trigger.ARMED_EVENT_ID","15159.html");
+Page[348]=new Array("This attribute turns automatic clearing of the event detectors on or off.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Not saved","0 (smuX.DISABLE)","Usage","autoClear = smuX.trigger.autoclear","smuX.trigger.autoclear = autoClear","autoClear","Auto clear setting; set to one of the following values:","0 or smuX.DISABLE: Turns off automatic clearing of the event detectors","1 or smuX.ENABLE: Turns on automatic clearing of the event detectors","X","Source‑measure unit (SMU) channel (for example, smua.trigger.autoclear applies to SMU channel A)","Details","This attribute enables or disables automatic clearing of the trigger model state machine event detectors when the SMU transitions from the arm layer to the trigger layer.","Only the detected state of the event detectors will be cleared.","The overrun status of the event detectors is not automatically cleared when the SMU transitions from the arm layer to the trigger layer.","The event detectors are always cleared when a sweep is initiated.","Also see","Triggering","smuX.trigger.autoclear","15160.html");
+Page[349]=new Array("This attribute sets the trigger count in the trigger model.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Not saved","1","Usage","triggerCount = smuX.trigger.count","smuX.trigger.count = triggerCount","triggerCount","The trigger count is the number of times the source‑measure unit (SMU) will iterate in the trigger layer for any given sweep","X","SMU channel (for example, smua.trigger.count applies to SMU channel A)","Details","During a sweep, the SMU iterates through the trigger layer of the trigger model this many times. After performing this many iterations, the SMU returns to the arm layer.","If this count is set to zero (0), the SMU stays in the trigger model indefinitely until aborted.","Also see","Triggering","smuX.trigger.count","15161.html");
+Page[350]=new Array("This attribute enables or disables pulse mode sweeps.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Not saved","1 (smuX.SOURCE_HOLD)","Usage","pulseAction = smuX.trigger.endpulse.action","smuX.trigger.endpulse.action = pulseAction","pulseAction","The pulse mode setting; set to one of the following values (see Details for definition):","0 or smuX.SOURCE_IDLE","1 or smuX.SOURCE_HOLD","X","Source‑measure unit (SMU) channel (for example, smua.trigger.endpulse.action applies to SMU channel A)","Details","When set to smuX.SOURCE_HOLD, this attribute disables pulse mode sweeps, holding the source level for the remainder of the step. ","When set to smuX.SOURCE_IDLE, this attribute enables pulse mode sweeps, setting the source level to the programmed (idle) level at the end of the pulse.","Example","smua.trigger.endpulse.action = smua.SOURCE_IDLE","smua.trigger.endpulse.stimulus = "," trigger.timer[1].EVENT_ID","Configure the end pulse action to achieve a pulse and configure trigger timer 1 to control the end of pulse.","Also see","Triggering","smuX.trigger.endpulse.action","15162.html");
+Page[351]=new Array("This function sets the end pulse event detector to the detected state.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.trigger.endpulse.set()","X","Source‑measure unit (SMU) channel (for example, smua.trigger.endpulse.set() applies to SMU channel A)","Details","This function sets the end pulse event detector to the detected state.","The SMU automatically clears all the event detectors when the smuX.trigger.initiate() function is executed. This function should be called after the sweep is initiated. Make sure that if the event detectors are configured to clear automatically (because the smuX.trigger.autoclear attribute is set to smuX.ENABLE) that this command is issued after the SMU has entered the trigger layer.","Also see","smuX.trigger.autoclear","smuX.trigger.initiate()","Triggering","smuX.trigger.endpulse.set()","15163.html");
+Page[352]=new Array("This attribute defines which event will cause the end pulse event detector to enter the detected state.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Not saved","0","Usage","eventID = smuX.trigger.endpulse.stimulus","smuX.trigger.endpulse.stimulus = eventID","eventID","Set to the event that triggers the end pulse source off action","X","Source‑measure unit (SMU) channel (for example, smua.trigger.endpulse.stimulus applies to SMU channel A)","Details","Set this attribute to the event ID of any trigger event generator to wait for that event. To bypass waiting for an event, set this attribute's value to 0. Set eventID to one of the existing trigger event IDs shown in the following table.","Trigger event IDs*","Event ID","Event description","smua.trigger.SWEEPING_EVENT_ID","Occurs when the source‑measure unit (SMU) transitions from the idle state to the arm layer of the trigger model","smua.trigger.ARMED_EVENT_ID","Occurs when the SMU moves from the arm layer to the trigger layer of the trigger model","smua.trigger.SOURCE_COMPLETE_EVENT_ID","Occurs when the SMU completes a source action","smua.trigger.MEASURE_COMPLETE_EVENT_ID","Occurs when the SMU completes a measure action","smua.trigger.PULSE_COMPLETE_EVENT_ID","Occurs when the SMU completes a pulse","smua.trigger.SWEEP_COMPLETE_EVENT_ID","Occurs when the SMU completes a sweep","smua.trigger.IDLE_EVENT_ID","Occurs when the SMU returns to the idle state","digio.trigger[N].EVENT_ID","Occurs when an edge is detected on a digital I/O line","tsplink.trigger[N].EVENT_ID","Occurs when an edge is detected on a TSP‑Link line","lan.trigger[N].EVENT_ID","Occurs when the appropriate LXI trigger packet is received on LAN trigger object N","display.trigger.EVENT_ID","Occurs when the TRIG key on the front panel is pressed","trigger.EVENT_ID","Occurs when a *TRG command is received on the remote interface","GPIB only: Occurs when a GET bus command is received","VXI-11 only: Occurs with the VXI-11 command device_trigger; reference the VXI-11 standard for additional details on the device trigger operation","trigger.blender[N].EVENT_ID","Occurs after a collection of events is detected","trigger.timer[N].EVENT_ID","Occurs when a delay expires","* Use the name of the trigger event ID to set the stimulus value rather than the numeric value. Using the name makes the code compatible for future upgrades (for example, if the numeric values must change when enhancements are added to the instrument).","Example","smua.trigger.endpulse.action = smua.SOURCE_IDLE","smua.trigger.endpulse.stimulus = "," trigger.timer[1].EVENT_ID","Configure the end pulse action to achieve a pulse and select the event trigger.timer[1].EVENT_ID that will cause the arm event detector to enter the detected state.","Also see","Triggering","smuX.trigger.endpulse.stimulus","15165.html");
+Page[353]=new Array("This attribute sets the action of the source at the end of a sweep.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Not saved","0 (smuX.SOURCE_IDLE)","Usage","action = smuX.trigger.endsweep.action","smuX.trigger.endsweep.action = action","action","The source action at the end of a sweep; set to one of the following values:","0 or smuX.SOURCE_IDLE: Sets the source level to the programmed (idle) level at the end of the sweep","1 or smuX.SOURCE_HOLD: Sets the source level to stay at the level of the last step","X","Source‑measure unit (SMU) channel (for example, smua.trigger.endsweep.action applies to SMU channel A)","Details","Use this attribute to configure the source action at the end of the sweep. The SMU can be programmed to return to the idle source level or hold the last value of the sweep.","Example","smua.trigger.endsweep.action = smua.SOURCE_IDLE","Sets SMU channel A to return the source back to the idle source level at the end of a sweep.","Also see","Triggering","smuX.trigger.endsweep.action","15166.html");
+Page[354]=new Array("This constant contains the idle event number.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Constant","Yes","Usage","eventID = smuX.trigger.IDLE_EVENT_ID","eventID","The idle event number","X","Source-measure unit (SMU) channel (for example, smua.trigger.IDLE_EVENT_ID applies to SMU channel A)","Details","Set the stimulus of any trigger event detector to the value of this constant to have it respond to idle events from this SMU.","Example","trigger.timer[1].stimulus = smua.trigger.IDLE_EVENT_ID","Trigger timer when the SMU returns to the idle layer.","Also see","Triggering","smuX.trigger.IDLE_EVENT_ID","15167.html");
+Page[355]=new Array("This function initiates a sweep operation.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.trigger.initiate()","X","Source‑measure unit (SMU) channel (for example, smua.trigger.initiate() applies to SMU channel A)","Details","This function causes the SMU to clear the four trigger model event detectors and enter its trigger model state machine (moves the SMU from the idle state into the arm layer).","To perform source actions during the sweep, before calling this function, it is necessary to configure and enable one of the sweep source actions: smuX.trigger.source.linearY(), smuX.trigger.source.listY(), smuX.trigger.source.logY()and the measure action smuX.trigger.measure.Y().","If you run this function more than once without reconfiguring the sweep measurements, the caches on the configured measurement reading buffers will hold stale data; use the bufferVar.clearcache() function to remove stale values from the reading buffer cache.","This function initiates an overlapped operation.","Example","smua.trigger.initiate()","Starts a preconfigured sweep and clears the event detectors for SMU channel A.","Also see","bufferVar.clearcache()","Configuring and running sweeps","smuX.trigger.measure.action","smuX.trigger.measure.Y()","smuX.trigger.source.action","smuX.trigger.source.linearY()","smuX.trigger.source.listY()","smuX.trigger.source.logY()","Triggering","smuX.trigger.initiate()","15168.html");
+Page[356]=new Array("This attribute controls measurement actions during a sweep.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Not saved","0 (smuX.DISABLE)","Usage","action = smuX.trigger.measure.action","smuX.trigger.measure.action = action","action","The sweep measure action; set to one of the following values:","0 or smuX.DISABLE: Do not make measurements during the sweep","1 or smuX.ENABLE: Make measurements during the sweep","2 or smuX.ASYNC: Make measurements during the sweep, but asynchronously","with the source area of the trigger model","X","Source‑measure unit (SMU) channel (for example, smua.trigger.measure.action applies to SMU channel A)","Details","With this attribute enabled (setting action to smuX.ENABLE or smuX.ASYNC), configure the measurement with one of the smuX.trigger.measure.Y() functions.","If this attribute is set to smuX.ASYNC:","Asynchronous sweep measurements can only be used with measure autoranging turned off. To turn measure autoranging off for all measurements during the sweep, set the smuX.measure.autorangeY attribute to smuX.AUTORANGE_OFF.","If the integrating ADC is selected (smuX.measure.adc attribute is set to smuX.ADC_INTEGRATE), autozero must also be turned off. To turn off autozero, set the smuX.measure.autozero attribute to smuX.AUTOZERO_OFF or smuX.AUTOZERO_ONCE.","If either of the above items is incorrectly configured, the smuX.trigger.initiate() function will generate an error.","Also see","smuX.measure.adc","smuX.trigger.autoclear","smuX.trigger.measure.Y()","Triggering","smuX.trigger.measure.action","15169.html");
+Page[357]=new Array("This function sets the measure event detector to the detected state.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.trigger.measure.set()","X","Source‑measure unit (SMU) channel (for example, smua.trigger.measure.set() applies to SMU channel A)","Details","This function is useful whenever you want the SMU to continue operation without waiting for a programmed trigger event. When called, this function immediately satisfies the event detector, allowing the SMU to continue through the trigger model.","A common example of when this function can be used is when you want the SMU to immediately perform an action the first time through the trigger model even if a programmed trigger event does not occur. Make sure that if the event detectors are configured to clear automatically (because the smuX.trigger.autoclear attribute is set to smuX.ENABLE) that this command is issued after the SMU has entered the trigger layer. This function can also be used to start actions on the SMU in case of a missed trigger event.","The SMU will automatically clear all event detectors when the smuX.trigger.initiate() function is executed. This function should be called after the sweep is initiated.","Example","smua.trigger.measure.set()","Sets the measure event detector of SMU channel A.","Also see","smuX.trigger.arm.set()","smuX.trigger.autoclear","smuX.trigger.endpulse.set()","smuX.trigger.source.set()","smuX.trigger.measure.set()","15170.html");
+Page[358]=new Array("This attribute selects which event will cause the measure event detector to enter the detected state.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Not saved","0","Usage","eventID = smuX.trigger.measure.stimulus","smuX.trigger.measure.stimulus = eventID","eventID","Event that triggers the measure detector","X","Source‑measure unit (SMU) channel (for example, smua.trigger.measure.stimulus applies to SMU channel A)","Details","Set this attribute to the event ID of any trigger event generator to wait for that event. When set, the SMU waits for the event at the measure event detector portion of the trigger model.","Set this attribute to zero to bypass waiting for an event (the SMU continues uninterrupted through the remote trigger model). Set eventID to one of the existing trigger event IDs shown in the following table.","Trigger event IDs*","Event ID","Event description","smua.trigger.SWEEPING_EVENT_ID","Occurs when the source‑measure unit (SMU) transitions from the idle state to the arm layer of the trigger model","smua.trigger.ARMED_EVENT_ID","Occurs when the SMU moves from the arm layer to the trigger layer of the trigger model","smua.trigger.SOURCE_COMPLETE_EVENT_ID","Occurs when the SMU completes a source action","smua.trigger.MEASURE_COMPLETE_EVENT_ID","Occurs when the SMU completes a measure action","smua.trigger.PULSE_COMPLETE_EVENT_ID","Occurs when the SMU completes a pulse","smua.trigger.SWEEP_COMPLETE_EVENT_ID","Occurs when the SMU completes a sweep","smua.trigger.IDLE_EVENT_ID","Occurs when the SMU returns to the idle state","digio.trigger[N].EVENT_ID","Occurs when an edge is detected on a digital I/O line","tsplink.trigger[N].EVENT_ID","Occurs when an edge is detected on a TSP‑Link line","lan.trigger[N].EVENT_ID","Occurs when the appropriate LXI trigger packet is received on LAN trigger object N","display.trigger.EVENT_ID","Occurs when the TRIG key on the front panel is pressed","trigger.EVENT_ID","Occurs when a *TRG command is received on the remote interface","GPIB only: Occurs when a GET bus command is received","VXI-11 only: Occurs with the VXI-11 command device_trigger; reference the VXI-11 standard for additional details on the device trigger operation","trigger.blender[N].EVENT_ID","Occurs after a collection of events is detected","trigger.timer[N].EVENT_ID","Occurs when a delay expires","* Use the name of the trigger event ID to set the stimulus value rather than the numeric value. Using the name makes the code compatible for future upgrades (for example, if the numeric values must change when enhancements are added to the instrument).","Example","smua.trigger.measure.stimulus = trigger.timer[1].EVENT_ID","Sets delay before measurement begins on SMU channel A.","Also see","Triggering","smuX.trigger.measure.stimulus","15171.html");
+Page[359]=new Array("This function configures the measurements that are to be made in a subsequent sweep.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.trigger.measure.Y(rbuffer)","smuX.trigger.measure.iv(ibuffer, vbuffer)","X","Source‑measure unit (SMU) channel (for example, smua.trigger.measure.v() applies to SMU channel A)","Y","SMU measurement type (v = voltage, i = current, r = resistance, p = power)","rbuffer","A reading buffer object where the readings will be stored","ibuffer","A reading buffer object where current readings will be stored","vbuffer","A reading buffer object where voltage readings will be stored","Details","The measurements, as they are performed, are stored in a reading buffer. If the instrument is configured to return multiple readings where one is requested, the readings will be available as they are made. Measurements are in the following units of measure: v = volts, i = amperes, r = ohms, p = watts.","The smuX.trigger.measure.iv() function stores current readings in ibuffer and voltage readings in vbuffer.","If a given reading buffer contains any data, it will be cleared prior to taking any measurements, unless the reading buffer has been configured to append data.","The SMU only retains the last call to any one of these functions and only that measure action will be performed.","After configuring the measurements to make with this function, remember to enable the measure action by setting smuX.trigger.measure.action = smuX.ENABLE.","Example","smua.trigger.measure.v(vbuffername)","smua.trigger.measure.action = smua.ENABLE","Stores voltage readings during the sweep for SMU channel A in buffer vbuffername.","Also see","smuX.measure.Y()","smuX.nvbufferY","smuX.trigger.measure.action","waitcomplete()","Reading buffers","Sweep Operation","Triggering","smuX.trigger.measure.Y()","15172.html");
+Page[360]=new Array("This constant contains the measure complete event number.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Constant","Yes","Usage","eventID = smuX.trigger.MEASURE_COMPLETE_EVENT_ID","eventID","The measure complete event number","X","Source‑measure unit (SMU) channel (for example, smua.trigger.MEASURE_COMPLETE_EVENT_ID applies to SMU channel A)","Details","Set the stimulus of any trigger event detector to the value of this constant to have it respond to measure complete events from this SMU.","Also see","Triggering","smuX.trigger.MEASURE_COMPLETE_EVENT_ID","15173.html");
+Page[361]=new Array("This constant contains the pulse complete event number.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Constant","Yes","Usage","eventID = smuX.trigger.PULSE_COMPLETE_EVENT_ID","eventID","The pulse complete event number","X","Source‑measure unit (SMU) channel (for example, smua.trigger.PULSE_COMPLETE_EVENT_ID applies to SMU channel A)","Details","Set the stimulus of any trigger event detector to the value of this constant to have it respond to pulse complete events from this SMU.","Also see","Triggering","smuX.trigger.PULSE_COMPLETE_EVENT_ID","15174.html");
+Page[362]=new Array("This attribute enables or disables sweeping the source (on or off).","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Not saved","0 (smuX.DISABLE)","Usage","action = smuX.trigger.source.action","smuX.trigger.source.action = action","action","Sweep source action. Set to one of the following values:","0 or smuX.DISABLE: Do not sweep the source","1 or smuX.ENABLE: Sweep the source","X","Source‑measure unit (SMU) channel (for example, smua.trigger.source.action applies to SMU channel A)","Details","This attribute is used to enable or disable source level changes during a sweep. In addition to enabling the action before initiating the sweep, make sure to configure it using smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY().","Example","smua.trigger.source.listv({3, 1, 4, 5, 2})","smua.trigger.source.action = smua.ENABLE","Configure list sweep for SMU channel A (sweep through","3 V, 1 V, 4 V, 5 V, and 2 V).","Enable the source action.","Also see","smuX.trigger.source.linearY()","smuX.trigger.source.listY()","smuX.trigger.source.logY()","Triggering","smuX.trigger.source.action","15178.html");
+Page[363]=new Array("This attribute sets the sweep source limit.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Not saved","0 (smuX.LIMIT_AUTO)","Usage","sweepSourceLimit = smuX.trigger.source.limitY","smuX.trigger.source.limitY = sweepSourceLimit","sweepSourceLimit","Source limit during triggered operation; set to the desired source limit during triggered operation or smuX.LIMIT_AUTO","X","Source‑measure unit (SMU) channel (for example, smua.trigger.source.limitv applies to SMU channel A)","Y","SMU output function (v = voltage, i = current)","Details","If this attribute is set to smuX.LIMIT_AUTO (or 0), the SMU will use the normal limit setting during sweeping. If this attribute is set to any other numeric value, the SMU will switch in this limit at the start of the source action and will switch back to the normal limit setting at the end of the end pulse action.","Normally, the limit range is automatically adjusted in accordance with the desired limit value. During sweeping, however, the limit range is fixed in order to avoid the delays associated with changing range. This fixed limit range is determined by the maximum limit value needed during the sweep; that is, the greater of either the normal limit value (as specified by smuX.source.limitY) or the sweep limit value (as specified by smuX.trigger.source.limitY). Note that the minimum limit value that can be enforced during the sweep is equal to 10 percent of the full scale value of the fixed limit range. If the smaller limit value (normal or sweep) falls below this 10% threshold, the 10 percent value will be enforced instead. Likewise, if the limit value were to fall below the 10 percent threshold as a result of power compliance, the 10 percent value will be enforced instead.","Example","smua.trigger.source.limitv = 500","Sets the voltage sweep limit of SMU channel A to 500 V.","Also see","smuX.source.limitY","Configuring and running sweeps","Triggering","smuX.trigger.source.limitY","15179.html");
+Page[364]=new Array("This function configures a linear source sweep.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.trigger.source.linearY(startValue, endValue, points)","X","Source‑measure unit (SMU) channel (for example, smua.trigger.source.linearv(0, 10, 11) applies to SMU channel A)","Y","SMU source function (v = voltage, i = current)","startValue","Source value of the first point","endValue","Source value of the last point","points","The number of points used to calculate the step size","Details","This function configures the source action to be a linear source sweep in a subsequent sweep. During the sweep, the source will generate a uniform series of ascending or descending voltage or current changes called steps. The number of source steps is one less than the number of sourced points.","The points parameter does not set the number of steps in a sweep, but rather is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source will restart at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU will satisfy the trigger count by restarting the sweep values from the beginning. ","If the subsequent sweep has fewer points than specified in points, endValue will not be reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU will satisfy the trigger count and ignore the remaining source values.","In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep will return a stable value for the first measured point without penalizing remaining points in the sweep.","With linear sweeps it is acceptable to maintain a fixed source resolution over the entire sweep. To prevent source range changes during the sweep (especially when sweeping through 0.0), set the source range to a fixed range appropriate for the larger of either startValue or endValue. ","The SMU will only store the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.","Source functions cannot be changed within a sweep.","After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.","Example","smua.trigger.source.linearv(0, 1000, 11)","Sweeps SMU channel A from 0 V to 1000 V in 100 V steps.","Also see","smuX.trigger.source.action","smuX.trigger.source.listY()","smuX.trigger.source.logY()","Sweep Operation","smuX.trigger.source.linearY()","15180.html");
+Page[365]=new Array("This function configures an array-based source sweep.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.trigger.source.listY(sweepList)","X","Source‑measure unit (SMU) channel (for example, smua.trigger.source.listv({5}) applies to SMU channel A)","Y","SMU source function (v = voltage, i = current)","sweepList","An array of source values","Details","This function configures the source action to be a list sweep in a subsequent sweep. During the sweep, the source will output the sequence of source values given in the sweepList array.","If the subsequent sweep has more points than specified in sweepList, the source will restart at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU will satisfy the trigger count by restarting the sweep values from the beginning. ","If the subsequent sweep has fewer points than specified in sweepList, the extra values will be ignored. This means that if the trigger count is less than the number of source values configured, the SMU will satisfy the trigger count and ignore the remaining source values.","In cases where the first sweep point is a nonzero value, it may be necessary to pre-charge the circuit so that the sweep will return a stable value for the first measured point without penalizing remaining points in the sweep.","The SMU will only store the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.","Source functions cannot be changed within a sweep.","After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.","Example","smua.trigger.source.listv({3, 1, 4, 5, 2})","Sweeps SMU channel A through 3 V, 1 V, 4 V, 5 V, and 2 V.","Also see","smuX.trigger.source.action","smuX.trigger.source.linearY()","smuX.trigger.source.logY()","Sweep Operation","smuX.trigger.source.listY()","15181.html");
+Page[366]=new Array("This function configures an exponential (geometric) source sweep.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.trigger.source.logY(startValue, endValue, points, asymptote)","X","Source-measure unit (SMU) channel (for example, smua.trigger.source.logv(1, 10, 11, 0) applies to SMU channel A)","Y","SMU source function (v = voltage, i = current)","startValue","Source value of the first point","endValue","Source value of the last point","points","The number of points used to calculate the step size","asymptote","The asymptotic offset value","Details","This function configures the source action to be a geometric source sweep in a subsequent sweep. During the sweep, the source generates a geometric series of ascending or descending voltage or current changes called steps. Each step is larger or smaller than the previous step by a fixed proportion. The constant of proportionality is determined by the starting value, the ending value, the asymptote, and the number of steps in the sweep. The number of source steps is one less than the number of sourced points.","The points parameter does not set the number of steps in a sweep, but rather is used to calculate source values within a subsequent sweep. If the subsequent sweep has more points than specified in points, the source restarts at the beginning. This means that if the trigger count is greater than the number of points in a sweep as configured, the SMU satisfies the trigger count by restarting the sweep values from the beginning. ","If the subsequent sweep has fewer points than specified in points, endValue is not reached during the sweep. This means that if the trigger count is less than the number of source values configured, the SMU satisfies the trigger count and ignores the remaining source values.","In cases where the first sweep point is nonzero, it may be necessary to pre-charge the circuit so that the sweep returns a stable value for the first measured point without penalizing remaining points in the sweep.","With logarithmic sweeps, it is usually necessary to allow the source to autorange to maintain good source accuracy when sweeping over more than one decade or across range boundaries.","The asymptote parameter can be used to customize the inflection and offset of the source value curve. This allows log sweeps to cross zero. Setting this parameter to zero provides a conventional logarithmic sweep. The asymptote value is the value that the curve has at either positive or negative infinity, depending on the direction of the sweep.","The asymptote value must not be equal to or between the starting and ending values. It must be outside the range defined by the starting and ending values.","The SMU stores only the most recent configured source action. The last call to smuX.trigger.source.linearY(), smuX.trigger.source.listY(), or smuX.trigger.source.logY() is used for the source action.","Source functions cannot be changed within a sweep.","After configuring the sweep source values, enable the source action by setting smuX.trigger.source.action.","Example","smua.trigger.source.logv(1, 10, 11, 0)","Sweeps SMU channel A from 1 V to 10 V in 10 steps with an asymptote of 0 V.","Also see","smuX.trigger.source.action","smuX.trigger.source.linearY()","smuX.trigger.source.listY()","Sweep operation","smuX.trigger.source.logY()","15182.html");
+Page[367]=new Array("This function sets the source event detector to the detected state.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","smuX.trigger.source.set()","X","Source‑measure unit (SMU) channel (for example, smua.trigger.source.set() applies to SMU channel A)","Details","This function sets the source event detector to the detected state.","The SMU automatically clears all event detectors when the smuX.trigger.initiate() function is executed. This function should be called after the sweep is initiated. Make sure that if the event detectors are configured to clear automatically (because the smuX.trigger.autoclear attribute is set to smuX.ENABLE) that this command is issued after the SMU has entered the trigger layer.","Also see","smuX.trigger.arm.set()","smuX.trigger.autoclear","smuX.trigger.endpulse.set()","smuX.trigger.initiate()","smuX.trigger.measure.set()","Triggering","smuX.trigger.source.set()","15183.html");
+Page[368]=new Array("This attribute defines which event causes the source event detector to enter the detected state.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","SMU reset Instrument reset Recall setup","Not saved","0","Usage","eventID = smuX.trigger.source.stimulus","smuX.trigger.source.stimulus = eventID","eventID","Set to the event that triggers the end pulse source off action","X","Source‑measure (SMU) channel (for example, smua.trigger.source.stimulus applies to SMU channel A)","Details","Set this attribute to the event ID of any trigger event generator to wait for that event. When set, the SMU waits for the event at the source event detector portion of the trigger model. To bypass waiting for an event, set this attribute's value to zero (0). Set eventID to one of the existing trigger event IDs shown in the following table.","Trigger event IDs*","Event ID","Event description","smua.trigger.SWEEPING_EVENT_ID","Occurs when the source‑measure unit (SMU) transitions from the idle state to the arm layer of the trigger model","smua.trigger.ARMED_EVENT_ID","Occurs when the SMU moves from the arm layer to the trigger layer of the trigger model","smua.trigger.SOURCE_COMPLETE_EVENT_ID","Occurs when the SMU completes a source action","smua.trigger.MEASURE_COMPLETE_EVENT_ID","Occurs when the SMU completes a measure action","smua.trigger.PULSE_COMPLETE_EVENT_ID","Occurs when the SMU completes a pulse","smua.trigger.SWEEP_COMPLETE_EVENT_ID","Occurs when the SMU completes a sweep","smua.trigger.IDLE_EVENT_ID","Occurs when the SMU returns to the idle state","digio.trigger[N].EVENT_ID","Occurs when an edge is detected on a digital I/O line","tsplink.trigger[N].EVENT_ID","Occurs when an edge is detected on a TSP‑Link line","lan.trigger[N].EVENT_ID","Occurs when the appropriate LXI trigger packet is received on LAN trigger object N","display.trigger.EVENT_ID","Occurs when the TRIG key on the front panel is pressed","trigger.EVENT_ID","Occurs when a *TRG command is received on the remote interface","GPIB only: Occurs when a GET bus command is received","VXI-11 only: Occurs with the VXI-11 command device_trigger; reference the VXI-11 standard for additional details on the device trigger operation","trigger.blender[N].EVENT_ID","Occurs after a collection of events is detected","trigger.timer[N].EVENT_ID","Occurs when a delay expires","* Use the name of the trigger event ID to set the stimulus value rather than the numeric value. Using the name makes the code compatible for future upgrades (for example, if the numeric values must change when enhancements are added to the instrument).","Example","smua.trigger.source.stimulus = digio.trigger[2].EVENT_ID","Configure SMU channel A to start its source action when a trigger event occurs on digital I/O line 2.","Also see","Triggering","smuX.trigger.source.stimulus","15184.html");
+Page[369]=new Array("This constant contains the source complete event number.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Constant","Yes","Usage","eventID = smuX.trigger.SOURCE_COMPLETE_EVENT_ID","eventID","The source action complete event number","X","Source‑measure unit (SMU) channel (for example, smua.trigger.SOURCE_COMPLETE_EVENT_ID applies to SMU channel A)","Details","Set the stimulus of any trigger event detector to the value of this constant to have it respond to source complete events from this source‑measure unit (SMU).","Also see","Triggering","smuX.trigger.SOURCE_COMPLETE_EVENT_ID","15175.html");
+Page[370]=new Array("This constant contains the sweep complete event number.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Constant","Yes","Usage","eventID = smuX.trigger.SWEEP_COMPLETE_EVENT_ID","eventID","The sweep complete event number","X","Source‑measure unit (SMU) channel (for example, smua.trigger.SWEEP_COMPLETE_EVENT_ID applies to SMU channel A)","Details","Set the stimulus of any trigger event detector to the value of this constant to have it respond to sweep complete events from this SMU.","Also see","Triggering","smuX.trigger.SWEEP_COMPLETE_EVENT_ID","15176.html");
+Page[371]=new Array("This constant contains the sweeping event number.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Constant","Yes","Usage","eventID = smuX.trigger.SWEEPING_EVENT_ID","eventID","The sweeping event number","X","Source‑measure unit (SMU) channel (for example, smua.trigger.SWEEPING_EVENT_ID applies to SMU channel A)","Details","Set the stimulus of any trigger event detector to the value of this constant to have it respond to sweeping events from this SMU.","Also see","Triggering","smuX.trigger.SWEEPING_EVENT_ID","15177.html");
+Page[372]=new Array("This attribute stores the status byte condition register.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not saved","Not applicable","Usage","statusByte = status.condition","statusByte","The status byte; a zero (0) indicates no bits set; other values indicate various bit settings","Details","This attribute is used to read the status byte, which is returned as a numeric value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000 0001. This value indicates that bit B0 and bit B7 are set.","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">","*","1","0","0","0","0","0","0","1","* Least significant bit ** Most significant bit ","The returned value can indicate one or more status events occurred. When an enabled status event occurs, a summary bit is set in this register to indicate the event occurrence."," The individual bits of this register have the following meanings:","Bit","Value","Description","B0","status.MEASUREMENT_SUMMARY_BIT","status.MSB","Set summary bit indicates that an enabled measurement event has occurred. ","Bit B0 decimal value: 1","B1","status.SYSTEM_SUMMARY_BIT","status.SSB","Set summary bit indicates that an enabled system event has occurred.","Bit B1 decimal value: 2","B2","status.ERROR_AVAILABLE","status.EAV","Set summary bit indicates that an error or status message is present in the Error Queue. ","Bit B2 decimal value: 4","B3","status.QUESTIONABLE_SUMMARY_BIT","status.QSB","Set summary bit indicates that an enabled questionable event has occurred. ","Bit B3 decimal value: 8","B4","status.MESSAGE_AVAILABLE","status.MAV","Set summary bit indicates that a response message is present in the Output Queue. ","Bit B4 decimal value: 16","B5","status.EVENT_SUMMARY_BIT","status.ESB","Set summary bit indicates that an enabled standard event has occurred. ","Bit B5 decimal value: 32","B6","status.MASTER_SUMMARY_STATUS","status.MSS","Request Service (RQS)/Master Summary Status (MSS). Depending on how it is used, bit B6 of the status byte register is either the Request for Service (RQS) bit or the Master Summary Status (MSS) bit:","When using the GPIB or VXI-11 serial poll sequence of the Model 2657A to obtain the status byte (serial poll byte), B6 is the RQS bit. The set bit indicates that the Request Service (RQS) bit of the status byte (serial poll byte) is set and a serial poll (SRQ) has occurred. ","When using the status.condition register command or the *STB? common command to read the status byte, B6 is the MSS bit. Set bit indicates that an enabled summary bit of the status byte register is set.","Bit B6 decimal value: 64","B7","status.OPERATION_SUMMARY_BIT","status.OSB","Set summary bit indicates that an enabled operation event has occurred.","Bit B7 decimal value: 128","In addition to the above constants, when more than one bit of the register is set, statusByte equals the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Example","statusByte = status.condition","print(statusByte)","Returns statusByte.","Sample output:","1.29000e+02","Converting this output (129) to its binary equivalent yields 1000 0001 ","Therefore, this output indicates that the set bits of the status byte condition register are presently B0 (MSS) and B7 (OSB).","Also see","Status byte and service request (SRQ)","status.condition","15822.html");
+Page[373]=new Array("This attribute contains the measurement event register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","10,639 (All bits set)","Usage","measurementRegister = status.measurement.condition","measurementRegister = status.measurement.enable","measurementRegister = status.measurement.event","measurementRegister = status.measurement.ntr","measurementRegister = status.measurement.ptr","status.measurement.enable = measurementRegister","status.measurement.ntr = measurementRegister","status.measurement.ptr = measurementRegister","measurementRegister","The measurement event register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","Details","These attributes read or write the measurement event registers.","Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. ","For example, assume value 257 is returned for the enable register. The binary equivalent is 0000 0001 0000 0001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","0","0","0","0","0","1","0","0","0","0","0","0","0","1","* Least significant bit ** Most significant bit","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","The individual bits of this register can be set to the following described values:","Bit","Value","Description","B0","status.measurement.VOLTAGE_LIMIT","status.measurement.VLMT","Set bit is a summary of the status.measurement.voltage_limit register.","Bit B0 decimal value: 1","B1","status.measurement.CURRENT_LIMIT","status.measurement.ILMT","Set bit is a summary of the status.measurement.current_limit register.","Bit B1 decimal value: 2","B2","status.measurement.SINK_LIMIT","status.measurement.SLMT","Set bit is a summary of the status.measurement.sink_limit register.","Bit B2 decimal value: 4 ","B3","status.measurement.OVERVOLTAGE","status.measurement.OV","Set bit is a summary of the status.measurement.overvoltage register.","Bit B3 decimal value: 8 ","B4-B6","Not used","Not applicable","B7","status.measurement.READING_OVERFLOW","status.measurement.ROF","Set bit is a summary of the status.measurement.reading_overflow register.","Bit B7 decimal value: 128","B8","status.measurement.BUFFER_AVAILABLE","status.measurement.BAV","Set bit is a summary of the status.measurement.buffer_available register.","Bit B8 decimal value: 256","B9-B10","Not used","Not applicable","B11","status.measurement.INTERLOCK","status.measurement.INT","Set bit indicates that the interlock has been asserted.","Bit B11 decimal value: 2048","B12","Not used","Not applicable","B13","status.measurement.INSTRUMENT_SUMMARY","status.measurement.INST","Set bit indicates that a bit in the measurement instrument summary register is set.","Bit B13 decimal value: 8192","B14-B15","Not used","Not applicable","As an example, to set bit B8 of the measurement event enable register, set status.measurement.enable = status.measurement.BAV.","In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8,192","4,096","2048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Example","status.measurement.enable = status.measurement.BAV","Sets the BAV bit of the measurement event enable register.","Also see","Measurement event registers","status.measurement.*","15823.html");
+Page[374]=new Array("This attribute contains the measurement event buffer available summary register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","2 (All bits set)","Usage","measurementRegister = status.measurement.buffer_available.condition","measurementRegister = status.measurement.buffer_available.enable","measurementRegister = status.measurement.buffer_available.event","measurementRegister = status.measurement.buffer_available.ntr","measurementRegister = status.measurement.buffer_available.ptr","status.measurement.buffer_available.enable = measurementRegister","status.measurement.buffer_available.ntr = measurementRegister","status.measurement.buffer_available.ptr = measurementRegister","measurementRegister","The measurement event register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 2","Details","These attributes are used to read or write to the measurement event buffer available summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000 0000 0000 0010. This value indicates that bit B1 (SMUA) is set.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable.","B1","status.measurement.buffer_available.SMUA","Set bit indicates that there is at least one reading stored in either or both of the dedicated reading buffers.","Bit B1 decimal value: 2","Binary value: 0000 0010","B2-B15","Not used","Not applicable.","As an example, to set bit B1 of the measurement event buffer available summary enable register, set status.measurement.buffer_available.enable = status.measurement.buffer_available.SMUA.","In addition to the above constant, measurementRegister can be set to the decimal equivalent of the bit to set.","Example","status.measurement.buffer_available.enable ="," status.measurement.buffer_available.SMUA","Sets the SMUA bit of the measurement event buffer available summary enable register.","Also see","Measurement event registers","status.measurement.buffer_available.*","15824.html");
+Page[375]=new Array("This attribute contains the measurement event current limit summary registers.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","2 (All bits set)","Usage","measurementRegister = status.measurement.current_limit.condition","measurementRegister = status.measurement.current_limit.enable","measurementRegister = status.measurement.current_limit.event","measurementRegister = status.measurement.current_limit.ntr","measurementRegister = status.measurement.current_limit.ptr","status.measurement.current_limit.enable = measurementRegister","status.measurement.current_limit.ntr = measurementRegister","status.measurement.current_limit.ptr = measurementRegister","measurementRegister","The measurement event current limit summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 2","Details","These attributes are used to read or write to the measurement event current limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000 0000 0000 0010. This value indicates that bit B1 (SMUA) is set.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable.","B1","status.measurement.current_limit.SMUA","Set bit indicates that the current limit was exceeded.","Bit B1 decimal value: 2","Binary value: 0000 0010","B2-B15","Not used","Not applicable.","As an example, to set bit B1 of the measurement event current limit summary enable register, set status.measurement.current_limit.enable = status.measurement.current_limit.SMUA.","In addition to the above constant, measurementRegister can be set to the decimal equivalent of the bit to set.","Example","status.measurement.current_limit.enable ="," status.measurement.current_limit.SMUA","Sets the SMUA bit of the measurement event current limit summary enable register.","Also see","Measurement event registers","status.measurement.instrument.smuX.*","status.measurement.current_limit.*","15825.html");
+Page[376]=new Array("This attribute contains the registers of the measurement event instrument summary register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","2 (All bits set)","Usage","measurementRegister = status.measurement.instrument.condition","measurementRegister = status.measurement.instrument.enable","measurementRegister = status.measurement.instrument.event","measurementRegister = status.measurement.instrument.ntr","measurementRegister = status.measurement.instrument.ptr","status.measurement.instrument.enable = measurementRegister","status.measurement.instrument.ntr = measurementRegister","status.measurement.instrument.ptr = measurementRegister","measurementRegister","The measurement event instrument summary register status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","Details","These attributes are used to read or write to the measurement event instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000 0000 0000 0010. This value indicates that bit B1 (SMUA) is set.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable.","B1","status.measurement.instrument.SMUA","Set bit indicates one or more enabled bits of the measurement event SMU A summary register is set.","Bit B1 decimal value: 2","Binary value: 0000 0010","B2-B15","Not used","Not applicable.","As an example, to set bit B1 of the measurement event instrument summary enable register, set status.measurement.instrument.enable = status.measurement.instrument.SMUA.","In addition to the above constant, measurementRegister can be set to the decimal equivalent of the bit to set.","Example","status.measurement.instrument.enable ="," status.measurement.instrument.SMUA","Sets the SMU A bit of the measurement event instrument summary enable register using a constant.","Also see","Measurement event registers","status.measurement.instrument.*","15826.html");
+Page[377]=new Array("This attribute contains the registers of the measurement event SMU X summary register set. ","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","399 (All bits set)","Usage","measurementRegister = status.measurement.instrument.smuX.condition","measurementRegister = status.measurement.instrument.smuX.enable","measurementRegister = status.measurement.instrument.smuX.event","measurementRegister = status.measurement.instrument.smuX.ntr","measurementRegister = status.measurement.instrument.smuX.ptr","status.measurement.instrument.smuX.enable = measurementRegister","status.measurement.instrument.smuX.ntr = measurementRegister","status.measurement.instrument.smuX.ptr = measurementRegister ","measurementRegister","The instrument measurement status SMU X summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","X","Source-measure unit (SMU) channel (for example status.measurement.instrument.smua.enable applies to SMU channel A)","Details","These attributes are used to read or write to the measurement event SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 257 is returned for the enable register. The binary equivalent is 0000 0001 0000 0001. This value indicates that bit B0 (VLMT) and bit B8 (BAV) are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","0","0","0","0","0","1","0","0","0","0","0","0","0","1","* Least significant bit ** Most significant bit ","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0*","status.measurement.instrument.smuX.VOLTAGE_LIMIT","status.measurement.instrument.smuX.VLMT","Set bit indicates that the voltage limit was exceeded.","Bit B0 decimal value: 1","B1*","status.measurement.instrument.smuX.CURRENT_LIMIT","status.measurement.instrument.smuX.ILMT","Set bit indicates that the current limit was exceeded.","Bit B1 decimal value: 2","B2*","status.measurement.instrument.smuX.SINK_LIMIT","status.measurement.instrument.smuX.SLMT","Set bit indicates that a sink compliance condition has occurred.","Bit B2 decimal value: 4 ","B3*","status.measurement.instrument.smuX.OVERVOLTAGE","status.measurement.instrument.smuX.OV","Set bit indicates that an overvoltage condition has occurred.","Bit B3 decimal value: 8 ","B4-B6","Not used","Not applicable.","B7","status.measurement.instrument.smuX.READING_OVERFLOW","status.measurement.instrument.smuX.ROF","Set bit indicates that an overflow reading has been detected.","Bit B7 decimal value: 128","B8","status.measurement.instrument.smuX.BUFFER_AVAILABLE","status.measurement.instrument.smuX.BAV","Set bit indicates that there is at least one reading stored in either or both of the dedicated reading buffers.","Bit B8 decimal value: 256","B9-B15","Not used","Not applicable.","* This bit will be updated only when a measurement is taken or smuX.source.compliance is invoked.","As an example, to set bit B0 of the measurement event SMU X summary enable register, set status.measurement.instrument.smua.enable = status.measurement.instrument.smua.VLMT.","In addition to the above constants, measurementRegister can be set to the decimal equivalent of the bit to set. To set more than one bit of the register, set measurementRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set measurementRegister to 258 (which is the sum of 2 + 256). ","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8192","4096","2048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Example","status.measurement.instrument.smua.enable ="," status.measurement.instrument.smua.VLMT","Sets the VLMT bit of the measurement event SMU A summary enable register using a constant.","Also see","Measurement event registers","status.measurement.instrument.smuX.*","15827.html");
+Page[378]=new Array("This attribute contains the measurement event overvoltage summary register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","2 (All bits set)","Usage","measurementRegister = status.measurement.overvoltage.condition","measurementRegister = status.measurement.overvoltage.enable","measurementRegister = status.measurement.overvoltage.event","measurementRegister = status.measurement.overvoltage.ntr","measurementRegister = status.measurement.overvoltage.ptr","status.measurement.overvoltage.enable = measurementRegister","status.measurement.overvoltage.ntr = measurementRegister","status.measurement.overvoltage.ptr = measurementRegister","measurementRegister","The measurement overvoltage summary register status. A zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 2","Details","These attributes are used to read or write to the measurement event overvoltage summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000 0000 0000 0010. This value indicates that bit B1 (SMUA) is set.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable.","B1","status.measurement.overvoltage.SMUA","Set bit indicates that an overvoltage condition has been detected.","Bit B1 decimal value: 2","Binary value: 0000 0010","B2-B15","Not used","Not applicable.","As an example, to set bit B1 of the measurement event overvoltage summary enable register, set status.measurement.overvoltage.enable = status.measurement.overvoltage.SMUA.","In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B1, set measurementRegister to 2.","Example","status.measurement.overvoltage.enable ="," status.measurement.overvoltage.SMUA","Sets the SMU A bit of the measurement overvoltage summary enable register using a constant.","Also see","Measurement event registers","status.measurement.overvoltage.*","21510.html");
+Page[379]=new Array("This attribute contains the measurement event reading overflow summary register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","2 (All bits set)","Usage","measurementRegister = status.measurement.reading_overflow.condition","measurementRegister = status.measurement.reading_overflow.enable","measurementRegister = status.measurement.reading_overflow.event","measurementRegister = status.measurement.reading_overflow.ntr","measurementRegister = status.measurement.reading_overflow.ptr","status.measurement.reading_overflow.enable = measurementRegister","status.measurement.reading_overflow.ntr = measurementRegister","status.measurement.reading_overflow.ptr = measurementRegister","measurementRegister","The measurement reading overflow summary register status. A zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 2","Details","These attributes are used to read or write to the measurement event reading overflow summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000 0000 0000 0010. This value indicates that bit B1 (SMUA) is set.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable.","B1","status.measurement.reading_overflow.SMUA","Set bit indicates that an overflow reading has been detected.","Bit B1 decimal value: 2","Binary value: 0000 0010","B2-B15","Not used","Not applicable.","As an example, to set bit B1 of the measurement event reading overflow summary enable register, set status.measurement.reading_overflow.enable = status.measurement.reading_overflow.SMUA.","In addition to the above constant, measurementRegister can be set to the numeric equivalent of the bit to set.","Example","status.measurement.reading_overflow.enable ="," status.measurement.reading_overflow.SMUA","Sets the SMU A bit of the measurement reading overflow summary enable register using a constant.","Also see","Measurement event registers","status.measurement.reading_overflow.*","15828.html");
+Page[380]=new Array("This attribute contains the measurement sink limit summary register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","2 (All bits set)","Usage","measurementRegister = status.measurement.sink_limit.condition","measurementRegister = status.measurement.sink_limit.enable","measurementRegister = status.measurement.sink_limit.event","measurementRegister = status.measurement.sink_limit.ntr","measurementRegister = status.measurement.sink_limit.ptr","status.measurement.sink_limit.enable = measurementRegister","status.measurement.sink_limit.ntr = measurementRegister","status.measurement.sink_limit.ptr = measurementRegister","measurementRegister","The measurement sink limit summary register status. A zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 2","Details","These attributes are used to read or write to the measurement event sink limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, assume the value 2 is returned for the enable register. The binary equivalent is 0000 0000 0000 0010. This value indicates that bit B1 (SMUA) is set.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable.","B1","status.measurement.sink_limit.SMUA","Set bit indicates that the sink limit was exceeded.","Bit B1 decimal value: 2","Binary value: 0000 0000 0000 0010","B2-B15","Not used","Not applicable.","As an example, to set bit B1 of the measurement event sink limit summary enable register, set status.measurement.sink_limit.enable = status.measurement.sink_limit.SMUA.","In addition to the above constants, measurementRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B1, set measurementRegister to 2.","Example","status.measurement.sink_limit.enable ="," status.measurement.sink_limit.SMUA","Sets the SMU A bit of the measurement sink limit summary enable register using a constant.","Also see","Measurement event registers","status.measurement.sink_limit.*","21512.html");
+Page[381]=new Array("This attribute contains the measurement event voltage limit summary register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","2 (All bits set)","Usage","measurementRegister = status.measurement.voltage_limit.condition","measurementRegister = status.measurement.voltage_limit.enable","measurementRegister = status.measurement.voltage_limit.event","measurementRegister = status.measurement.voltage_limit.ntr","measurementRegister = status.measurement.voltage_limit.ptr","status.measurement.voltage_limit.enable = measurementRegister","status.measurement.voltage_limit.ntr = measurementRegister","status.measurement.voltage_limit.ptr = measurementRegister","measurementRegister","The measurement voltage limit summary register status. A zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 2","Details","These attributes are used to read or write to the measurement event voltage limit summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable.","B1","status.measurement.voltage_limit.SMUA","Set bit indicates that the voltage limit was exceeded.","Bit B1 decimal value: 2","Binary value: 0000 0010","B2-B15","Not used","Not applicable.","As an example, to set bit B1 of the measurement event voltage limit summary enable register, set status.measurement.voltage_limit.enable = status.measurement.voltage_limit.SMUA.","In addition to the above constant, measurementRegister can be set to the numeric equivalent of the bit to set.","Example","status.measurement.voltage_limit.enable ="," status.measurement.voltage_limit.SMUA","Sets the SMUA bit of the measurement event voltage limit summary enable register using a constant.","Also see","Measurement event registers","status.measurement.voltage_limit.*","15829.html");
+Page[382]=new Array("This attribute stores the system node enable register.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Status reset","Not saved","0","Usage","nodeEnableRegister = status.node_enable","status.node_enable = nodeEnableRegister","nodeEnableRegister","The system node enable register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","Details","This attribute is used to read or write to the system node enable register. Reading the system node enable register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, assume the value of 1.29000e+02 (which is 129) is returned for the system node enable register, the binary equivalent is 1000 0001. This value indicates that bit B0 and bit B7 are set.","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">","**","1","0","0","0","0","0","0","1","* Least significant bit ** Most significant bit"," Assigning a value to this attribute enables one or more status events. When an enabled status event occurs, a summary bit is set in the appropriate system summary register. The register and bit that is set depends on the TSP-Link node number assigned to this instrument.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","status.MEASUREMENT_SUMMARY_BIT status.MSB","Set summary bit indicates that an enabled measurement event has occurred. ","Bit B0 decimal value: 1","B1","Not used","Not applicable.","B2","status.ERROR_AVAILABLE status.EAV","Set summary bit indicates that an error or status message is present in the Error Queue. ","Bit B2 decimal value: 4","B3","status.QUESTIONABLE_SUMMARY_BIT status.QSB","Set summary bit indicates that an enabled questionable event has occurred. ","Bit B3 decimal value: 8","B4","status.MESSAGE_AVAILABLE status.MAV","Set summary bit indicates that a response message is present in the Output Queue. ","Bit B4 decimal value: 16","B5","status.EVENT_SUMMARY_BIT status.ESB","Set summary bit indicates that an enabled standard event has occurred. ","Bit B5 decimal value: 32","B6","status.MASTER_SUMMARY_STATUS status.MSS","Set bit indicates that an enabled Master Summary Status (MSS) bit of the Status Byte Register is set.","Bit B6 decimal value: 64","B7","status.OPERATION_SUMMARY_BIT status.OSB","Set summary bit indicates that an enabled operation event has occurred. ","Bit B7 decimal value: 128","As an example, to set the B0 bit of the system node enable register, set status.node_enable = status.MSB.","In addition to the above values, nodeEnableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set nodeEnableRegister to the sum of their decimal weights. For example, to set bits B0 and B7, set nodeEnableRegister to 129 (1 + 128).","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Example 1","nodeEnableRegister = status.MSB + status.OSB","status.node_enable = nodeEnableRegister","Sets the MSB and OSB bits of the system node enable register using constants.","Example 2","-- decimal 129 = binary 10000001","nodeEnableRegister = 129","status.node_enable = nodeEnableRegister","Sets the MSB and OSB bits of the system node enable register using a decimal value.","Also see","status.condition","status.system.*","Status byte and service request (SRQ)","status.node_enable","15830.html");
+Page[383]=new Array("This attribute stores the status node event register.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not saved","0","Usage","nodeEventRegister = status.node_event","nodeEventRegister","The node event register's status; a zero (0) indicates no bits set; other values indicate various bit settings","Details","This attribute is used to read the status node event register, which is returned as a numeric value (reading this register returns a value). The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000 0001. This value indicates that bit B0 and bit B7 are set.","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">","*","1","0","0","0","0","0","0","1","* Least significant bit ** Most significant bit ","The returned value can indicate one or more status events occurred.","Bit","Value","Description","B0","status.MEASUREMENT_SUMMARY_BIT status.MSB","Set summary bit indicates that an enabled measurement event has occurred. ","Bit B0 decimal value: 1","B1","Not used","Not applicable","B2","status.ERROR_AVAILABLE status.EAV","Set summary bit indicates that an error or status message is present in the Error Queue. ","Bit B2 decimal value: 4","B3","status.QUESTIONABLE_SUMMARY_BIT status.QSB","Set summary bit indicates that an enabled questionable event has occurred. ","Bit B3 decimal value: 8","B4","status.MESSAGE_AVAILABLE status.MAV","Set summary bit indicates that a response message is present in the Output Queue. ","Bit B4 decimal value: 16","B5","status.EVENT_SUMMARY_BIT status.ESB","Set summary bit indicates that an enabled standard event has occurred. ","Bit B5 decimal value: 32","B6","status.MASTER_SUMMARY_STATUS status.MSS","Set bit indicates that an enabled Master Summary Status (MSS) bit of the Status Byte register is set.","Bit B6 decimal value: 64","B7","status.OPERATION_SUMMARY_BIT status.OSB","Set summary bit indicates that an enabled operation event has occurred. ","Bit B7 decimal value: 128","In addition to the above constants, nodeEventRegister can be set to the decimal equivalent of the bit(s) set. When more than one bit of the register is set, nodeEventRegister contains the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Example","nodeEventRegister = status.node_event","print(nodeEventRegister)","Reads the status node event register.","Sample output:","1.29000e+02","Converting this output (129) to its binary equivalent yields 1000 0001 ","Therefore, this output indicates that the set bits of the status byte condition register are presently B0 (MSB) and B7 (OSB).","Also see","status.condition","status.system.*","Status byte and service request (SRQ)","status.node_event","15831.html");
+Page[384]=new Array("These attributes manage the status model's operation status register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","Usage","operationRegister = status.operation.condition","operationRegister = status.operation.enable","operationRegister = status.operation.event","operationRegister = status.operation.ntr","operationRegister = status.operation.ptr","status.operation.enable = operationRegister","status.operation.ntr = operationRegister","status.operation.ptr = operationRegister","operationRegister","The operation status register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","Details","These attributes read or write the operation status registers.","Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.04800e+04 (which is 20,480) is read as the value of the condition register, the binary equivalent is 0101 0000 0000 0000. This value indicates that bit B14 (PROGRAM_RUNNING) and bit B12 (USER) are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","1","0","1","0","0","0","0","0","0","0","0","0","0","0","0","* Least significant bit ** Most significant bit","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","status.operation.CALIBRATING","status.operation.CAL","Set bit indicates that the summary bit of the status.operation.calibrating register has been set.","Bit B0 decimal value: 1","B1-B2","Not used","Not applicable","B3","status.operation.SWEEPING","status.operation.SWE","Set bit indicates that the summary bit from the status.operation.sweeping register is set.","Bit B3 decimal value: 8","B4","status.operation.MEASURING","status.operation.MEAS","Set bit indicates that the summary bit of the status.operation.measuring register is set.","Bit B4 decimal value: 16","B5-B9","Not used","Not applicable","B10","status.operation.TRIGGER_OVERRUN","status.operation.TRGOVR","Set bit indicates that the summary bit from the","status.operation.trigger_overrun register is set.","Bit B10 decimal value: 1024","B11","status.operation.REMOTE_SUMMARY","status.operation.REM","Set bit indicates that the summary bit of the status.operation.remote register is set. ","Bit B11 decimal value: 2048","B12","status.operation.USER","Set bit indicates that the summary bit from the status.operation.user register is set.","Bit B12 decimal value: 4096","B13","status.operation.INSTRUMENT_SUMMARY","status.operation.INST","Set bit indicates that the summary bit from the status.operation.instrument register is set.","Bit B13 decimal value: 8192","B14","status.operation.PROGRAM_RUNNING","status.operation.PROG","Set bit indicates that a command or program is running.","Bit B14 decimal value: 16,384","B15","Not used","Not applicable","As an example, to set bit B12 of the operation status enable register, set status.operation.enable = status.operation.USER.","In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B12 and B14, set operationRegister to 20,480 (which is the sum of 4096 + 16,384). ","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8,192","4,096","2,048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Example 1","operationRegister = status.operation.USER +"," status.operation.PROG","status.operation.enable = operationRegister","Sets the USER and PROG bits of the operation status enable register using constants.","Example 2","-- decimal 20480 = binary 0101 0000 0000 0000","operationRegister = 20480","status.operation.enable = operationRegister","Sets the USER and PROG bits of the operation status enable register using a decimal value.","Also see","Operation Status Registers","status.operation.*","15833.html");
+Page[385]=new Array("This attribute contains the operation status calibration summary register set. ","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","2 (All bits set)","Usage","operationRegister = status.operation.calibrating.condition","operationRegister = status.operation.calibrating.enable","operationRegister = status.operation.calibrating.event","operationRegister = status.operation.calibrating.ntr","operationRegister = status.operation.calibrating.ptr","status.operation.calibrating.enable = operationRegister","status.operation.calibrating.ntr = operationRegister","status.operation.calibrating.ptr = operationRegister ","operationRegister","The operation calibrating event register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 2","Details","These attributes are used to read or write to the operation status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable.","B1","status.operation.calibrating.SMUA","Set bit indicates that SMU A is unlocked for calibration.","Bit B1 decimal value: 2","Binary value: 0000 0010","B2-B15","Not used","Not applicable.","As an example, to set bit B1 of the operation status calibration summary enable register, set status.operation.calibrating.enable = status.operation.calibrating.SMUA.","In addition to the above constant, operationRegister can be set to the decimal equivalent of the bit to set.","Example","status.operation.calibrating.enable ="," status.operation.calibrating.SMUA","Sets the SMUA bit of the operation status calibration summary enable register using a constant.","Also see","Operation Status Registers","status.operation.*","status.operation.calibrating.*","15834.html");
+Page[386]=new Array("This attribute contains the operation status instrument summary register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","31,746 (All bits set)","Usage","operationRegister = status.operation.instrument.condition","operationRegister = status.operation.instrument.enable","operationRegister = status.operation.instrument.event","operationRegister = status.operation.instrument.ntr","operationRegister = status.operation.instrument.ptr","status.operation.instrument.enable = operationRegister","status.operation.instrument.ntr = operationRegister","status.operation.instrument.ptr = operationRegister ","operationRegister","The operation event register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","Details","These attributes are used to read or write to the operation status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000 0100 0000 0010. This value indicates that bit B1 and bit B10 are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","0","0","0","1","0","0","0","0","0","0","0","0","1","0","* Least significant bit ** Most significant bit ","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable.","B1","status.operation.instrument.SMUA","Set bit indicates one or more enabled bits for the operation status SMU A summary register is set.","Bit B1 decimal value: 2","B2-B9","Not used","Not applicable.","B10","status.operation.instrument.TRIGGER_BLENDER","status.operation.instrument.TRGBLND","Set bit indicates one or more enabled bits for the operation status trigger blender summary register is set.","Bit B10 decimal value: 1024.","B11","status.operation.instrument.TRIGGER_TIMER","status.operation.instrument.TRGTMR","Set bit indicates one or more enabled bits for the operation status trigger timer summary register is set.","Bit B11 decimal value: 2048","B12","status.operation.instrument.DIGITAL_IO","status.operation.instrument.DIGIO","Set bit indicates one or more enabled bits for the operation status digital I/O summary register is set.","Bit B12 decimal value: 4096","B13","status.operation.instrument.TSPLINK","Set bit indicates one or more enabled bits for the operation status TSP-Link summary register is set.","Bit B13 decimal value: 8192","B14","status.operation.instrument.LAN","Set bit indicates one or more enabled bits for the operation status LAN summary register is set.","Bit B14 decimal value: 16,384","B15","Not used","Not applicable.","As an example, to set bit B1 of the operation status instrument summary enable register, set status.operation.instrument.enable = status.operation.instrument.SMUA.","In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8192","4096","2048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Example 1","operationRegister = status.operation.instrument.SMUA +"," status.operation.instrument.TRGBLND","status.operation.instrument.enable = operationRegister","Sets bit B1 and bit B10 of the operation status instrument summary enable register using constants.","Example 2","-- 1026 = binary 0000 0100 0000 0010","operationRegister = 1026","status.operation.instrument.enable = operationRegister","Sets bit B1 and bit B10 of the operation status instrument summary enable register using a decimal value.","Also see","status.operation.*","Condition register sets of:","• status.operation.instrument.trigger_blender.*","• status.operation.instrument.trigger_timer.*","• status.operation.instrument.digio.*","• status.operation.instrument.tsplink.*","• status.operation.instrument.lan.*","Operation Status Registers","status.operation.instrument.*","15835.html");
+Page[387]=new Array("This attribute contains the operation status digital I/O summary register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","1024 (All bits set)","Usage","operationRegister = status.operation.instrument.digio.condition","operationRegister = status.operation.instrument.digio.enable","operationRegister = status.operation.instrument.digio.event","operationRegister = status.operation.instrument.digio.ntr","operationRegister = status.operation.instrument.digio.ptr","status.operation.instrument.digio.enable = operationRegister","status.operation.instrument.digio.ntr = operationRegister","status.operation.instrument.digio.ptr = operationRegister ","operationRegister","The operation status digital I/O summary register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024","Details","These attributes are used to read or write to the operation status digital I/O summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0-B9","Not used","Not applicable","B10","status.operation.instrument.digio.TRIGGER_OVERRUN","status.operation.instrument.digio.TRGOVR","Set bit indicates an enabled bit in the Operation Status Digital I/O Overrun Register is set.","Bit B10 decimal value: 1024","Binary value: 0100 0000 0010","B11-B15","Not used","Not applicable","In addition to the above constant, operationRegister can be set to the decimal equivalent of the bit to set.","Example","status.operation.instrument.digio.enable ="," status.operation.instrument.digio.TRGOVR","Sets the TRGOVR bit of the operation status digital I/O summary enable register using a constant.","Also see","Operation Status Registers","status.operation.instrument.digio.trigger_overrun.*","status.operation.instrument.digio.*","15836.html");
+Page[388]=new Array("This attribute contains the operation status digital I/O overrun register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","32,766 (All bits set)","Usage","operationRegister = status.operation.instrument.digio.trigger_overrun.condition","operationRegister = status.operation.instrument.digio.trigger_overrun.enable","operationRegister = status.operation.instrument.digio.trigger_overrun.event","operationRegister = status.operation.instrument.digio.trigger_overrun.ntr","operationRegister = status.operation.instrument.digio.trigger_overrun.ptr","status.operation.instrument.digio.trigger_overrun.enable = operationRegister","status.operation.instrument.digio.trigger_overrun.ntr = operationRegister","status.operation.instrument.digio.trigger_overrun.ptr = operationRegister ","operationRegister","The operation status digio I/O overrun register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","Details","These attributes are used to read or write to the operation status digital I/O overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000 0100 0000 0010. This value indicates that bit b1 and bit B10 are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","0","0","0","1","0","0","0","0","0","0","0","0","1","0","* Least significant bit ** Most significant bit ","A set bit indicates that the specified digital I/O line generated an action overrun when it was triggered to generate an output trigger.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable","B1","status.operation.instrument.digio.trigger_overrun.LINE1","Bit B1 decimal value: 2","B2","status.operation.instrument.digio.trigger_overrun.LINE2","Bit B2 decimal value: 4","B3","status.operation.instrument.digio.trigger_overrun.LINE3","Bit B3 decimal value: 8","B4","status.operation.instrument.digio.trigger_overrun.LINE4","Bit B4 decimal value: 16","B5","status.operation.instrument.digio.trigger_overrun.LINE5","Bit B5 decimal value: 32","B6","status.operation.instrument.digio.trigger_overrun.LINE6","Bit B6 decimal value: 64","B7","status.operation.instrument.digio.trigger_overrun.LINE7","Bit B7 decimal value: 128","B8","status.operation.instrument.digio.trigger_overrun.LINE8","Bit B8 decimal value: 256","B9","status.operation.instrument.digio.trigger_overrun.LINE9","Bit B9 decimal value: 512","B10","status.operation.instrument.digio.trigger_overrun.LINE10","Bit B10 decimal value: 1024","B11","status.operation.instrument.digio.trigger_overrun.LINE11","Bit B11 decimal value: 2048","B12","status.operation.instrument.digio.trigger_overrun.LINE12","Bit B12 decimal value: 4096","B13","status.operation.instrument.digio.trigger_overrun.LINE13","Bit B13 decimal value: 8192","B14","status.operation.instrument.digio.trigger_overrun.LINE14","Bit B14 decimal value: 16,384","B15","Not used","Not applicable","As an example, to set bit B1 of the operation status digital I/O overrun enable register, set status.operation.instrument.digio.trigger_overrun.enable = status.operation.instrument.digio.trigger_overrun.LINE1.","In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8192","4096","2048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Example 1","operationRegister ="," status.operation.instrument.digio.trigger_overrun.LINE1 +"," status.operation.instrument.digio.trigger_overrun.LINE10","status.operation.instrument.digio.trigger_overrun.enable ="," operationRegister","Sets bit B1 and bit B10 of the operation status digital I/O overrun enable register using constants.","Also see","Operation Status Registers","status.operation.instrument.digio.*","status.operation.instrument.digio.trigger_overrun.*","15837.html");
+Page[389]=new Array("This attribute contains the operation status LAN summary register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","1027 (All bits set)","Usage","operationRegister = status.operation.instrument.lan.condition","operationRegister = status.operation.instrument.lan.enable","operationRegister = status.operation.instrument.lan.event","operationRegister = status.operation.instrument.lan.ntr","operationRegister = status.operation.instrument.lan.ptr","status.operation.instrument.lan.enable = operationRegister","status.operation.instrument.lan.ntr = operationRegister","status.operation.instrument.lan.ptr = operationRegister ","operationRegister","The operation status lan summary register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","Details","These attributes are used to read or write to the operation status LAN summary registers. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000 0100 0000 0010. This value indicates that bit B1 and bit B10 are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","0","0","0","1","0","0","0","0","0","0","0","0","1","0","* Least significant bit ** Most significant bit ","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","status.operation.instrument.lan.CONNECTION","status.operation.instrument.lan.CON","Set bit indicates that the LAN cable is connected and a link has been detected.","Bit B0 decimal value: 1","B1","status.operation.instrument.lan.CONFIGURING","status.operation.instrument.lan.CONF","Set bit indicates the LAN is performing its configuration sequence.","Bit B1 decimal value: 2","B2-B9","Not used","Not available","B10","status.operation.instrument.lan.TRIGGER_OVERRUN","status.operation.instrument.lan.TRGOVR","Set bit indicates one or more enabled bits for the operation status LAN trigger overrun register is set.","Bit B10 decimal value: 1024","B11-B15","Not used","Not applicable","As an example, to set bit B0 of the operation status LAN summary enable register, set status.operation.instrument.lan.enable = status.operation.instrument.lan.CON.","In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1,026 (which is the sum of 2 + 1024). ","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8192","4096","2048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Example","operationRegister ="," status.operation.instrument.lan.CONF +"," status.operation.instrument.lan.TRGOVR","status.operation.instrument.lan.enable = operationRegister","Sets bit B1 and bit B10 of the operation status lan summary enable register using constants.","Also see","Operation Status Registers","status.operation.instrument.lan.trigger_overrun.*","status.operation.instrument.lan.*","15838.html");
+Page[390]=new Array("This attribute contains the operation status LAN trigger overrun register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","510 (All bits set)","Usage","operationRegister = status.operation.instrument.lan.trigger_overrun.condition","operationRegister = status.operation.instrument.lan.trigger_overrun.enable","operationRegister = status.operation.instrument.lan.trigger_overrun.event","operationRegister = status.operation.instrument.lan.trigger_overrun.ntr","operationRegister = status.operation.instrument.lan.trigger_overrun.ptr","status.operation.instrument.lan.trigger_overrun.enable = operationRegister","status.operation.instrument.lan.trigger_overrun.ntr = operationRegister","status.operation.instrument.lan.trigger_overrun.ptr = operationRegister ","operationRegister","The operation status lan trigger overrun register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","Details","These attributes are used to read or write to the operation status LAN trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 2.58000e+02 (which is 258) is read as the value of the condition register, the binary equivalent is 0000 0001 0000 0010. This value indicates that bit B1 and bit B8 are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","0","0","0","0","0","1","0","0","0","0","0","0","1","0","* Least significant bit ** Most significant bit ","A set bit indicates that the specified LAN trigger generated an action overrun when triggered to generate a trigger packet.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable","B1","status.operation.instrument.lan.trigger_overrun.LAN1","Bit B1 decimal value: 2","B2","status.operation.instrument.lan.trigger_overrun.LAN2","Bit B2 decimal value: 4","B3","status.operation.instrument.lan.trigger_overrun.LAN3","Bit B3 decimal value: 8","B4","status.operation.instrument.lan.trigger_overrun.LAN4","Bit B4 decimal value: 16","B5","status.operation.instrument.lan.trigger_overrun.LAN5","Bit B5 decimal value: 32","B6","status.operation.instrument.lan.trigger_overrun.LAN6","Bit B6 decimal value: 64","B7","status.operation.instrument.lan.trigger_overrun.LAN7","Bit B7 decimal value: 128","B8","status.operation.instrument.lan.trigger_overrun.LAN8","Bit B8 decimal value: 256","B9-B15","Not used","Not applicable","As an example, to set bit B1 of the operation status LAN trigger overrun enable register, set status.operation.instrument.lan.trigger_overrun.enable = status.operation.instrument.lan.trigger_overrun.LAN1.","In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B8, set operationRegister to 258 (which is the sum of 2 + 256). ","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8192","4096","2048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Example","operationRegister = "," status.operation.instrument.lan.trigger_overrun.LAN1 +"," status.operation.instrument.lan.trigger_overrun.LAN8","status.operation.instrument.lan.trigger_overrun.enable ="," operationRegister","Sets bit B1 and bit B8 of the operation status lan trigger overrun enable register using constants.","Also see","Operation Status Registers","status.operation.instrument.lan.*","status.operation.instrument.lan.trigger_overrun.*","15839.html");
+Page[391]=new Array("This attribute contains the operation status SMU X summary register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","1049 (All bits set)","Usage","operationRegister = status.operation.instrument.smuX.condition","operationRegister = status.operation.instrument.smuX.enable","operationRegister = status.operation.instrument.smuX.event","operationRegister = status.operation.instrument.smuX.ntr","operationRegister = status.operation.instrument.smuX.ptr","status.operation.instrument.smuX.enable = operationRegister","status.operation.instrument.smuX.ntr = operationRegister","status.operation.instrument.smuX.ptr = operationRegister ","operationRegister","The operation status SMU X summary register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","X","Source-measure unit (SMU) channel (for example status.operation.instrument.smua.enable applies to SMU channel A)","Details","These attributes are used to read or write to the operation status SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02500e+02 (which is 1025) is read as the value of the condition register, the binary equivalent is 0000 0100 0000 0010. This value indicates that bit B0 and bit B10 are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","0","0","0","1","0","0","0","0","0","0","0","0","1","0","* Least significant bit ** Most significant bit ","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","status.operation.instrument.smuX.CALIBRATING","status.operation.instrument.smuX.CAL","Set bit indicates that smuX is unlocked for calibration.","Bit B0 decimal value: 1","B1-B2","Not used","Not applicable.","B3","status.operation.instrument.smuX.SWEEPING","status.operation.instrument.smuX.SWE","Set bit indicates that smuX is sweeping.","Bit B3 decimal value: 8","B4","status.operation.instrument.smuX.MEASURING","status.operation.instrument.smuX.MEAS","Bit will be set when taking an overlapped measurement, but it will not set when taking a normal synchronous measurement.","Bit B4 decimal value: 16","B5-B9","Not used","Not applicable.","B10","status.operation.instrument.smuX.TRIGGER_OVERRUN","status.operation.instrument.smuX.TRGOVR","Set bit indicates an enabled bit has been set in the operation status smu X trigger overrun event register.","Bit B10 decimal value: 1024","B11-B15","Not used","Not applicable.","As an example, to set bit B0 of the operation status SMU A summary enable register, set status.operation.instrument.smua.enable = status.operation.instrument.smua.CAL.","In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B0 and B10, set operationRegister to 1025 (which is the sum of 1 + 1024). ","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8192","4096","2048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Example","status.operation.instrument.smua.enable ="," status.operation.instrument.smua.MEAS","Sets the MEAS bit of the operation status SMU A summary enable register using a constant.","Also see","Operation Status Registers","status.operation.instrument.smuX.trigger_overrrun.*","status.operation.instrument.smuX.*","15840.html");
+Page[392]=new Array("This attribute contains the operation status SMU X trigger overrun register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","30 (All bits set)","Usage","operationRegister = status.operation.instrument.smuX.trigger_overrun.condition","operationRegister = status.operation.instrument.smuX.trigger_overrun.enable","operationRegister = status.operation.instrument.smuX.trigger_overrun.event","operationRegister = status.operation.instrument.smuX.trigger_overrun.ntr","operationRegister = status.operation.instrument.smuX.trigger_overrun.ptr","status.operation.instrument.smuX.trigger_overrun.enable = operationRegister","status.operation.instrument.smuX.trigger_overrun.ntr = operationRegister","status.operation.instrument.smuX.trigger_overrun.ptr = operationRegister ","operationRegister","The operation status SMU X trigger overrun register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","Details","These attributes are used to read or write to the operation status SMU X trigger overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000 0001 0010. This value indicates that bit B1 and bit B4 are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","0","0","0","0","0","0","0","0","0","1","0","0","1","0","* Least significant bit ** Most significant bit ","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable.","B1","status.operation.instrument.smuX.trigger_overrun.ARM","Set bit indicates that the arm event detector of the SMU was already in the detected state when a trigger was received.","Bit B1 decimal value: 2","B2","status.operation.instrument.smuX.trigger_overrun.SRC","Set bit indicates that the source event detector of the SMU was already in the detected state when a trigger was received.","Bit B2 decimal value: 4","B3","status.operation.instrument.smuX.trigger_overrun.MEAS","Set bit indicates that the measure event detector of the SMU was already in the detected state when a trigger was received.","Bit B3 decimal value: 8","B4","status.operation.instrument.smuX.trigger_overrun.ENDP","Set bit indicates that the end pulse event detector of the SMU was already in the detected state when a trigger was received.","Bit B4 decimal value: 16","B5-B15","Not used","Not applicable.","As an example, to set bit B1 of the operation status SMU A trigger overrun enable register, set status.operation.instrument.smua.trigger_overrun.enable = status.operation.instrument.smua.trigger_overrun.ARM.","In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8192","4096","2048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Example","status.operation.instrument.smua.trigger_overrun.enable ="," status.operation.instrument.smua.trigger_overrun.ARM","Sets the ARM bit of the operation status SMU A trigger overrun enable register using a constant.","Also see","Operation Status Registers","status.operation.instrument.smuX.*","status.operation.instrument.smuX.trigger_overrrun.*","15841.html");
+Page[393]=new Array("This attribute contains the operation status trigger blender summary register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","1024 (All bits set)","Usage","operationRegister = status.operation.instrument.trigger_blender.condition","operationRegister = status.operation.instrument.trigger_blender.enable","operationRegister = status.operation.instrument.trigger_blender.event","operationRegister = status.operation.instrument.trigger_blender.ntr","operationRegister = status.operation.instrument.trigger_blender.ptr","status.operation.instrument.trigger_blender.enable = operationRegister","status.operation.instrument.trigger_blender.ntr = operationRegister","status.operation.instrument.trigger_blender.ptr = operationRegister ","operationRegister","The operation status trigger blender summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024","Details","These attributes are used to read or write to the operation status trigger blender summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0-B9","Not used","Not applicable.","B10","status.operation.instrument.trigger_blender.TRIGGER_OVERRUN","status.operation.instrument.trigger_blender.TRGOVR","Set bit indicates one or more enabled bits for operation status trigger blender overrun register is set.","Bit B10 decimal value: 1024","Binary value: 0100 0000 0000","B11-B15","Not used","Not applicable.","In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to 1024.","Example","status.operation.instrument.trigger_blender.enable = 1024","Sets the TRGOVR bit of the operation status trigger blender summary enable using a decimal value.","Also see","Operation Status Registers","status.operation.instrument.trigger_blender.trigger_overrun.*","status.operation.instrument.trigger_blender.*","15842.html");
+Page[394]=new Array("This attribute contains the operation status trigger blender overrun register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","30 (All bits set)","Usage","operationRegister = "," status.operation.instrument.trigger_blender.trigger_overrun.condition","operationRegister ="," status.operation.instrument.trigger_blender.trigger_overrun.enable","operationRegister ="," status.operation.instrument.trigger_blender.trigger_overrun.event","operationRegister ="," status.operation.instrument.trigger_blender.trigger_overrun.ntr","operationRegister ="," status.operation.instrument.trigger_blender.trigger_overrun.ptr","status.operation.instrument.trigger_blender.trigger_overrun.enable ="," operationRegister","status.operation.instrument.trigger_blender.trigger_overrun.ntr ="," operationRegister","status.operation.instrument.trigger_blender.trigger_overrun.ptr ="," operationRegister ","operationRegister","The operation status trigger blender overrun register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","Details","These attributes are used to read or write to the operation status trigger blender overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000 0001 0010. This value indicates that bit B1 and bit B4 are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","0","0","0","0","0","0","0","0","0","1","0","0","1","0","* Least significant bit ** Most significant bit ","A set bit value indicates that the specified trigger blender generated an action overrun.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable","B1","status.operation.instrument.trigger_blender.trigger_overrun.BLND1","Bit B1 decimal value: 2","B2","status.operation.instrument.trigger_blender.trigger_overrun.BLND2","Bit B2 decimal value: 4","B3","status.operation.instrument.trigger_blender.trigger_overrun.BLND3","Bit B3 decimal value: 8","B4","status.operation.instrument.trigger_blender.trigger_overrun.BLND4","Bit B4 decimal value: 16","B5-B15","Not used","Not applicable","As an example, to set bit B1 of the operation status trigger blender overrun enable register, set status.operation.instrument.trigger_blender.trigger_overrun.enable = status.operation.instrument.trigger_blender.trigger_overrun.BLND1.","In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8192","4096","2048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Example","status.operation.instrument.trigger_blender.trigger_overrun.enable"," = status.operation.instrument.trigger_blender.trigger_overrun.BLND1","Sets the bit for blender 1 of the operation status trigger blender overrun enable register using a constant.","Also see","Operation Status Registers","status.operation.instrument.trigger_blender.*","status.operation.instrument.trigger_blender.trigger_overrun.*","15843.html");
+Page[395]=new Array("This attribute contains the operation status trigger timer summary register set. ","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","1024 (All bits set)","Usage","operationRegister = status.operation.instrument.trigger_timer.condition","operationRegister = status.operation.instrument.trigger_timer.enable","operationRegister = status.operation.instrument.trigger_timer.event","operationRegister = status.operation.instrument.trigger_timer.ntr","operationRegister = status.operation.instrument.trigger_timer.ptr","status.operation.instrument.trigger_timer.enable = operationRegister","status.operation.instrument.trigger_timer.ntr = operationRegister","status.operation.instrument.trigger_timer.ptr = operationRegister ","operationRegister","The operation status trigger timer summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024","Details","These attributes are used to read or write to the operation status trigger timer summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0-B9","Not used","Not applicable","B10","status.operation.instrument.trigger_timer.TRIGGER_OVERRUN status.operation.instrument.trigger_timer.TRGOVR","Set bit indicates one or more enabled bits for the operation status trigger timer overrun register is set.","Bit B10 decimal value: 1024","Binary value: 0100 0000 0000","B11-B15","Not used","Not applicable","In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to 1024. ","Example","status.operation.instrument.trigger_timer.enable = 1024","Sets the TRGOVR bit of the operation status trigger timer summary enable register using a decimal value.","Also see","Operation Status Registers","status.operation.instrument.trigger_timer.trigger_overrun.*","status.operation.instrument.trigger_timer.*","15844.html");
+Page[396]=new Array("This attribute contains the operation status trigger timer overrun register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","510 (All bits set)","Usage","operationRegister = "," status.operation.instrument.trigger_timer.trigger_overrun.condition","operationRegister = "," status.operation.instrument.trigger_timer.trigger_overrun.enable","operationRegister = "," status.operation.instrument.trigger_timer.trigger_overrun.event","operationRegister = "," status.operation.instrument.trigger_timer.trigger_overrun.ntr","operationRegister = "," status.operation.instrument.trigger_timer.trigger_overrun.ptr","status.operation.instrument.trigger_timer.trigger_overrun.enable = "," operationRegister","status.operation.instrument.trigger_timer.trigger_overrun.ntr = "," operationRegister","status.operation.instrument.trigger_timer.trigger_overrun.ptr = "," operationRegister ","operationRegister","The operation status trigger timer trigger overrun register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","Details","These attributes are used to read or write to the operation status trigger timer overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 18 is read as the value of the condition register, the binary equivalent is 0000 0000 0001 0010. This value indicates that bit B1 and bit B4 are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","0","0","0","0","0","0","0","0","0","1","0","0","1","0","* Least significant bit ** Most significant bit ","A set bit indicates the specified timer generated an action overrun because it was still processing a delay from a previous trigger when a new trigger was received.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable","B1","status.operation.instrument.trigger_timer.trigger_overrun.TMR1","Bit B1 decimal value: 2","B2","status.operation.instrument.trigger_timer.trigger_overrun.TMR2","Bit B2 decimal value: 4","B3","status.operation.instrument.trigger_timer.trigger_overrun.TMR3","Bit B3 decimal value: 8","B4","status.operation.instrument.trigger_timer.trigger_overrun.TMR4","Bit B4 decimal value: 16","B5","status.operation.instrument.trigger_timer.trigger_overrun.TMR5","Bit B5 decimal value: 32","B6","status.operation.instrument.trigger_timer.trigger_overrun.TMR6","Bit B6 decimal value: 64","B7","status.operation.instrument.trigger_timer.trigger_overrun.TMR7","Bit B7 decimal value: 128","B8","status.operation.instrument.trigger_timer.trigger_overrun.TMR8","Bit B8 decimal value: 256","B9-B15","Not used","Not applicable","As an example, to set bit B1 of the operation status trigger timer trigger overrun enable register, set status.operation.instrument.trigger_timer.trigger_overrun.enable = status.operation.instrument.trigger_timer.trigger_overrun.TMR1.","In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set operationRegister to 18 (which is the sum of 2 + 16). ","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8192","4096","2,048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Example","status.operation.instrument.trigger_timer.trigger_overrun.enable ="," status.operation.instrument.trigger_timer.trigger_overrun.TMR3","Sets the timer 3 bit of the operation status trigger timer overrun enable register using a constant.","Also see","Operation Status Registers","status.operation.instrument.trigger_timer.*","status.operation.instrument.trigger_timer.trigger_overrun.*","15845.html");
+Page[397]=new Array("This attribute contains the operation status TSP-Link summary register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","1024 (All bits set)","Usage","operationRegister = status.operation.instrument.tsplink.condition","operationRegister = status.operation.instrument.tsplink.enable","operationRegister = status.operation.instrument.tsplink.event","operationRegister = status.operation.instrument.tsplink.ntr","operationRegister = status.operation.instrument.tsplink.ptr","status.operation.instrument.tsplink.enable = operationRegister","status.operation.instrument.tsplink.ntr = operationRegister","status.operation.instrument.tsplink.ptr = operationRegister ","operationRegister","The operation status TSP-Link summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 1024","Details","These attributes are used to read or write to the operation status TSP-Link summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0-B9","Not used","Not applicable","B10","status.operation.instrument.tsplink.TRIGGER_OVERRUN status.operation.instrument.tsplink.TRGOVR","Set bit indicates one or more enabled bits for the operation status TSP-Link overrun register is set.","Bit B10 decimal value: 1024","Binary value: 0100 0000 0000","B11-B15","Not used","Not applicable","In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. For example, to set bit B10, set operationRegister to 1024. ","Example","status.operation.instrument.tsplink.enable = 1024","Sets the trigger overrun bit of the operation status TSP-Link summary enable register using a decimal value.","Also see","Operation Status Registers","status.operation.instrument.tsplink.trigger_overrun.*","status.operation.instrument.tsplink.*","15846.html");
+Page[398]=new Array("This attribute contains the operation status TSP-Link overrun register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","14 (All bits set)","Usage","operationRegister = "," status.operation.instrument.tsplink.trigger_overrun.condition","operationRegister = status.operation.instrument.tsplink.trigger_overrun.enable","operationRegister = status.operation.instrument.tsplink.trigger_overrun.event","operationRegister = status.operation.instrument.tsplink.trigger_overrun.ntr","operationRegister = status.operation.instrument.tsplink.trigger_overrun.ptr","status.operation.instrument.tsplink.trigger_overrun.enable = operationRegister","status.operation.instrument.tsplink.trigger_overrun.ntr = operationRegister","status.operation.instrument.tsplink.trigger_overrun.ptr = operationRegister ","operationRegister","The operation status TSP-link overrun register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","Details","These attributes are used to read or write to the operation status TSP-link overrun registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 10 is read as the value of the condition register, the binary equivalent is 0000 0000 0000 1010. This value indicates that bit B1 and bit B3 are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","0","0","0","0","0","0","0","0","0","0","1","0","1","0","* Least significant bit ** Most significant bit ","A set bit indicates that the specified line generated an action overrun when triggered to generate an output trigger.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable","B1","status.operation.instrument.tsplink.trigger_overrun.LINE1","Bit B1 decimal value: 2","B2","status.operation.instrument.tsplink.trigger_overrun.LINE2","Bit B2 decimal value: 4","B3","status.operation.instrument.tsplink.trigger_overrun.LINE3","Bit B3 decimal value: 8","B4-B15","Not used","Not applicable","As an example, to set bit B1 of the operation status TSP-Link overrun enable register, set status.operation.instrument.tsplink.trigger_overrun.enable = status.operation.instrument.tsplink.trigger_overrun.LINE1.","In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B3, set operationRegister to 10 (which is the sum of 2 + 8). ","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8192","4096","2048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Example 1","status.operation.instrument.tsplink.trigger_overrun.enable ="," status.operation.instrument.tsplink.trigger_overrun.LINE1","Sets the line 1 bit of the operation status TSP-Link overrun enable register using a constant.","Also see","Operation Status Registers","status.operation.instrument.trigger_timer.*","status.operation.instrument.tsplink.trigger_overrun.*","15847.html");
+Page[399]=new Array("This attribute contains the operation status measuring summary register set. ","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","2 (All bits set)","Usage","operationRegister = status.operation.measuring.condition","operationRegister = status.operation.measuring.enable","operationRegister = status.operation.measuring.event","operationRegister = status.operation.measuring.ntr","operationRegister = status.operation.measuring.ptr","status.operation.measuring.enable = operationRegister","status.operation.measuring.ntr = operationRegister","status.operation.measuring.ptr = operationRegister ","operationRegister","The operation status measuring summary register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than zero (0) is 2","Details","These attributes are used to read or write to the operation status measuring summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable.","B1","status.operation.measuring.SMUA","Bit will be set when taking an overlapped measurement, but it will not set when taking a normal synchronous measurement.","Bit B1 decimal value: 2","Binary value: 0000 0010","B2-B15","Not used","Not applicable.","In addition to the above constant, operationRegister can be set to the decimal equivalent of the bit to set.","Example","status.operation.measuring.enable ="," status.operation.measuring.SMUA","Sets the SMUA bit of the operation status measuring summary enable register using a constant.","Also see","Operation Status Registers","status.operation.*","status.operation.measuring.*","15848.html");
+Page[400]=new Array("This attribute contains the operation status remote summary register set. ","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","2050 (All bits set)","Usage","operationRegister = status.operation.remote.condition","operationRegister = status.operation.remote.enable","operationRegister = status.operation.remote.event","operationRegister = status.operation.remote.ntr","operationRegister = status.operation.remote.ptr","status.operation.remote.enable = operationRegister","status.operation.remote.ntr = operationRegister","status.operation.remote.ptr = operationRegister ","operationRegister","The operation status remote summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","Details","These attributes are used to read or write to the operation status remote summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable.","B1","status.operation.remote.COMMAND_AVAILABLE","status.operation.remote.CAV","Set bit indicates there is a command available in the execution queue.","Bit B1 decimal value: 2","Binary value: 0000 0000 0000 0010","B2-B10","Not used","Not applicable.","B11","status.operation.remote.PROMPTS_ENABLED","status.operation.remote.PRMPT","Set bit indicates command prompts are enabled.","Bit B11 decimal value: 2048","Binary value: 0000 0100 0000 0000","B12-B15","Not used","Not applicable.","As an example, to set bit B1 of the operation status remote summary enable register, set status.operation.remote.enable = status.operation.remote.CAV.","In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B11, set operationRegister to 2050 (which is the sum of 2 + 2048). ","Example","status.operation.remote.enable ="," status.operation.remote.CAV","Sets the CAV bit of the operation status remote summary enable register using a constant.","Also see","Operation Status Registers","status.operation.*","status.operation.remote.*","15849.html");
+Page[401]=new Array("This attribute contains the operation status sweeping summary register set. ","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","2 (All bits set)","Usage","operationRegister = status.operation.sweeping.condition","operationRegister = status.operation.sweeping.enable","operationRegister = status.operation.sweeping.event","operationRegister = status.operation.sweeping.ntr","operationRegister = status.operation.sweeping.ptr","status.operation.sweeping.enable = operationRegister","status.operation.sweeping.ntr = operationRegister","status.operation.sweeping.ptr = operationRegister ","operationRegister","The operation status sweeping summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than zero (0) is 2","Details","These attributes are used to read or write to the operation status sweeping summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable.","B1","status.operation.sweeping.SMUA","Set bit indicates that SMU A is sweeping.","Bit B1 decimal value: 2","Binary value: 0000 0010","B2-B5","Not used","Not applicable.","In addition to the above constant, operationRegister can be set to the decimal equivalent of the bit to set.","Example","status.operation.sweeping.enable ="," status.operation.sweeping.SMUA","Sets the SMUA bit of the operation status sweeping summary enable register using a constant.","Also see","Operation Status Registers","status.operation.*","status.operation.sweeping.*","15850.html");
+Page[402]=new Array("This attribute contains the operation status trigger overrun summary register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","31,746 (All bits set)","Usage","operationRegister = status.operation.trigger_overrun.condition","operationRegister = status.operation.trigger_overrun.enable","operationRegister = status.operation.trigger_overrun.event","operationRegister = status.operation.trigger_overrun.ntr","operationRegister = status.operation.trigger_overrun.ptr","status.operation.trigger_overrun.enable = operationRegister","status.operation.trigger_overrun.ntr = operationRegister","status.operation.trigger_overrun.ptr = operationRegister ","operationRegister","The operation status trigger overrun summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","Details","These attributes are used to read or write to the operation status trigger overrun summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.02600e+03 (which is 1026) is read as the value of the condition register, the binary equivalent is 0000 0100 0000 0010. This value indicates that bit B1 and bit B10 are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","0","0","0","1","0","0","0","0","0","0","0","0","1","0","* Least significant bit ** Most significant bit","The bits in this register summarize events in other registers. A set bit in this summary register indicates that an enabled event in one of the summarized registers is set.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable.","B1","status.operation.trigger_overrun.SMUA","Set bit indicates one of the enabled bits in the operation status SMU A trigger overrun event register is set.","Bit B1 decimal value: 2","B2-B9","Not used","Not applicable.","B10","status.operation.trigger_overrun.TRIGGER_BLENDER","status.operation.trigger_overrun.TRGBLND","Set bit indicates one of the enabled bits in the operation status trigger blender overrun event register is set.","Bit B10 decimal value: 1024","B11","status.operation.trigger_overrun.TRIGGER_TIMER","status.operation.trigger_overrun.TRGTMR","Set bit indicates one of the enabled bits in the operation status trigger timer overrun event register is set.","Bit B11 decimal value: 2048","B12","status.operation.trigger_overrun.DIGITAL_IO","status.operation.trigger_overrun.DIGIO","Set bit indicates one of the enabled bits in the operation status digital I/O overrun event register is set.","Bit B12 decimal value: 4096","B13","status.operation.trigger_overrun.TSPLINK","Set bit indicates one of the enabled bits in the operation status TSP-Link overrun event register is set.","Bit B13 decimal value: 8192","B14","status.operation.trigger_overrun.LAN","Set bit indicates one of the enabled bits in the operation status LAN trigger overrun event register is set.","Bit B14 decimal value: 16,384","B15","Not used","Not applicable.","As an example, to set bit B1 of the operation status trigger overrun summary enable register, set status.operation.trigger_overrun.enable = status.operation.trigger_overrun.SMUA.","In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B1 and B10, set operationRegister to 1026 (which is the sum of 2 + 1024). ","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8192","4096","2048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Example","operationRegister = "," status.operation.trigger_overrun.SMUA +"," status.operation.trigger_overrun.TRGBLND","status.operation.trigger_overrun.enable = operationRegister","Sets bit B1 and bit B10 of the operation status trigger overrun summary enable register using constants.","Also see","Operation Status Registers","status.operation.*","status.operation.trigger_overrun.*","15851.html");
+Page[403]=new Array("These attributes manage the status model's operation status user register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (RW)","Yes","Status reset","Not saved","0",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","32,767 (All bits set)","Usage","operationRegister = status.operation.user.condition","operationRegister = status.operation.user.enable","operationRegister = status.operation.user.event","operationRegister = status.operation.user.ntr","operationRegister = status.operation.user.ptr","status.operation.user.condition = operationRegister","status.operation.user.enable = operationRegister","status.operation.user.ntr = operationRegister","status.operation.user.ptr = operationRegister","operationRegister","The operation status user register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","Details","These attributes are used to read or write to the operation status user registers. Reading a status register returns a value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000 0000 1000 0001. This value indicates that bits B0 and B7 are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","0","0","0","0","0","0","1","0","0","0","0","0","0","1","* Least significant bit ** Most significant bit","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","status.operation.user.BIT0","Bit B0 decimal value: 1","B1","status.operation.user.BIT1","Bit B1 decimal value: 2","B2","status.operation.user.BIT2","Bit B2 decimal value: 4","B3","status.operation.user.BIT3","Bit B3 decimal value: 8","B4","status.operation.user.BIT4","Bit B4 decimal value: 16","B5","status.operation.user.BIT5","Bit B5 decimal value: 32","B6","status.operation.user.BIT6","Bit B6 decimal value: 64","B7","status.operation.user.BIT7","Bit B7 decimal value: 128","B8","status.operation.user.BIT8","Bit B8 decimal value: 256","B9","status.operation.user.BIT9","Bit B9 decimal value: 512","B10","status.operation.user.BIT10","Bit B10 decimal value: 1024","B11","status.operation.user.BIT11","Bit B11 decimal value: 2048","B12","status.operation.user.BIT12","Bit B12 decimal value: 4096","B13","status.operation.user.BIT13","Bit B13 decimal value: 8192","B14","status.operation.user.BIT14","Bit B14 decimal value: 16,384","B15","Not used","Not applicable","As an example, to set bit B0 of the operation status user enable register, set status.operation.user.enable = status.operation.user.BIT0.","In addition to the above constants, operationRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set operationRegister to the sum of their decimal weights. For example, to set bits B11 and B14, set operationRegister to 18,432 (which is the sum of 2048 + 16,384). ","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8192","4096","2048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Example 1","operationRegister = status.operation.user.BIT11 +"," status.operation.user.BIT14","status.operation.user.enable = operationRegister","Sets bits B11 and B14 of the operation status user enable register using constants.","Example 2","-- 18432 = binary 0100 1000 0000 0000","operationRegister = 18432","status.operation.enable = operationRegister","Sets bits B11 and B14 of the operation status user enable register using a decimal value.","Also see","status.operation.*","Operation Status Register","status.operation.user.*","15852.html");
+Page[404]=new Array("These attributes manage the status model's questionable status register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","13,056 (All bits set)","Usage","quesRegister = status.questionable.condition","quesRegister = status.questionable.enable","quesRegister = status.questionable.event","quesRegister = status.questionable.ntr","quesRegister = status.questionable.ptr","status.questionable.enable = quesRegister","status.questionable.ntr = quesRegister","status.questionable.ptr = quesRegister","quesRegister","The questionable status register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","Details","These attributes are used to read or write to the questionable status registers. Reading a status register returns a value. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.22880e+04 (which is 12,288) is read as the value of the condition register, the binary equivalent is 0011 0000 0000 0000. This value indicates that bits B12 and B13 are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","1","1","0","0","0","0","0","0","0","0","0","0","0","0","* Least significant bit ** Most significant bit ","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0-B7","Not used","Not available","B8","status.questionable.CALIBRATION status.questionable.CAL","An enabled bit in the questionable status calibration summary event register is set.","Bit B6 decimal value:256","B9","status.questionable.UNSTABLE_OUTPUT status.questionable.UO","An enabled bit in the questionable status unstable output summary event register is set.","Bit B9 decimal value: 512","B10-B11","Not used","Not available","B12","status.questionable.OVER_TEMPERATURE status.questionable.OTEMP","An enabled bit in the questionable status over temperature summary event register is set.","Bit B12 decimal value: 4096","B13","status.questionable.INSTRUMENT_SUMMARY status.questionable.INST","An enabled bit in the questionable status instrument summary event register is set.","Bit B13 decimal value: 8192","B14-B15","Not used","Not available","As an example, to set bit B9 of the questionable status enable register, set status.questionable.enable = status.questionable.UO.","In addition to the above constants, quesRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set quesRegister to the sum of their decimal weights. For example, to set bits B12 and B13, set quesRegister to 12,288 (which is the sum of 4096 + 8192). ","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8,192","4,096","2,048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Also see","Questionable Status Registers","status.questionable.*","15853.html");
+Page[405]=new Array("This attribute contains the questionable status calibration summary register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","2 (All bits set)","Usage","questionableRegister = status.questionable.calibration.condition","questionableRegister = status.questionable.calibration.enable","questionableRegister = status.questionable.calibration.event","questionableRegister = status.questionable.calibration.ntr","questionableRegister = status.questionable.calibration.ptr","status.questionable.calibration.enable = questionableRegister","status.questionable.calibration.ntr = questionableRegister","status.questionable.calibration.ptr = questionableRegister ","questionableRegister","The questionable status calibration summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than zero (0) is 2","Details","These attributes are used to read or write to the questionable status calibration summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. ","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable.","B1","status.questionable.calibration.SMUA","Set bit indicates that the calibration constants stored in nonvolatile memory were corrupted and could not be loaded when the instrument powered up.","Bit B1 decimal value: 2","Binary value: 0000 0010","B2 to B15","Not used","Not applicable.","In addition to the above constant, questionableRegister can be set to the decimal equivalent of the bit to set.","Example","status.questionable.calibration.enable ="," status.questionable.calibration.SMUA","Sets the SMUA bit of the questionable status calibration summary enable register using a constant.","Also see","Questionable Status Registers","status.questionable.*","status.questionable.calibration.*","15854.html");
+Page[406]=new Array("This attribute contains the questionable status instrument summary register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","2 (All bits set)","Usage","questionableRegister = status.questionable.instrument.condition","questionableRegister = status.questionable.instrument.enable","questionableRegister = status.questionable.instrument.event","questionableRegister = status.questionable.instrument.ntr","questionableRegister = status.questionable.instrument.ptr","status.questionable.instrument.enable = questionableRegister","status.questionable.instrument.ntr = questionableRegister","status.questionable.instrument.ptr = questionableRegister ","questionableRegister","The questionable status instrument summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 2","Details","These attributes are used to read or write to the questionable status instrument summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable","B1","status.questionable.instrument.SMUA","Set bit indicates one or more enabled bits in the questionable status SMU A summary event register are set.","Bit B1 decimal value: 2","Binary value: 0000 0010","B2 to B15","Not used","Not applicable.","In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. ","Example","status.questionable.instrument.enable ="," status.questionable.instrument.SMUA","Sets the SMUA bit of the questionable status instrument summary enable register using a constant.","Also see","Questionable Status Registers","status.questionable.*","status.questionable.instrument.*","15855.html");
+Page[407]=new Array("This attribute contains the questionable status SMU X summary register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","4864 (All bits set)","Usage","questionableRegister = status.questionable.instrument.smuX.condition","questionableRegister = status.questionable.instrument.smuX.enable","questionableRegister = status.questionable.instrument.smuX.event","questionableRegister = status.questionable.instrument.smuX.ntr","questionableRegister = status.questionable.instrument.smuX.ptr","status.questionable.instrument.smuX.enable = questionableRegister","status.questionable.instrument.smuX.ntr = questionableRegister","status.questionable.instrument.smuX.ptr = questionableRegister ","questionableRegister","The questionable status SMU X summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","X","Source-measure unit (SMU) channel (for example status.questionable.instrument.smua.enable applies to SMU channel A)","Details","These attributes are used to read or write to the questionable status instrument SMU X summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 7.68000e+02 (which is 768) is read as the value of the condition register, the binary equivalent is 0000 0011 0000 0000. This value indicates that bit B8 and bit B9 are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","0","0","0","0","1","1","0","0","0","0","0","0","0","0","* Least significant bit ** Most significant bit ","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0-B7","Not used","Not applicable.","B8","status.questionable.instrument.smuX.CALIBRATION status.questionable.instrument.smuX.CAL","Set bit indicates that the calibration constants stored in nonvolatile memory were corrupted and could not be loaded when the instrument powered up.","Bit B8 decimal value: 256","B9","status.questionable.instrument.smuX.UNSTABLE_OUTPUT status.questionable.instrument.smuX.UO","Set bit indicates that an unstable output condition was detected.","Bit B9 decimal value: 512","B10-B11","Not used","Not applicable","B12","status.questionable.instrument.smuX.OVER_TEMPERATURE status.questionable.instrument.smuX.OTEMP","Set bit indicates that an over temperature condition was detected.","Bit B12 decimal value: 4096","B13-B15","Not used","Not applicable.","As an example, to set bit B8 of the questionable status SMU A summary enable register, set status.questionable.instrument.smua.enable = status.questionable.instrument.smua.CAL.","In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set questionableRegister to the sum of their decimal weights. For example, to set bits B8 and B9, set questionableRegister to 768 (which is the sum of 256 + 512). ","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8192","4096","2048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Example","questionableRegister = "," status.questionable.instrument.smua.CAL +"," status.questionable.instrument.smua.UO","status.questionable.instrument.smua.enable ="," questionableRegister","Sets bit B8 and bit B9 of the questionable status SMU A summary enable register using constants.","Also see","Questionable Status Registers","status.operation.*","status.questionable.instrument.smuX.*","15856.html");
+Page[408]=new Array("This attribute contains the questionable status over temperature summary register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","2 (All bits set)","Usage","questionableRegister = status.questionable.over_temperature.condition","questionableRegister = status.questionable.over_temperature.enable","questionableRegister = status.questionable.over_temperature.event","questionableRegister = status.questionable.over_temperature.ntr","questionableRegister = status.questionable.over_temperature.ptr","status.questionable.over_temperature.enable = questionableRegister","status.questionable.over_temperature.ntr = questionableRegister","status.questionable.over_temperature.ptr = questionableRegister ","operationRegister","The questionable status over temperature summary register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 2","Details","These attributes are used to read or write to the questionable status over temperature summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable.","B1","status.questionable.over_temperature.SMUA","Set bit indicates that an over temperature indication was detected.","Bit B1 decimal value: 2","Binary value: 0000 0010","B2-B15","Not used","Not applicable.","In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. ","Example","status.questionable.over_temperature.enable ="," status.questionable.over_temperature.SMUA","Sets the SMU A bit in the questionable status over temperature summary enable register using a constant.","Also see","Questionable Status Registers","status.questionable.*","status.questionable.over_temperature.*","15857.html");
+Page[409]=new Array("This attribute contains the questionable status unstable output summary register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","2 (All bits set)","Usage","questionableRegister = status.questionable.unstable_output.condition","questionableRegister = status.questionable.unstable_output.enable","questionableRegister = status.questionable.unstable_output.event","questionableRegister = status.questionable.unstable_output.ntr","questionableRegister = status.questionable.unstable_output.ptr","status.questionable.unstable_output.enable = questionableRegister","status.questionable.unstable_output.ntr = questionableRegister","status.questionable.unstable_output.ptr = questionableRegister ","operationRegister","The questionable status unstable output summary register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); the only valid value other than 0 is 2","Details","These attributes are used to read or write to the questionable status unstable output summary registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable.","B1","status.questionable.unstable_output.SMUA","Set bit indicates that an unstable output condition was detected.","Bit B1 decimal value: 2","Binary value: 0000 0010","B2-B15","Not used","Not applicable.","In addition to the above constants, questionableRegister can be set to the numeric equivalent of the bit to set. ","Example","status.questionable.unstable_output.enable ="," status.questionable.unstable_output.SMUA","Sets the SMU A bit in the questionable status unstable output summary enable register bit using a constant.","Also see","Questionable Status Registers","status.questionable.*","status.questionable.unstable_output.*","15858.html");
+Page[410]=new Array("This attribute stores the service request (SRQ) enable register.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Status reset","Not saved","0","Usage","requestSRQEnableRegister = status.request_enable","status.request_enable = requestSRQEnableRegister","requestSRQEnableRegister","The service request (SRQ) enable register's status. A zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","Details","This attribute is used to read or write to the service request enable register. Reading the service request enable register returns a value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000 0001. This value indicates that bit B0 and bit B7 are set.","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">","*","1","0","0","0","0","0","0","1","* Least significant bit ** Most significant bit ","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","status.MEASUREMENT_SUMMARY_BIT","status.MSB","Set summary bit indicates that an enabled event in the Measurement Event Register has occurred.","Bit B0 decimal value: 1","B1","status.SYSTEM_SUMMARY_BIT","status.SSB","Set summary bit indicates that an enabled event in the System Summary Register has occurred.","Bit B1 decimal value: 2","B2","status.ERROR_AVAILABLE","status.EAV","Set summary bit indicates that an error or status message is present in the Error Queue.","Bit B2 decimal value: 4","B3","status.QUESTIONABLE_SUMMARY_BIT","status.QSB","Set summary bit indicates that an enabled event in the Questionable Status Register has occurred.","Bit B3 decimal value: 8","B4","status.MESSAGE_AVAILABLE","status.MAV","Set summary bit indicates that a response message is present in the Output Queue.","Bit B4 decimal value: 16","B5","status.EVENT_SUMMARY_BIT","status.ESB","Set summary bit indicates that an enabled event in the Standard Event Status Register has occurred.","Bit B5 decimal value: 32","B6","Not used","Not applicable","B7","status.OPERATION_SUMMARY_BIT","status.OSB","Set summary bit indicates that an enabled event in the Operation Status Register has occurred.","Bit B7 decimal value: 128","As an example, to set bit B0 of the service request enable register, set status.request_enable = status.MSB.","In addition to the above values, requestSRQEnableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set requestSRQEnableRegister to the sum of their decimal weights. For example, to set bits B0 and B7, set requestSRQEnableRegister to 129 (1 + 128).","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Example 1","requestSRQEnableRegister = status.MSB + status.OSB","status.request_enable = requestSRQEnableRegister","Sets the MSB and OSB bits of the service request (SRQ) enable register using constants.","Example 2","-- decimal 129 = binary 10000001","requestSRQEnableRegister = 129","status.request_enable = requestSRQEnableRegister","Sets the MSB and OSB bits of the service request (SRQ) enable register using a decimal value.","Also see","status.condition","status.system.*","Status byte and service request (SRQ)","status.request_enable","17593.html");
+Page[411]=new Array("This attribute stores the service request (SRQ) event register.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not saved","0","Usage","requestSRQEventRegister = status.request_event","requestSRQEventRegister","The request event register's status; a zero (0) indicates no bits set; other values indicate various bit settings","Details","This attribute is used to read the service request event register, which is returned as a numeric value. Reading this register returns a value. The binary equivalent of the value of this attribute indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B7. For example, if a value of 1.29000e+02 (which is 129) is read as the value of this register, the binary equivalent is 1000 0001. This value indicates that bit B0 and bit B7 are set.","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">","*","1","0","0","0","0","0","0","1","* Least significant bit ** Most significant bit ","The returned value can indicate one or more status events occurred.","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","status.MEASUREMENT_SUMMARY_BIT","status.MSB","Set summary bit indicates that an enabled event in the Measurement Event Register has occurred.","Bit B0 decimal value: 1","B1","status.SYSTEM_SUMMARY_BIT","status.SSB","Set summary bit indicates that an enabled event in the System Summary Register has occurred.","Bit B1 decimal value: 2","B2","status.ERROR_AVAILABLE","status.EAV","Set summary bit indicates that an error or status message is present in the Error Queue.","Bit B2 decimal value: 4","B3","status.QUESTIONABLE_SUMMARY_BIT","status.QSB","Set summary bit indicates that an enabled event in the Questionable Status Register has occurred.","Bit B3 decimal value: 8","B4","status.MESSAGE_AVAILABLE","status.MAV","Set summary bit indicates that a response message is present in the Output Queue.","Bit B4 decimal value: 16","B5","status.EVENT_SUMMARY_BIT","status.ESB","Set summary bit indicates that an enabled event in the Standard Event Status Register has occurred.","Bit B5 decimal value: 32","B6","Not used","Not applicable","B7","status.OPERATION_SUMMARY_BIT","status.OSB","Set summary bit indicates that an enabled event in the Operation Status Register has occurred.","Bit B7 decimal value: 128","In addition to the above constants, requestEventRegister can be set to the decimal equivalent of the bit(s) set. When more than one bit of the register is set, requestEventRegister contains the sum of their decimal weights. For example, if 129 is returned, bits B0 and B7 are set (1 + 128).","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Example","requestEventRegister = status.request_event","print(requestEventRegister)","Reads the status request event register.","Sample output: 1.29000e+02","Converting this output (129) to its binary equivalent yields: 1000 0001 ","Therefore, this output indicates that the set bits of the status request event register are presently B0 (MSB) and B7 (OSB).","Also see","status.condition","status.system.*","Status byte and service request (SRQ)","status.request_event","17594.html");
+Page[412]=new Array("This function resets all bits in the system status model.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","status.reset()","Details","This function clears all status data structure registers (enable, event, NTR, and PTR) to their default values. For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers.","Example","status.reset()","Resets the instrument status model.","Also see","Status model","status.reset()","15861.html");
+Page[413]=new Array("These attributes manage the status model's standard event status register set.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","253 (All bits set)","Usage","standardRegister = status.standard.condition","standardRegister = status.standard.enable","standardRegister = status.standard.event","standardRegister = status.standard.ntr","standardRegister = status.standard.ptr","status.standard.enable = standardRegister","status.standard.ntr = standardRegister","status.standard.ptr = standardRegister","standardRegister","The standard event status register's status; a zero (0) indicates no bits set (also send 0 to clear all bits); other values indicate various bit settings","Details","These attributes are used to read or write to the standard event status registers. Reading a status register returns a value. The binary equivalent of the returned value indicates which register bits are set. The least significant bit of the binary number is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000 0000 1000 0001. This value indicates that bit B0 and bit B7 are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","0","0","0","0","0","0","1","0","0","0","0","0","0","1","* Least significant bit ** Most significant bit ","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","status.standard.OPERATION_COMPLETE status.standard.OPC","Set bit indicates that all pending selected instrument operations are completed and the instrument is ready to accept new commands. The bit is set in response to an *OPC command. The opc() function can be used in place of the *OPC command.","Bit B0 decimal value: 1","B1","Not used","Not applicable","B2","status.standard.QUERY_ERROR status.standard.QYE","Set bit indicates that you attempted to read data from an empty Output Queue.","Bit B2 decimal value: 4","B3","status.standard.DEVICE_DEPENDENT_ERROR status.standard.DDE","Set bit indicates that an instrument operation did not execute properly due to some internal condition. ","Bit B3 decimal value: 8","B4","status.standard.EXECUTION_ERROR status.standard.EXE","Set bit indicates that the instrument detected an error while trying to execute a command.","Bit B4 decimal value: 16","B5","status.standard.COMMAND_ERROR status.standard.CME","Set bit indicates that a command error has occurred. Command errors include:","IEEE Std 488.2 syntax error: Instrument received a message that does not follow the defined syntax of the IEEE Std 488.2 standard.","Semantic error: Instrument received a command that was misspelled or received an optional IEEE Std 488.2 command that is not implemented.","GET error: The instrument received a Group Execute Trigger (GET) inside a program message.","Bit B5 decimal value: 32","B6","status.standard.USER_REQUEST status.standard.URQ","Set bit indicates that the LOCAL key on the instrument front panel was pressed.","Bit B6 decimal value: 64","B7","status.standard.POWER_ON status.standard.PON","Set bit indicates that the instrument has been turned off and turned back on since the last time this register has been read.","Bit B7 decimal value: 128","B8-B15","Not used","Not applicable","As an example, to set bit B0 of the standard event status enable register, set status.standard.enable = status.standard.OPC.","In addition to the above constants, standardRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set standardRegister to the sum of their decimal weights. For example, to set bits B0 and B4, set standardRegister to 17 (which is the sum of 1 + 16).","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Example 1","standardRegister = status.standard.OPC"," + status.standard.EXE","status.standard.enable = standardRegister","Sets the OPC and EXE bits of the standard event status enable register using constants.","Example 2","-- decimal 17 = binary 0001 0001","standardRegister = 17","status.standard.enable = standardRegister","Sets the OPC and EXE bits of the standard event status enable register using a decimal value.","Also see","Standard Event Register ","status.standard.*","15862.html");
+Page[414]=new Array("These attributes manage the status model's TSP-Link® system summary register for nodes 1 through 14.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","32,767 (All bits set)","Usage","enableRegister = status.system.condition","enableRegister = status.system.enable","enableRegister = status.system.event","enableRegister = status.system.ntr","enableRegister = status.system.ptr","status.system.enable = enableRegister","status.system.ntr = enableRegister","status.system.ptr = enableRegister","enableRegister","The system summary register's status; a zero (0) indicates no bits set; other values indicate various bit settings","Details","In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000 0000 1000 0001. This value indicates that bit B0 and bit B7 are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","0","0","0","0","0","0","1","0","0","0","0","0","0","1","* Least significant bit ** Most significant bit ","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","status.system.EXTENSION_BIT status.system.EXT","Bit B0 decimal value: 1","B1","status.system.NODE1","Bit B1 decimal value: 2","B2","status.system.NODE2","Bit B2 decimal value: 4","B3","status.system.NODE3","Bit B3 decimal value: 8","B4","status.system.NODE4","Bit B4 decimal value: 16","B5","status.system.NODE5","Bit B5 decimal value: 32","B6","status.system.NODE6","Bit B6 decimal value: 64","B7","status.system.NODE7","Bit B7 decimal value: 128","B8","status.system.NODE8","Bit B8 decimal value: 256","B9","status.system.NODE9","Bit B9 decimal value: 512","B10","status.system.NODE10","Bit B10 decimal value: 1024","B11","status.system.NODE11","Bit B11 decimal value: 2048","B12","status.system.NODE12","Bit B12 decimal value: 4096","B13","status.system.NODE13","Bit B13 decimal value: 8192","B14","status.system.NODE14","Bit B14 decimal value: 16384","B15","Not used","Not applicable","As an example, to set bit B0 of the system summary status enable register, set status.system.enable = status.system.enable.EXT.","In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2048 + 16,384). ","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8,192","4,096","2,048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Example 1","enableRegister = status.system.NODE11 +"," status.system.NODE14","status.system.enable = enableRegister","Sets bits B11 and B14 of the system summary enable register using constants.","Example 2","-- decimal 18432 = binary 0100 1000 0000 0000","enableRegister = 18432","status.system.enable = enableRegister","Sets bits B11 and B14 of the system summary enable register using a decimal value.","Also see","status.system2.*","System summary and standard event registers","status.system.*","15863.html");
+Page[415]=new Array("These attributes manage the status model's TSP-Link® system summary register for nodes 15 through 28.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","32,767 (All bits set)","Usage","enableRegister = status.system2.condition","enableRegister = status.system2.enable","enableRegister = status.system2.event","enableRegister = status.system2.ntr","enableRegister = status.system2.ptr","status.system2.enable = enableRegister","status.system2.ntr = enableRegister","status.system2.ptr = enableRegister","enableRegister","The system summary 2 register's status; a zero (0) indicates no bits set; other values indicate various bit settings","Details","In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000 0000 1000 0001. This value indicates that bit B0 and bit B7 are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","0","0","0","0","0","0","1","0","0","0","0","0","0","1","* Least significant bit ** Most significant bit ","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","status.system2.EXTENSION_BIT status.system2.EXT","Bit B0 decimal value: 1","B1","status.system2.NODE15","Bit B1 decimal value: 2","B2","status.system2.NODE16","Bit B2 decimal value: 4","B3","status.system2.NODE17","Bit B3 decimal value: 8","B4","status.system2.NODE18","Bit B4 decimal value: 16","B5","status.system2.NODE19","Bit B5 decimal value: 32","B6","status.system2.NODE20","Bit B6 decimal value: 64","B7","status.system2.NODE21","Bit B7 decimal value: 128","B8","status.system2.NODE22","Bit B8 decimal value: 256","B9","status.system2.NODE23","Bit B9 decimal value: 512","B10","status.system2.NODE24","Bit B10 decimal value: 1024","B11","status.system2.NODE25","Bit B11 decimal value: 2048","B12","status.system2.NODE26","Bit B12 decimal value: 4096","B13","status.system2.NODE27","Bit B13 decimal value: 8192","B14","status.system2.NODE28","Bit B14 decimal value: 16,384","B15","Not used","Not applicable","As an example, to set bit B0 of the system summary 2 enable register, set status.system2.enable = status.system2.EXT.","In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2048 + 16,384). ","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8,192","4,096","2,048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Example 1","enableRegister = status.system2.NODE25 +"," status.system2.NODE28","status.system2.enable = enableRegister ","Sets bits B11 and B14 of the system summary 2 enable register using constants.","Example 2","-- decimal 18432 = binary 0100 1000 0000 0000","enableRegister = 18432","status.system2.enable = enableRegister","Sets bits B11 and B14 of the system summary 2 enable register using a decimal value.","Also see","status.system.*","status.system3.*","System summary and standard event registers","status.system2.*","15864.html");
+Page[416]=new Array("These attributes manage the status model's TSP-Link® system summary register for nodes 29 through 42.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","32,767 (All bits set)","Usage","enableRegister = status.system3.condition","enableRegister = status.system3.enable","enableRegister = status.system3.event","enableRegister = status.system3.ntr","enableRegister = status.system3.ptr","status.system3.enable = enableRegister","status.system3.ntr = enableRegister","status.system3.ptr = enableRegister","enableRegister","The system summary 3 register's status; a zero (0) indicates no bits set; other values indicate various bit settings","Details","In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000 0000 1000 0001. This value indicates that bit B0 and bit B7 are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","0","0","0","0","0","0","1","0","0","0","0","0","0","1","* Least significant bit ** Most significant bit ","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","status.system3.EXTENSION_BIT status.system3.EXT","Bit B0 decimal value: 1","B1","status.system3.NODE29","Bit B1 decimal value: 2","B2","status.system3.NODE30","Bit B2 decimal value: 4","B3","status.system3.NODE31","Bit B3 decimal value: 8","B4","status.system3.NODE32","Bit B4 decimal value: 16","B5","status.system3.NODE33","Bit B5 decimal value: 32","B6","status.system3.NODE34","Bit B6 decimal value: 64","B7","status.system3.NODE35","Bit B7 decimal value: 128","B8","status.system3.NODE36","Bit B8 decimal value: 256","B9","status.system3.NODE37","Bit B9 decimal value: 512","B10","status.system3.NODE38","Bit B10 decimal value: 1024","B11","status.system3.NODE39","Bit B11 decimal value: 2048","B12","status.system3.NODE40","Bit B12 decimal value: 4096","B13","status.system3.NODE41","Bit B13 decimal value: 8192","B14","status.system3.NODE42","Bit B14 decimal value: 16,384","B15","Not used","Not applicable","As an example, to set bit B0 of the system summary 3 enable register, set status.system3.enable = status.system3.EXT.","In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2048 + 16,384). ","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8,192","4,096","2,048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Example 1","enableRegister = status.system3.NODE39 +"," status.system3.NODE42","status.system3.enable = enableRegister ","Sets bits B11 and B14 of the system summary 3 enable register using constants.","Example 2","-- decimal 18432 = binary 0100 1000 0000 0000","enableRegister = 18432","status.system3.enable = enableRegister","Sets bits B11 and B14 of the system summary 3 enable register using a decimal value.","Also see","status.system2.*","status.system4.*","System summary and standard event registers","status.system3.*","15865.html");
+Page[417]=new Array("These attributes manage the status model's TSP-Link® system summary register for nodes 43 through 56.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","32,767 (All bits set)","Usage","enableRegister = status.system4.condition","enableRegister = status.system4.enable","enableRegister = status.system4.event","enableRegister = status.system4.ntr","enableRegister = status.system4.ptr","status.system4.enable = enableRegister","status.system4.ntr = enableRegister","status.system4.ptr = enableRegister","enableRegister","The system summary 4 register's status; a zero (0) indicates no bits set; other values indicate various bit settings","Details","In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.29000e+02 (which is 129) is read as the value of the condition register, the binary equivalent is 0000 0000 1000 0001. This value indicates that bit B0 and bit B7 are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","0","0","0","0","0","0","1","0","0","0","0","0","0","1","* Least significant bit ** Most significant bit ","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","status.system4.EXTENSION_BIT status.system4.EXT","Bit B0 decimal value: 1","B1","status.system4.NODE43","Bit B1 decimal value: 2","B2","status.system4.NODE44","Bit B2 decimal value: 4","B3","status.system4.NODE45","Bit B3 decimal value: 8","B4","status.system4.NODE46","Bit B4 decimal value: 16","B5","status.system4.NODE47","Bit B5 decimal value: 32","B6","status.system4.NODE48","Bit B6 decimal value: 64","B7","status.system4.NODE49","Bit B7 decimal value: 128","B8","status.system4.NODE50","Bit B8 decimal value: 256","B9","status.system4.NODE51","Bit B9 decimal value: 512","B10","status.system4.NODE52","Bit B10 decimal value: 1024","B11","status.system4.NODE53","Bit B11 decimal value: 2048","B12","status.system4.NODE54","Bit B12 decimal value: 4096","B13","status.system4.NODE55","Bit B13 decimal value: 8192","B14","status.system4.NODE56","Bit B14 decimal value: 16,384","B15","Not used","Not applicable","As an example, to set bit B0 of the system summary 4 enable register, set status.system4.enable = status.system4.enable.EXT.","In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B11 and B14, set enableRegister to 18,432 (which is the sum of 2048 + 16,384). ","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8,192","4,096","2,048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Example 1","enableRegister = status.system4.NODE53 +"," status.system4.NODE56","status.system2.enable = enableRegister ","Sets bit B11 and bit B14 of the system summary 4 enable register using constants.","Example 2","-- decimal 18432 = binary 0100 1000 0000 0000","enableRegister = 18432","status.system4.enable = enableRegister","Sets bit B11 and bit B14 of the system summary 4 enable register using a decimal value.","Also see","status.system3.*","status.system5.*","System summary and standard event registers","status.system4.*","15866.html");
+Page[418]=new Array("These attributes manage the status model's TSP-Link® system summary register for nodes 57 through 64.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute","- -","- -","- -","- -",".condition (R)","Yes","Not applicable","Not saved","Not applicable",".enable (RW)","Yes","Status reset","Not saved","0",".event (R)","Yes","Status reset","Not saved","0",".ntr (RW)","Yes","Status reset","Not saved","0",".ptr (RW)","Yes","Status reset","Not saved","510 (All bits set)","Usage","enableRegister = status.system5.condition","enableRegister = status.system5.enable","enableRegister = status.system5.event","enableRegister = status.system5.ntr","enableRegister = status.system5.ptr","status.system5.enable = enableRegister","status.system5.ntr = enableRegister","status.system5.ptr = enableRegister","enableRegister","The system summary 5 register's status; a zero (0) indicates no bits set; other values indicate various bit settings","Details","In an expanded system (TSP-Link), these attributes are used to read or write to the system summary registers. They are set using a constant or a numeric value, but are returned as a numeric value. The binary equivalent of the value indicates which register bits are set. In the binary equivalent, the least significant bit is bit B0, and the most significant bit is bit B15. For example, if a value of 1.30000e+02 (which is 130) is read as the value of the condition register, the binary equivalent is 0000 0000 1000 0010. This value indicates that bit B1 and bit B7 are set.","B15","B14","B13","B12","B11","B10","B9","B8","B7","B6","B5","B4","B3","B2","B1","B0","**",">",">",">",">",">",">",">",">",">",">",">",">",">",">","*","0","0","0","0","0","0","0","0","1","0","0","0","0","0","1","0","* Least significant bit ** Most significant bit ","For information about .condition, .enable, .event, .ntr, and .ptr registers, refer to Status register set contents and Enable and transition registers. The individual bits of this register are defined in the following table.","Bit","Value","Description","B0","Not used","Not applicable","B1","status.system5.NODE57","Bit B1 decimal value: 2","B2","status.system5.NODE58","Bit B2 decimal value: 4","B3","status.system5.NODE59","Bit B3 decimal value: 8","B4","status.system5.NODE60","Bit B4 decimal value: 16","B5","status.system5.NODE61","Bit B5 decimal value: 32","B6","status.system5.NODE62","Bit B6 decimal value: 64","B7","status.system5.NODE63","Bit B7 decimal value: 128","B8","status.system5.NODE64","Bit B8 decimal value: 256","B9-B15","Not used","Not applicable","As an example, to set bit B1 of the system summary 5 enable register, set status.system5.enable = status.system5.NODE57.","In addition to the above constants, enableRegister can be set to the numeric equivalent of the bit to set. To set more than one bit of the register, set enableRegister to the sum of their decimal weights. For example, to set bits B1 and B4, set enableRegister to 18 (which is the sum of 2 + 16).","Bit","B7","B6","B5","B4","B3","B2","B1","B0","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","128","64","32","16","8","4","2","1","Weights","(27)","(26)","(25)","(24)","(23)","(22)","(21)","(20)","Bit","B15","B14","B13","B12","B11","B10","B9","B8","Binary value","0/1","0/1","0/1","0/1","0/1","0/1","0/1","0/1","Decimal","32,768","16,384","8,192","4,096","2,048","1024","512","256","Weights","(215)","(214)","(213)","(212)","(211)","(210)","(29)","(28)","Example 1","enableRegister = status.system5.NODE57 +"," status.system5.NODE60","status.system2.enable = enableRegister ","Sets bits B1 and B4 of the system summary 5 enable register using constants.","Example 2","-- decimal 18 = binary 0000 0000 0001 0010","enableRegister = 18","status.system5.enable = enableRegister","Sets bits B1 and B4 of the system summary 5 enable register using a decimal value.","Also see","status.system4.*","System summary and standard event registers","status.system5.*","15867.html");
+Page[419]=new Array("This KISweep factory script function performs a linear current sweep with voltage measured at every step (point).","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","SweepILinMeasureV(smu, starti, stopi, stime, points)","smu","System SourceMeter® instrument channel (set to smua)","starti","Sweep start current in amperes","stopi","Sweep stop current in amperes","stime","Settling time in seconds; occurs after stepping the source and before performing a measurement","points","Number of sweep points (must be ³2)","Details","Data for voltage measurements, current source values, and timestamps are stored in smuX.nvbuffer1.","If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.","Performs a linear current sweep with voltage measured at every step (point):","1. Sets the smu to output starti amperes, allows the source to settle for stime seconds, and then performs a voltage measurement.","2. Sets the smu to output the next amperes step, allows the source to settle for stime seconds, and then performs a voltage measurement.","3. Repeats the above sequence until the voltage is measured on the stopi amperes step.","The linear step size is automatically calculated as follows:","step = (stopi – starti) / (points – 1)","Example","SweepILinMeasureV(smua, -1E-3, 1E-3, 0, 100)","This function performs a 100-point linear current sweep starting at -1 mA and stopping at +1 mA. Voltage is measured at every step (point) in the sweep. Because stime is set for 0 s, voltage will be measured as fast as possible after each current step.","Also see","None","SweepILinMeasureV()","12177.html");
+Page[420]=new Array("This KISweep factory script function performs a current list sweep with voltage measured at every step (point).","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","SweepIListMeasureV(smu, ilist, stime, points)","smu","System SourceMeter® instrument channel (set to smua)","ilist","Arbitrary list of current source values; ilist = {value1, value2, ...valueN}","stime","Settling time in seconds; occurs after stepping the source and before performing a measurement","points","Number of sweep points (must be ³2)","Details","Data for voltage measurements, current source values, and timestamps are stored in smuX.nvbuffer1.","If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.","Performs a current list sweep with voltage measured at every step (point):","1. Sets the smu to output ilist amperes value, allows the source to settle for stime seconds, and then performs a voltage measurement.","2. Sets the smu to output the next ilist step, allows the source to settle for stime seconds, and then performs a voltage measurement.","3. Repeats the above sequence until the voltage is measured for the last amperes value. The last point in the list to be measured is points.","Example","testilist = {-100E-9, 100E-9, -1E-6, 1E-6,"," -1E-3, 1E-3}","SweepIListMeasureV(smua, testilist, "," 500E-3, 6)","This function performs a six‑point current list sweep starting at the first point in testilist. Voltage is measured at every step (point) in the sweep. The source will be allowed to settle on each step for 500 ms before a measurement is performed.","Also see","None","SweepIListMeasureV()","12190.html");
+Page[421]=new Array("This KISweep factory script function performs a logarithmic current sweep with voltage measured at every step (point).","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","SweepILogMeasureV(smu, starti, stopi, stime, points)","smu","System SourceMeter® instrument channel (set to smua)","starti","Sweep start current in amperes","stopi","Sweep stop current in amperes","stime","Settling time in seconds; occurs after stepping the source and before performing a measurement","points","Number of sweep points (must be ³2)","Details","Data for voltage measurements, current source values, and timestamps are stored in smuX.nvbuffer1.","If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.","Performs a logarithmic current sweep with voltage measured at every step (point):","1. Sets the smu to output starti amperes value, allows the source to settle for stime seconds, and then performs a voltage measurement.","2. Sets the smu to output the next amperes step, allows the source to settle for stime seconds, and then performs a voltage measurement.","3. Repeats the above sequence until the voltage is measured on the stopi amperes step.","The source level at each step (SourceStepLevel) is automatically calculated as follows:","MeasurePoint = The step point number for a measurement ","For example, for a five-point sweep (points = 5), a measurement is performed at MeasurePoint 1, 2, 3, 4, and 5.","LogStepSize = (log10(stopi) – log10(starti)) / (points – 1)","LogStep = (MeasurePoint – 1) * (LogStepSize)","SourceStepLevel = antilog(LogStep) * starti","Example","SweepILogMeasureV(smua, 0.01, 0.1,"," 0.001, 5)","This function performs a five‑point linear current sweep starting at 10 mA and stopping at 100 mA. Voltage is measured at every step (point) in the sweep. The source will be allowed to settle on each step for 1 ms before a measurement is performed.","The following table contains log values and corresponding source levels for the five‑point logarithmic sweep:","MeasurePoint","LogStepSize","LogStep","SourceStepLevel","1","0.25","0.0","0.01 A","2","0.25","0.25","0.017783 A","3","0.25","0.5","0.031623 A","4","0.25","0.75","0.056234 A","5","0.25","1.0","0.1 A","Also see","None","SweepILogMeasureV()","12184.html");
+Page[422]=new Array("This KISweep factory script function performs a linear voltage sweep with current measured at every step (point).","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","SweepVLinMeasureI(smu, startv, stopv, stime, points)","smu","System SourceMeter® instrument channel (set to smua)","startv","Sweep start voltage in volts","stopv","Sweep stop voltage in volts","stime","Settling time in seconds; occurs after stepping the source and before performing a measurement","points","Number of sweep points (must be ³2)","Details","Data for current measurements, voltage source values, and timestamps are stored in smuX.nvbuffer1.","If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.","Performs a linear voltage sweep with current measured at every step (point):","1. Sets the smu to output startv amperes, allows the source to settle for stime seconds, and then performs a current measurement.","2. Sets the smu to output the next amperes step, allows the source to settle for stime seconds, and then performs a voltage measurement.","3. Repeats the above sequence until the voltage is measured on the stopv amperes step.","The linear step size is automatically calculated as follows:","step = (stopv – startv) / (points – 1)","Example","SweepVLinMeasureI(smua, 500, 3000, 15e-3, 26) ","This function performs a 26-point linear voltage sweep starting at 500 V and stopping at 3000 V. Current is measured at every step (point) in the sweep after a 15 ms source settling period.","Also see","None","SweepVLinMeasureI()","12181.html");
+Page[423]=new Array("This KISweep factory script function performs a voltage list sweep with current measured at every step (point).","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","SweepVListMeasureI(smu, vlist, stime, points)","smu","System SourceMeter® instrument channel (set to smua)","vlist","Arbitrary list of voltage source values; vlist = {value1, value2, ... valueN}","stime","Settling time in seconds; occurs after stepping the source and before performing a measurement","points","Number of sweep points (must be ³2)","Details","Data for current measurements, voltage source values, and timestamps are stored in smuX.nvbuffer1.","If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.","Performs a voltage list sweep with current measured at every step (point):","1. Sets the smu to output vlist volts value, allows the source to settle for stime seconds, and then performs a current measurement.","2. Sets the smu to output the next vlist volts value, allows the source to settle for stime seconds, and then performs a current measurement.","3. Repeats the above sequence until the current is measured for the last volts value. The last point in the list to be measured is points.","Example","myvlist = {-100, 100, -200, 200, -400,"," 400, -800, 800, -1600, 1600}","SweepVListMeasureI(smua, myvlist, "," 500E-3, 10)","This function performs a 10‑point voltage list sweep starting at the first point in myvlist. Current is measured at every step (point) in the sweep. The source will be allowed to settle on each step for 500 ms before a measurement is performed.","Also see","None","SweepVListMeasureI()","19138.html");
+Page[424]=new Array("This KISweep factory script function performs a logarithmic voltage sweep with current measured at every step (point).","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","SweepVLogMeasureI(smu, startv, stopv, stime, points)","smu","System SourceMeter® instrument channel (set to smua)","startv","Sweep start voltage in volts","stopv","Sweep stop voltage in volts","stime","Settling time in seconds; occurs after stepping the source and before performing a measurement","points","Number of sweep points (must be ³2)","Details","Data for current measurements, voltage source values, and timestamps are stored in smuX.nvbuffer1.","If all parameters are omitted when this function is called, this function is executed with the parameters set to the default values.","Performs a logarithmic voltage sweep with current measured at every step (point):","1. Sets the smu to output startv amperes, allows the source to settle for stime seconds, and then performs a current measurement.","2. Sets the smu to output the next volts step, allows the source to settle for stime seconds, and then performs a current measurement.","3. Repeats the above sequence until the voltage is measured on the stopv volts step.","The source level at each step (SourceStepLevel) is automatically calculated as follows:","MeasurePoint = The step point number for a measurement ","For example, for a five-point sweep (points = 5), a measurement is performed at MeasurePoint 1, 2, 3, 4, and 5.","LogStepSize = (log10(stopi) – log10(starti)) / (points – 1)","LogStep = (MeasurePoint – 1) * (LogStepSize)","SourceStepLevel = antilog(LogStep) * startv","Example","SweepVLogMeasureI(smua, 100,"," 1000, 0.02, 5)","This function performs a five‑point logarithmic voltage sweep starting at 100 V and stopping at 1000 V. Current is measured at every step (point) in the sweep after a 20 ms source settling period.","The following table contains log values and corresponding source levels for the five‑point logarithmic sweep:","MeasurePoint","LogStepSize","LogStep","SourceStepLevel","1","0.25","0.0","100.00 V","2","0.25","0.25","177.83 V","3","0.25","0.5","316.23 V","4","0.25","0.75","562.34 V","5","0.25","1.0","1000.0 V","Also see","None","SweepVLogMeasureI()","12192.html");
+Page[425]=new Array("This function measures the elapsed time since the timer was last reset.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","time = timer.measure.t()","time","The elapsed time in seconds (1 ïs resolution)","Example 1","timer.reset()","-- (intervening code)","time = timer.measure.t()","print(time)","Resets the timer and measures the time since the reset.","Output:","1.469077e+01","The output will vary. The above output indicates that timer.measure.t() was executed 14.69077 seconds after timer.reset().","Example 2","beeper.beep(0.5, 2400)","print("reset timer")","timer.reset()","delay(0.5)","dt = timer.measure.t()","print("timer after delay:", dt)","beeper.beep(0.5, 2400)","Sets the beeper, resets the timer, sets a delay, then verifies the time of the delay before the next beeper.","Output:","reset timer","timer after delay: 5.00e-01","Also see","timer.reset()","timer.measure.t()","15281.html");
+Page[426]=new Array("This function resets the timer to zero (0) seconds.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","timer.reset()","Example","timer.reset()","-- (intervening code)","time = timer.measure.t()","print(time)","Resets the timer and then measures the time since the reset.","Output:","1.469077e+01","The above output indicates that timer.measure.t() was executed 14.69077 seconds after timer.reset().","Also see","timer.measure.t()","timer.reset()","15282.html");
+Page[427]=new Array("This function clears the blender event detector and resets blender N.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","trigger.blender[N].clear()","N","The blender number (1 to 4)","Details","This function sets the blender event detector to the undetected state and resets the event detector's overrun indicator.","Example","trigger.blender[2].clear()","Clears the event detector for blender 2.","Also see","None","trigger.blender[N].clear()","15785.html");
+Page[428]=new Array("This constant contains the trigger blender event number.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Constant","Yes","Usage","eventID = trigger.blender[N].EVENT_ID","eventID","Trigger event number","N","The blender number (1 to 4)","Details","Set the stimulus of any trigger event detector to the value of this constant to have it respond to trigger events from this trigger blender.","Example","digio.trigger[1].stimulus = trigger.blender[2].EVENT_ID","Set the trigger stimulus of digital I/O trigger 1 to be controlled by the trigger blender 2 event.","Also see","None","trigger.blender[N].EVENT_ID","15786.html");
+Page[429]=new Array("This attribute selects whether the blender operates in OR mode or AND mode.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Trigger blender N reset Recall setup","Not saved ","false (AND mode)","Usage","orenable = trigger.blender[N].orenable","trigger.blender[N].orenable = orenable","orenable","The orenable mode:","true: OR mode","false: AND mode","N","The trigger blender (1 to 4)","Details","This attribute selects whether the blender waits for any one event (the “OR” mode) or waits for all selected events (the “AND” mode) before signaling an output event.","Example","trigger.blender[1].orenable = true","trigger.blender[1].stimulus[1] = digio.trigger[3].EVENT_ID","trigger.blender[1].stimulus[2] = digio.trigger[5].EVENT_ID","Generate a trigger blender 1 event when a digital I/O trigger happens on line 3 or 5.","Also see","trigger.blender[N].reset()","trigger.blender[N].orenable","15787.html");
+Page[430]=new Array("This attribute indicates whether or not an event was ignored because of the event detector state.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Instrument reset Trigger blender N clear Trigger blender N reset","Not applicable","Not applicable","Usage","overrun = trigger.blender[N].overrun","overrun","Trigger blender overrun state","N","The trigger event blender (1 to 4)","Details","Indicates if an event was ignored because the event detector was already in the detected state when the event occurred. This is an indication of the state of the event detector that is built into the event blender itself.","This attribute does not indicate if an overrun occurred in any other part of the trigger model or in any other trigger object that is monitoring the event. It also is not an indication of an action overrun.","Example","print(trigger.blender[1].overrun)","If an event was ignored, the output is true.","If an event was not ignored, the output is false.","Also see","trigger.blender[N].reset()","trigger.blender[N].overrun","15788.html");
+Page[431]=new Array("This function resets some of the trigger blender settings to their factory defaults.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","trigger.blender[N].reset()","N","The trigger event blender (1 to 4)","Details","The trigger.blender[N].reset() function resets the following attributes to their factory defaults:","trigger.blender[N].orenable","trigger.blender[N].stimulus[M]","It also clears trigger.blender[N].overrun.","Example","trigger.blender[1].reset()","Resets the trigger blender 1 settings back to factory defaults.","Also see","trigger.blender[N].orenable","trigger.blender[N].overrun","trigger.blender[N].stimulus[M]","trigger.blender[N].reset()","17666.html");
+Page[432]=new Array("This attribute specifies which events trigger the blender.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Recall setup Trigger blender N reset","Not saved","0","Usage","eventID = trigger.blender[N].stimulus[M]","trigger.blender[N].stimulus[M] = eventID","eventID","The event that triggers the blender action; see Details","N","An integer representing the trigger event blender (1 to 4)","M","An integer representing the stimulus index (1 to 4)","Details","There are four acceptors that can each select a different event. The eventID parameter can be the event ID of any trigger event.","Use zero to disable the blender input. ","The eventID parameter may be one of the existing trigger event IDs shown in the following table.","Trigger event IDs*","Event ID","Event description","smua.trigger.SWEEPING_EVENT_ID","Occurs when the source‑measure unit (SMU) transitions from the idle state to the arm layer of the trigger model","smua.trigger.ARMED_EVENT_ID","Occurs when the SMU moves from the arm layer to the trigger layer of the trigger model","smua.trigger.SOURCE_COMPLETE_EVENT_ID","Occurs when the SMU completes a source action","smua.trigger.MEASURE_COMPLETE_EVENT_ID","Occurs when the SMU completes a measure action","smua.trigger.PULSE_COMPLETE_EVENT_ID","Occurs when the SMU completes a pulse","smua.trigger.SWEEP_COMPLETE_EVENT_ID","Occurs when the SMU completes a sweep","smua.trigger.IDLE_EVENT_ID","Occurs when the SMU returns to the idle state","digio.trigger[N].EVENT_ID","Occurs when an edge is detected on a digital I/O line","tsplink.trigger[N].EVENT_ID","Occurs when an edge is detected on a TSP‑Link line","lan.trigger[N].EVENT_ID","Occurs when the appropriate LXI trigger packet is received on LAN trigger object N","display.trigger.EVENT_ID","Occurs when the TRIG key on the front panel is pressed","trigger.EVENT_ID","Occurs when a *TRG command is received on the remote interface","GPIB only: Occurs when a GET bus command is received","VXI-11 only: Occurs with the VXI-11 command device_trigger; reference the VXI-11 standard for additional details on the device trigger operation","trigger.blender[N].EVENT_ID","Occurs after a collection of events is detected","trigger.timer[N].EVENT_ID","Occurs when a delay expires","* Use the name of the trigger event ID to set the stimulus value rather than the numeric value. Using the name makes the code compatible for future upgrades (for example, if the numeric values must change when enhancements are added to the instrument).","Example","digio.trigger[3].mode = digio.TRIG_FALLING","digio.trigger[5].mode = digio.TRIG_FALLING","trigger.blender[1].orenable = true","trigger.blender[1].stimulus[1] = digio.trigger[3].EVENT_ID","trigger.blender[1].stimulus[2] = digio.trigger[5].EVENT_ID","Generate a trigger blender 1 event when a digital I/O trigger happens on line 3 or 5.","Also see","trigger.blender[N].reset()","trigger.blender[N].stimulus[M]","17684.html");
+Page[433]=new Array("This function waits for a blender trigger event to occur.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","triggered = trigger.blender[N].wait(timeout)","triggered","Trigger detection indication for blender","N","The trigger blender (1 to 4) on which to wait","timeout","Maximum amount of time in seconds to wait for the trigger blender event","Details","This function waits for an event blender trigger event. If one or more trigger events were detected since the last time trigger.blender[N].wait() or trigger.blender[N].clear() was called, this function returns immediately.","After detecting a trigger with this function, the event detector automatically resets and rearms. This is true regardless of the number of events detected.","Example","digio.trigger[3].mode = digio.TRIG_FALLING","digio.trigger[5].mode = digio.TRIG_FALLING","trigger.blender[1].orenable = true","trigger.blender[1].stimulus[1] = digio.trigger[3].EVENT_ID","trigger.blender[1].stimulus[2] = digio.trigger[5].EVENT_ID","print(trigger.blender[1].wait(3))","Generate a trigger blender 1 event when a digital I/O trigger happens either on line 3 or 5.","Wait three seconds while checking if trigger blender 1 event has occurred.","If the blender trigger event has happened, then true is output. If the trigger event has not happened, then false is output after the timeout expires.","Also see","trigger.blender[N].clear()","trigger.blender[N].wait()","15790.html");
+Page[434]=new Array("This function clears the command interface trigger event detector.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","trigger.clear()","Details","The trigger event detector indicates if an event has been detected since the last trigger.wait() call. This function clears the trigger's event detector and discards the previous history of command interface trigger events.","Also see","trigger.wait()","trigger.clear()","15791.html");
+Page[435]=new Array("This constant contains the command interface trigger event number.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Constant","Yes","Usage","eventID = trigger.EVENT_ID","eventID","The command interface trigger event number","Details","You can set the stimulus of any trigger event detector to the value of this constant to have it respond to command interface trigger events.","Example","trigger.timer[1].stimulus = trigger.EVENT_ID","Sets the trigger stimulus of trigger timer 1 to the command interface trigger event.","Also see","None","trigger.EVENT_ID","15792.html");
+Page[436]=new Array("This function clears the timer event detector and overrun indicator for the specified trigger timer number.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","trigger.timer[N].clear()","N","Trigger timer number to clear (1 to 4)","Details","This function sets the timer event detector to the undetected state and resets the overrun indicator.","Example","trigger.timer[1].clear()","Clears trigger timer 1.","Also see","trigger.timer[N].count","trigger.timer[N].clear()","15793.html");
+Page[437]=new Array("This attribute sets the number of events to generate each time the timer is triggered.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Recall setup Trigger timer N reset","Not saved ","1","Usage","count = trigger.timer[N].count","trigger.timer[N].count = count","count","Number of times to repeat the trigger","N","A trigger timer number (1 to 4)","Details","If count is set to a number greater than 1, the timer automatically starts the next delay at expiration of the previous delay.","Set count to zero (0) to cause the timer to generate trigger events indefinitely.","Example","print(trigger.timer[1].count)","Read trigger count for timer number 1.","Also see","trigger.timer[N].clear()","trigger.timer[N].reset()","trigger.timer[N].count","15820.html");
+Page[438]=new Array("This attribute sets and reads the timer delay.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Recall setup Trigger timer N reset","Not saved ","10e-6 (10 ms)","Usage","interval = trigger.timer[N].delay","trigger.timer[N].delay = interval","interval","Delay interval in seconds","N","Trigger timer number (1 to 4)","Details","Each time the timer is triggered, it uses this delay period.","Assigning a value to this attribute is equivalent to:","trigger.timer[N].delaylist = {interval}","This creates a delay list of one value.","Reading this attribute returns the delay interval that will be used the next time the timer is triggered.","Example","trigger.timer[1].delay = 50e-6","Set the trigger timer 1 to delay for 50 µs.","Also see","trigger.timer[N].reset()","trigger.timer[N].delay","15794.html");
+Page[439]=new Array("This attribute sets an array of timer intervals that are used when triggered.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Recall setup Trigger timer N reset","Not saved ","{10e-6}","Usage","intervals = trigger.timer[N].delaylist","trigger.timer[N].delaylist = intervals","intervals","Table of delay intervals in seconds","N","Trigger timer number (1 to 4)","Details","Each time the timer is triggered, it uses the next delay period from the array. The default value is an array with one value of 10 ms.","After all elements in the array have been used, the delays restart at the beginning of the list.","If the array contains more than one element, the average of the delay intervals in the list must be ³ 50 µs.","Example","trigger.timer[3].delaylist = {50e-6, 100e-6, 150e-6}","DelayList = trigger.timer[3].delaylist","for x = 1, table.getn(DelayList) do"," print(DelayList[x])","end","Set a delay list on trigger timer 3 with three delays (50 µs, 100 µs, and 150 µs).","Read the delay list on trigger timer 3.","Output (assuming the delay list was set to 50 µs, 100 µs, and 150 µs):","5.000000000e-05","1.000000000e-04","1.500000000e-04","Also see","trigger.timer[N].reset()","trigger.timer[N].delaylist","15795.html");
+Page[440]=new Array("This constant specifies the trigger timer event number.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Constant","Yes","Usage","eventID = trigger.timer[N].EVENT_ID","eventID","The trigger event number","N","The trigger timer number (1 to 4)","Details","This constant is an identification number that identifies events generated by this timer.","Set the stimulus of any trigger event detector to the value of this constant to have it respond to events from this timer.","Example","trigger.timer[1].stimulus = tsplink.trigger[2].EVENT_ID","Sets the trigger stimulus of trigger timer 1 to the TSP-Link trigger 2 event.","Also see","None","trigger.timer[N].EVENT_ID","15796.html");
+Page[441]=new Array("This attribute indicates if an event was ignored because of the event detector state.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Instrument reset Recall setup Trigger timer N clear Trigger timer N reset","Not applicable","false","Usage","overrun = trigger.timer[N].overrun","overrun","Trigger overrun state","N","Trigger timer number (1 to 4)","Details","This attribute indicates if an event was ignored because the event detector was already in the detected state when the event occurred.","This is an indication of the state of the event detector built into the timer itself. It does not indicate if an overrun occurred in any other part of the trigger model or in any other construct that is monitoring the delay completion event. It also is not an indication of a delay overrun.","Example","print(trigger.timer[1].overrun)","If an event was ignored, the output is true.","If the event was not ignored, the output is false.","Also see","trigger.timer[N].reset()","trigger.timer[N].overrun","15797.html");
+Page[442]=new Array("This attribute enables or disables the timer trigger pass‑through mode.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Recall setup Trigger timer N reset","Not saved ","false (disabled)","Usage","passthrough = trigger.timer[N].passthrough","trigger.timer[N].passthrough = passthrough","passthrough","The state of pass-through mode. Set to to one of the following values:","true: Enabled","false: Disabled","N","Trigger timer number (1 to 4)","Details","When enabled, triggers are passed through immediately and initiate the delay. When disabled, a trigger only initiates a delay.","Example","trigger.timer[1].passthrough = true","Enables pass‑through mode on trigger timer 1.","Also see","trigger.timer[N].reset()","trigger.timer[N].passthrough","15798.html");
+Page[443]=new Array("This function resets some of the trigger timer settings to their factory defaults.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","trigger.timer[N].reset()","N","Trigger timer number (1 to 4)","Details","The trigger.timer[N].reset() function resets the following attributes to their factory defaults:","trigger.timer[N].count","trigger.timer[N].delay","trigger.timer[N].delaylist","trigger.timer[N].passthrough","trigger.timer[N].stimulus","It also clears trigger.timer[N].overrun.","Example","trigger.timer[1].reset()","Resets the attributes associated with timer 1 back to factory default values.","Also see","trigger.timer[N].count","trigger.timer[N].delay","trigger.timer[N].delaylist","trigger.timer[N].overrun","trigger.timer[N].passthrough","trigger.timer[N].stimulus","trigger.timer[N].reset()","17668.html");
+Page[444]=new Array("This attribute specifies which event starts the timer.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Recall setup Trigger timer N reset","Not saved","0","Usage","eventID = trigger.timer[N].stimulus","trigger.timer[N].stimulus = eventID","eventID","The event that triggers the timer delay","N","Trigger timer number (1 to 4)","Details","The eventID parameter may be one of the trigger event IDs shown in the following table.","Trigger event IDs*","Event ID","Event description","smua.trigger.SWEEPING_EVENT_ID","Occurs when the source‑measure unit (SMU) transitions from the idle state to the arm layer of the trigger model","smua.trigger.ARMED_EVENT_ID","Occurs when the SMU moves from the arm layer to the trigger layer of the trigger model","smua.trigger.SOURCE_COMPLETE_EVENT_ID","Occurs when the SMU completes a source action","smua.trigger.MEASURE_COMPLETE_EVENT_ID","Occurs when the SMU completes a measure action","smua.trigger.PULSE_COMPLETE_EVENT_ID","Occurs when the SMU completes a pulse","smua.trigger.SWEEP_COMPLETE_EVENT_ID","Occurs when the SMU completes a sweep","smua.trigger.IDLE_EVENT_ID","Occurs when the SMU returns to the idle state","digio.trigger[N].EVENT_ID","Occurs when an edge is detected on a digital I/O line","tsplink.trigger[N].EVENT_ID","Occurs when an edge is detected on a TSP‑Link line","lan.trigger[N].EVENT_ID","Occurs when the appropriate LXI trigger packet is received on LAN trigger object N","display.trigger.EVENT_ID","Occurs when the TRIG key on the front panel is pressed","trigger.EVENT_ID","Occurs when a *TRG command is received on the remote interface","GPIB only: Occurs when a GET bus command is received","VXI-11 only: Occurs with the VXI-11 command device_trigger; reference the VXI-11 standard for additional details on the device trigger operation","trigger.blender[N].EVENT_ID","Occurs after a collection of events is detected","trigger.timer[N].EVENT_ID","Occurs when a delay expires","* Use the name of the trigger event ID to set the stimulus value rather than the numeric value. Using the name makes the code compatible for future upgrades (for example, if the numeric values must change when enhancements are added to the instrument).","Set this attribute to the eventID of any trigger event to cause the timer to start when that event occurs.","Set this attribute equal to zero (0) to disable event processing.","Example","print(trigger.timer[1].stimulus)","Prints the event that will start a trigger 1 timer action.","Also see","trigger.timer[N].reset()","trigger.timer[N].stimulus","17688.html");
+Page[445]=new Array("This function waits for a trigger.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","triggered = trigger.timer[N].wait(timeout)","triggered","Trigger detection indication","N","Trigger timer number (1 to 4)","timeout","Maximum amount of time in seconds to wait for the trigger","Details","If one or more trigger events were detected since the last time trigger.timer[N].wait() or trigger.timer[N].clear() was called, this function returns immediately.","After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.","Example","triggered = trigger.timer[3].wait(10)","print(triggered)","Waits up to 10 seconds for a trigger on timer 3.","If false is returned, no trigger was detected during the 10-second timeout.","If true is returned, a trigger was detected.","Also see","trigger.timer[N].clear()","trigger.timer[N].wait()","15800.html");
+Page[446]=new Array("This function waits for a command interface trigger event.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","triggered = trigger.wait(timeout)","triggered","true: A trigger was detected during the timeout period","false: No triggers were detected during the timeout period","timeout","Maximum amount of time in seconds to wait for the trigger","Details","This function waits up to timeout seconds for a trigger on the active command interface. A command interface trigger occurs when:","A GPIB GET command is detected (GPIB only)","A VXI-11 device_trigger method is invoked (VXI-11 only)","A *TRG message is received","If one or more of these trigger events were previously detected, this function returns immediately.","After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.","Example","triggered = trigger.wait(10)","print(triggered)","Waits up to 10 seconds for a trigger.","If false is returned, no trigger was detected during the 10‑second timeout.","If true is returned, a trigger was detected.","Also see","trigger.clear()","trigger.wait()","15801.html");
+Page[447]=new Array("This attribute is the group number of a TSP‑Link node.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Not applicable","Not saved","0","Usage","groupNumber = tsplink.group","tsplink.group = groupNumber","groupNumber","The group number of the TSP-Link node (0 to 64)","Details","To remove the node from all groups, set the attribute value to 0.","When the node is turned off, the group number for that node changes to 0.","The master node can be assigned to any group. You can also include other nodes in the group that includes the master. Note that any nodes that are set to 0 are automatically included in the group that contains the master node, regardless of the group that is assigned to the master node.","Example","tsplink.group = 3","Assign the instrument to TSP-Link group number 3.","Also see","Using groups to manage nodes on TSP-Link network","tsplink.group","15285.html");
+Page[448]=new Array("This attribute reads the node number assigned to the master node.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not applicable","Not applicable","Usage","masterNodeNumber = tsplink.master","masterNodeNumber","The node number of the master node","Details","After doing a TSP-Link reset (tsplink.reset()), use this attribute to access the node number of the master in a set of instruments connected over TSP-Link.","Example","LinkMaster = tsplink.master","Store the TSP-Link master node number in a variable called LinkMaster.","Also see","tsplink.reset()","tsplink.master","15286.html");
+Page[449]=new Array("This attribute defines the node number.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Not applicable","Nonvolatile memory","1","Usage","nodeNumber = tsplink.node","tsplink.node = nodeNumber","nodeNumber","Set node to a number (1 to 64)","Details","This attribute sets the TSP‑Link node number and saves the value in nonvolatile memory.","Changes to the node number do not take effect until the next time tsplink.reset() is executed on any node in the system.","Each node connected to the TSP-Link system must be assigned a different node number.","Example","tsplink.node = 2","Sets the TSP‑Link node to number 2.","Also see","tsplink.reset()","tsplink.state","tsplink.node","15287.html");
+Page[450]=new Array("This function reads the state of a TSP-Link synchronization line.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","data = tsplink.readbit(N)","data","A custom variable that stores the state of the synchronization line","N","The trigger line (1 to 3)","Details","Returns a value of zero (0) if the line is low and 1 if the line is high.","Example","data = tsplink.readbit(3)","print(data)","Assume line 3 is set high, and it is then read.","Output","1.000000e+00","Also see","tsplink.readport()","tsplink.writebit()","tsplink.readbit()","15288.html");
+Page[451]=new Array("This function reads the TSP-Link® synchronization lines as a digital I/O port.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","data = tsplink.readport()","data","Numeric value returned indicating which register bits are set","Details","The binary equivalent of the returned value indicates the input pattern on the I/O port. The least significant bit of the binary number corresponds to line 1 and bit B3 corresponds to line 3. For example, a returned value of 2 has a binary equivalent of 010. Line 2 is high (1), and the other 2 lines are low (0).","Example","data = tsplink.readport()","print(data)","Reads state of all three TSP-Link lines.","Assuming line 2 is set high, the output is:","2.000000e+00 ","(binary 010)","Also see","TSP-Link synchronization lines","tsplink.readbit()","tsplink.writebit()","tsplink.writeport()","tsplink.readport()","15289.html");
+Page[452]=new Array("This function initializes (resets) all nodes (instruments) in the TSP‑Link system.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","nodesFound = tsplink.reset()","nodesFound = tsplink.reset(expectedNodes)","nodesFound","The number of nodes actually found on the system","expectedNodes","The number of nodes expected on the system (1 to 64)","Details","This function erases all knowledge of other nodes connected on the TSP-Link system and regenerates the system configuration. This function must be called at least once before any remote nodes can be accessed. If the node number for any instrument is changed, the TSP-Link nodes must be initialized again.","If expectedNodes is not given, this function generates an error if no other nodes are found on the TSP‑Link network.","If nodesFound is less than expectedNodes, an error is generated. Note that the node on which the command is running is counted as a node. For example, giving an expected node count of 1 will not generate any errors, even if there are no other nodes on the TSP-Link network.","Also returns the number of nodes found.","Example","nodesFound = tsplink.reset(2)","print("Nodes found = " .. nodesFound)","Perform a TSP-Link reset and indicate how many nodes are found.","Sample output if found 2 nodes: Nodes found = 2","Sample output if fewer nodes are found and if localnode.showerrors = 1: 1219, TSP-Link found fewer nodes than expected Nodes found = 1","Also see","localnode.showerrors","tsplink.node","tsplink.state","tsplink.reset()","15290.html");
+Page[453]=new Array("This attribute describes the TSP‑Link online state.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Not applicable","Not applicable","Not applicable","Usage","state = tsplink.state","state","TSP-Link state (online or offline)","Details","When the instrument power is turned on, the state is offline. After tsplink.reset() function is successful, the state is online.","Example","state = tsplink.state","print(state)","Read the state of the TSP‑Link. If it is online, the output is:","online","Also see","tsplink.node","tsplink.reset()","tsplink.state","15291.html");
+Page[454]=new Array("This function simulates the occurrence of the trigger and generates the corresponding event ID.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","tsplink.trigger[N].assert()","N","The trigger line (1 to 3)","Details","The set pulse width determines how long the trigger is asserted.","Example","tsplink.trigger[2].assert()","Asserts trigger on trigger line 2.","Also see","tsplink.trigger[N].clear()","tsplink.trigger[N].mode","tsplink.trigger[N].overrun","tsplink.trigger[N].pulsewidth","tsplink.trigger[N].release()","tsplink.trigger[N].stimulus","tsplink.trigger[N].wait()","tsplink.trigger[N].assert()","15292.html");
+Page[455]=new Array("This function clears the event detector for a trigger.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","tsplink.trigger[N].clear()","N","The trigger line (1 to 3)","Details","The event detector for a trigger recalls if a trigger event has been detected since the last tsplink.trigger[N].wait() call. This function clears a trigger event detector, discards the previous history of the trigger line, and clears the tsplink.trigger[N].overrun attribute.","Example","tsplink.trigger[2].clear()","Clears trigger event on synchronization line 2.","Also see","tsplink.trigger[N].mode","tsplink.trigger[N].overrun","tsplink.trigger[N].release()","tsplink.trigger[N].stimulus","tsplink.trigger[N].wait()","tsplink.trigger[N].clear()","15293.html");
+Page[456]=new Array("This constant identifies the number that is used for the trigger events.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Constant","Yes","Usage","eventID = tsplink.trigger[N].EVENT_ID","eventID","The trigger event number","N","The trigger line (1 to 3)","Details","This number is used by the TSP-Link trigger line when it detects an input trigger.","Set the stimulus of any trigger event detector to the value of this constant to have it respond to trigger events from this line.","Example","trigger.timer[1].stimulus = tsplink.trigger[2].EVENT_ID","Sets the trigger stimulus of trigger timer 1 to the TSP-Link trigger 2 event.","Also see","None","tsplink.trigger[N].EVENT_ID","15294.html");
+Page[457]=new Array("This attribute defines the trigger operation and detection mode.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Recall setup TSP-Link trigger N reset","Not saved ","0 (tsplink.TRIG_BYPASS)","Usage","mode = tsplink.trigger[N].mode","tsplink.trigger[N].mode = mode","mode","The trigger mode","N","The trigger line (1 to 3)","Details","This attribute controls the mode in which the trigger event detector and the output trigger generator operate on the given trigger line.","The setting for mode can be one of the following values:","Mode","Number value","Description","tsplink.TRIG_BYPASS","0","Allows direct control of the line as a digital I/O line.","tsplink.TRIG_FALLING","1","Detects falling‑edge triggers as input. Asserts a TTL-low pulse for output.","tsplink.TRIG_RISING","2","If the programmed state of the line is high, the tsplink.TRIG_RISING mode behaves similar to tsplink.TRIG_RISINGA. If the programmed state of the line is low, the tsplink.TRIG_RISING mode behaves similar to tsplink.TRIG_RISINGM. Use tsplink.TRIG_RISINGA if the line is in the high output state. Use tsplink.TRIG_RISINGM if the line is in the low output state.","tsplink.TRIG_EITHER","3","Detects rising‑ or falling‑edge triggers as input. Asserts a TTL‑low pulse for output.","tsplink.TRIG_SYNCHRONOUSA","4","Detects the falling‑edge input triggers and automatically latches and drives the trigger line low.","tsplink.TRIG_SYNCHRONOUS","5","Detects the falling‑edge input triggers and automatically latches and drives the trigger line low. Asserts a TTL-low pulse as an output trigger.","tsplink.TRIG_SYNCHRONOUSM","6","Detects rising‑edge triggers as an input. Asserts a TTL‑low pulse for output.","tsplink.TRIG_RISINGA","7","Detects rising‑edge triggers as input. Asserts a TTL‑low pulse for output.","tsplink.TRIG_RISINGM","8","Edge detection as an input is not available. Generates a TTL‑high pulse as an output trigger.","When programmed to any other mode, the output state of the I/O line is controlled by the trigger logic, and the user-specified output state of the line is ignored.","When the trigger mode is set to tsplink.TRIG_RISING, the user‑specified output state of the line will be examined. If the output state selected when the mode is changed is high, the actual mode used will be tsplink.TRIG_RISINGA. If the output state selected when the mode is changed is low, the actual mode used will be tsplink.TRIG_RISINGM.","The custom variable mode stores the trigger mode as a numeric value when the attribute is read.","To control the line state, use the tsplink.TRIG_BYPASS mode with the tsplink.writebit() and the tsplink.writeport() commands.","Example","tsplink.trigger[3].mode = tsplink.TRIG_RISINGM","Sets the trigger mode for synchronization line 3 to tsplink.TRIG_RISINGM.","Also see","digio.writebit()","digio.writeport()","tsplink.trigger[N].assert()","tsplink.trigger[N].clear()","tsplink.trigger[N].overrun","tsplink.trigger[N].release()","tsplink.trigger[N].reset()","tsplink.trigger[N].stimulus","tsplink.trigger[N].wait()","tsplink.trigger[N].mode","15295.html");
+Page[458]=new Array("This attribute indicates if the event detector ignored an event while in the detected state.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (R)","Yes","Instrument reset Recall setup TSP-Link trigger N clear TSP-Link trigger N reset","Not applicable","Not applicable","Usage","overrun = tsplink.trigger[N].overrun","overrun","Trigger overrun state","N","The trigger line (1 to 3)","Details","Indicates that an event was ignored because the event detector was in the detected state when the event was detected.","Indicates the overrun state of the event detector built into the line itself.","It does not indicate whether an overrun occurred in any other part of the trigger model or in any other detector that is monitoring the event.","It does not indicate output trigger overrun.","Example","print(tsplink.trigger[1].overrun)","If an event was ignored, displays true; if an event was not ignored, displays false.","Also see","tsplink.trigger[N].assert()","tsplink.trigger[N].clear()","tsplink.trigger[N].mode","tsplink.trigger[N].release()","tsplink.trigger[N].reset()","tsplink.trigger[N].stimulus","tsplink.trigger[N].wait()","tsplink.trigger[N].overrun","15296.html");
+Page[459]=new Array("This attribute sets the length of time that the trigger line is asserted for output triggers.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset TSP-Link trigger N reset Recall setup","Not saved","10e-6 (10 ms)","Usage","width = tsplink.trigger[N].pulsewidth","tsplink.trigger[N].pulsewidth = width","width","The pulse width (in seconds)","N","The trigger line (1 to 3)","Details","Setting the pulse width to 0 (seconds) asserts the trigger indefinitely.","Example","tsplink.trigger[3].pulsewidth = 20e-6","Sets pulse width for trigger line 3 to 20 μs.","Also see","tsplink.trigger[N].release()","tsplink.trigger[N].pulsewidth","15297.html");
+Page[460]=new Array("This function releases a latched trigger on the given TSP‑Link trigger line.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","tsplink.trigger[N].release()","N","The trigger line (1 to 3)","Details","Releases a trigger that was asserted with an indefinite pulse width, as well as a trigger that was latched in response to receiving a synchronous mode trigger.","Example","tsplink.trigger[3].release()","Releases trigger line 3.","Also see","tsplink.trigger[N].assert()","tsplink.trigger[N].clear()","tsplink.trigger[N].mode","tsplink.trigger[N].overrun","tsplink.trigger[N].pulsewidth","tsplink.trigger[N].stimulus","tsplink.trigger[N].wait()","tsplink.trigger[N].release()","15298.html");
+Page[461]=new Array("This function resets some of the TSP-Link trigger settings to their factory defaults.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","tsplink.trigger[N].reset()","N","The trigger line (1 to 3)","Details","The tsplink.trigger[N].reset() function resets the following attributes to their factory defaults:","tsplink.trigger[N].mode","tsplink.trigger[N].stimulus","tsplink.trigger[N].pulsewidth","This also clears tsplink.trigger[N].overrun.","Example","tsplink.trigger[3].reset()","Resets TSP-Link trigger line 3 attributes back to factory default values.","Also see","tsplink.trigger[N].mode","tsplink.trigger[N].overrun","tsplink.trigger[N].pulsewidth","tsplink.trigger[N].stimulus","tsplink.trigger[N].reset()","17669.html");
+Page[462]=new Array("This attribute specifies the event that causes the synchronization line to assert a trigger.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Recall setup TSP-Link trigger N reset","Not saved","0","Usage","eventID = tsplink.trigger[N].stimulus","tsplink.trigger[N].stimulus = eventID","eventID","The event identifier for the triggering event","N","The trigger line (1 to 3)","Details","To disable automatic trigger assertion on the synchronization line, set this attribute to zero (0).","Do not use this attribute when triggering under script control. Use tsplink.trigger[N].assert() instead.","The eventID parameter may be one of the existing trigger event IDs shown in the following table.","Trigger event IDs*","Event ID","Event description","smua.trigger.SWEEPING_EVENT_ID","Occurs when the source‑measure unit (SMU) transitions from the idle state to the arm layer of the trigger model","smua.trigger.ARMED_EVENT_ID","Occurs when the SMU moves from the arm layer to the trigger layer of the trigger model","smua.trigger.SOURCE_COMPLETE_EVENT_ID","Occurs when the SMU completes a source action","smua.trigger.MEASURE_COMPLETE_EVENT_ID","Occurs when the SMU completes a measure action","smua.trigger.PULSE_COMPLETE_EVENT_ID","Occurs when the SMU completes a pulse","smua.trigger.SWEEP_COMPLETE_EVENT_ID","Occurs when the SMU completes a sweep","smua.trigger.IDLE_EVENT_ID","Occurs when the SMU returns to the idle state","digio.trigger[N].EVENT_ID","Occurs when an edge is detected on a digital I/O line","tsplink.trigger[N].EVENT_ID","Occurs when an edge is detected on a TSP‑Link line","lan.trigger[N].EVENT_ID","Occurs when the appropriate LXI trigger packet is received on LAN trigger object N","display.trigger.EVENT_ID","Occurs when the TRIG key on the front panel is pressed","trigger.EVENT_ID","Occurs when a *TRG command is received on the remote interface","GPIB only: Occurs when a GET bus command is received","VXI-11 only: Occurs with the VXI-11 command device_trigger; reference the VXI-11 standard for additional details on the device trigger operation","trigger.blender[N].EVENT_ID","Occurs after a collection of events is detected","trigger.timer[N].EVENT_ID","Occurs when a delay expires","* Use the name of the trigger event ID to set the stimulus value rather than the numeric value. Using the name makes the code compatible for future upgrades (for example, if the numeric values must change when enhancements are added to the instrument).","Example","print(tsplink.trigger[3].stimulus)","Prints the event that will start TSP-Link trigger line 3 action.","Also see","tsplink.trigger[N].assert()","tsplink.trigger[N].reset()","tsplink.trigger[N].stimulus","17682.html");
+Page[463]=new Array("This function waits for a trigger.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","triggered = tsplink.trigger[N].wait(timeout)","triggered","Trigger detection indication; set to one of the following values:","true: A trigger is detected during the timeout period","false: A trigger is not detected during the timeout period","N","The trigger line (1 to 3)","timeout","The timeout value in seconds","Details","This function waits up to the timeout value for an input trigger. If one or more trigger events were detected since the last time tsplink.trigger[N].wait() or tsplink.trigger[N].clear() was called, this function returns immediately.","After waiting for a trigger with this function, the event detector is automatically reset and rearmed. This is true regardless of the number of events detected.","Example","triggered = tsplink.trigger[3].wait(10)","print(triggered)","Waits up to 10 seconds for a trigger on TSP-Link® line 3.","If false is returned, no trigger was detected during the 10-second timeout.","If true is returned, a trigger was detected.","Also see","tsplink.trigger[N].clear()","tsplink.trigger[N].wait()","15300.html");
+Page[464]=new Array("This function sets a TSP-Link synchronization line high or low.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","tsplink.writebit(N, data)","N","The trigger line (1 to 3)","data","The value to write to the bit:","Low: 0","High: 1","Details","Use tsplink.writebit() and tsplink.writeport() to control the output state of the trigger line when trigger operation is set to tsplink.TRIG_BYPASS.","If the output line is write‑protected by the tsplink.writeprotect attribute, this command is ignored.","The reset function does not affect the present states of the TSP-Link trigger lines.","Example","tsplink.writebit(3, 0)","Sets trigger line 3 low (0).","Also see","tsplink.readbit()","tsplink.readport()","tsplink.writeport()","tsplink.writeprotect","tsplink.writebit()","15301.html");
+Page[465]=new Array("This function writes to all TSP‑Link synchronization lines.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","tsplink.writeport(data)","data","Value to write to the port (0 to 7)","Details","The binary representation of data indicates the output pattern that is written to the I/O port. For example, a data value of 2 has a binary equivalent of 010. Line 2 is set high (1), and the other two lines are set low (0).","Write‑protected lines are not changed.","The reset() function does not affect the present states of the trigger lines.","Use the tsplink.writebit() and tsplink.writeport() commands to control the output state of the synchronization line when trigger operation is set to tsplink.TRIG_BYPASS.","Example","tsplink.writeport(3)","Sets the synchronization lines 1 and 2 high (binary 011).","Also see","tsplink.readbit()","tsplink.readport()","tsplink.writebit()","tsplink.writeprotect","tsplink.writeport()","15302.html");
+Page[466]=new Array("This attribute contains the write‑protect mask that protects bits from changes by the tsplink.writebit() and tsplink.writeport() functions.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Recall setup","Saved setup ","0","Usage","mask = tsplink.writeprotect","tsplink.writeprotect = mask","mask","An integer that specifies the value of the bit pattern for write‑protect; set bits to 1 to write‑protect the corresponding TSP-Link trigger line","Details","The binary equivalent of mask indicates the mask to be set for the TSP-Link trigger line. For example, a mask value of 5 has a binary equivalent of 101. This mask write‑protects TSP-Link trigger lines 1 and 3.","Example","tsplink.writeprotect = 5","Write‑protects TSP-Link trigger lines 1 and 3.","Also see","Controlling digital I/O lines","tsplink.readbit()","tsplink.readport()","tsplink.writebit()","tsplink.writeport()","tsplink.writeprotect","17630.html");
+Page[467]=new Array("This function clears any pending output data from the instrument.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","tspnet.clear(connectionID)","connectionID","The connection ID returned from tspnet.connect()","Details","This function clears any pending output data from the device. No data is returned to the caller and no data is processed.","Example","tspnet.write(testdevice, "print([[hello]])")","print(tspnet.readavailable(testdevice))","tspnet.clear(testdevice)","print(tspnet.readavailable(testdevice))","Write data to a device, then print how much is available.","Output:","6.00000e+00","Clear data and print how much data is available again.","Output:","0.00000e+00","Also see","tspnet.connect()","tspnet.readavailable()","tspnet.write()","tspnet.clear()","14073.html");
+Page[468]=new Array("This function connects the device processing the command to another device through the LAN interface.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","connectionID = tspnet.connect(ipAddress)","connectionID = tspnet.connect(ipAddress, portNumber, initString)","connectionID","The connection ID to be used as a handle in all other tspnet function calls","ipAddress","IP address to which to connect","portNumber","Port number (default 5025)","initString","Initialization string to send to ipAddress","Details","This command connects a device to another device through the LAN interface. If the portNumber is 23, the interface uses the Telnet protocol and sets appropriate termination characters to communicate with the device.","If a portNumber and initString are provided, it is assumed that the remote device is not TSP‑enabled. The Model 2657A does not perform any extra processing, prompt handling, error handling, or sending of commands. Additionally, the tspnet.tsp.* commands cannot be used on devices that are not TSP‑enabled.","If neither a portNumber nor an initString is provided, the remote device is assumed to be a Keithley Instruments TSP‑enabled device. Depending on the state of the tspnet.tsp.abortonconnect attribute, the Model 2657A sends an abort command to the remote device on connection. ","The Model 2657A also enables TSP prompts on the remote device and error management. The Model 2657A places remote errors from the TSP‑enabled device in its own error queue and prefaces these errors with Remote Error, followed by an error description. ","Do not manually change either the prompt functionality (localnode.prompts) or show errors by changing localnode.showerrors on the remote TSP-enabled device, or subsequent tspnet.tsp.* commands using the connection may fail.","You can simultaneously connect to a maximum of 32 remote devices.","Example 1","instrumentID = tspnet.connect("192.0.2.1")","if instrumentID then"," -- Use instrumentID as needed here"," tspnet.disconnect(instrumentID)","end","Connect to a TSP-enabled device.","Example 2","instrumentID = tspnet.connect("192.0.2.1", 1394, "*rst\\r\\n")","if instrumentID then"," -- Use instrumentID as needed here"," tspnet.disconnect(instrumentID)","end","Connect to a device that is not TSP‑enabled.","Also see","localnode.prompts","localnode.showerrors","tspnet.tsp.abortonconnect","tspnet.disconnect()","tspnet.connect()","14074.html");
+Page[469]=new Array("This function disconnects a specified TSP-Net session.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","tspnet.disconnect(connectionID)","connectionID","The connection ID returned from tspnet.connect()","Details","This function disconnects the two devices by closing the connection. The connectionID is the session handle returned by tspnet.connect().","For TSP-enabled devices, this aborts any remotely running commands or scripts.","Example","testID = tspnet.connect("192.0.2.0")","-- Use the connection","tspnet.disconnect(testID)","Create a TSP‑Net session.","Close the session.","Also see","tspnet.connect()","tspnet.disconnect()","14076.html");
+Page[470]=new Array("This function executes a command string on the remote device.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","tspnet.execute(connectionID, commandString)","value1 = tspnet.execute(connectionID, commandString, formatString)","value1, value2 = tspnet.execute(connectionID, commandString, formatString)","value1, ..., valuen = tspnet.execute(connectionID, commandString, formatString)","connectionID","The connection ID returned from tspnet.connect()","commandString","The command to send to the remote device","value1","The first value decoded from the response message","value2","The second value decoded from the response message","valuen","The nth value decoded from the response message; there is one return value per format specifier in the format string","...","One or more values separated with commas","formatString","Format string for the output","Details","This command sends the command string to the remote instrument. A termination is added to the command string when it is sent to the remote instrument (tspnet.termination()). You can also specify a format string, which causes the command to wait for a response from the remote instrument. The Model 2657A decodes the response message according to the format specified in the format string and returns the message as return values from the function (see tspnet.read() for format specifiers).","When this command is sent to a TSP-enabled instrument, the Model 2657A suspends operation until a timeout error is generated or until the instrument responds, even if no format string is specified. The TSP prompt from the remote instrument is read and thrown away. The Model 2657A places any remotely generated errors into its error queue. When the optional format string is not specified, this command is equivalent to tspnet.write(), except that a termination is automatically added to the end of the command.","Example 1","tspnet.execute(instrumentID, "runScript()")","Command remote device to run script named runScript.","Example 2","tspnet.termination(instrumentID, tspnet.TERM_CRLF)","tspnet.execute(instrumentID, "*idn?")","print("tspnet.execute returns:", tspnet.read(instrumentID))","Print the *idn? string from the remote device.","Also see","tspnet.connect()","tspnet.read()","tspnet.termination()","tspnet.write()","tspnet.execute()","14077.html");
+Page[471]=new Array("This function retrieves the response of the remote device to *IDN?.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","idnString = tspnet.idn(connectionID)","idnString","The returned *IDN? string","connectionID","The connection ID returned from tspnet.connect()","Details","This function retrieves the response of the remote device to *IDN?.","Example","deviceID = tspnet.connect("192.0.2.1")","print(tspnet.idn(deviceID))","tspnet.disconnect(deviceID)","Assume the instrument at IP address 192.0.2.1.","The output from connecting to the instrument and reading the IDN string may appear as:","Keithley Instruments Inc., Model 2657A, 00000170, 1.1.0","Also see","tspnet.connect()","tspnet.idn()","14078.html");
+Page[472]=new Array("This function reads data from a remote device.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","value1 = tspnet.read(connectionID)","value1 = tspnet.read(connectionID, formatString)","value1, value2 = tspnet.read(connectionID, formatString)","value1, ..., valueN = tspnet.read(connectionID, formatString)","value1","The first value decoded from the response message","value2","The second value decoded from the response message","valueN","The nth value decoded from the response message; there is one return value for each format specifier in the format string","...","One or more values separated with commas","connectionID","The connection ID returned from tspnet.connect()","formatString","Format string for the output, maximum of 10 specifiers","Details","This command reads available data from the remote instrument and returns responses for the specified number of arguments.","The format string can contain the following specifiers:","%[width]s","Read data until the specific length","%[max width]t","Read data until the specific length or delimited by punctuation","%[max width]n","Read data until a newline or carriage return","%d","Read a number (delimited by punctuation)","A maximum of 10 format specifiers can be used for a maximum of 10 return values.","If formatString is not provided, the command returns a string containing the data until a new line is reached. If no data is available, the Model 2657A pauses operation until the requested data is available or until a timeout error is generated. Use tspnet.timeout to specify the timeout period.","When reading from a TSP-enabled remote instrument, the Model 2657A removes Test Script Processor (TSP®) prompts and places any errors received from the remote instrument into its own error queue. The Model 2657A prefaces errors from the remote device with "Remote Error," and follows this with the error number and error description.","Example","tspnet.write(deviceID, "*idn?\\r\\n")","print("write/read returns:", tspnet.read(deviceID))","Send the "*idn?\\r\\n" message to the instrument connected as deviceID.","Display the response that is read from deviceID (based on the *idn? message).","Also see","tspnet.connect()","tspnet.readavailable()","tspnet.timeout","tspnet.write()","tspnet.read()","14079.html");
+Page[473]=new Array("This function checks to see if data is available from the remote device.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","bytesAvailable = tspnet.readavailable(connectionID)","bytesAvailable","The number of bytes available to be read from the connection","connectionID","The connection ID returned from tspnet.connect()","Details","This command checks to see if any output data is available from the device. No data is read from the instrument. This allows TSP scripts to continue to run without waiting on a remote command to finish.","Example","ID = tspnet.connect("192.0.2.1")","tspnet.write(ID, "*idn?\\r\\n")","repeat bytes = tspnet.readavailable(ID) until bytes > 0","print(tspnet.read(ID))","tspnet.disconnect(ID)","Send commands that will create data.","Wait for data to be available.","Also see","tspnet.connect()","tspnet.read()","tspnet.readavailable()","14080.html");
+Page[474]=new Array("This function disconnects all TSP-Net sessions.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","tspnet.reset()","Details","This command disconnects all remote instruments connected through TSP-Net. For TSP-enabled devices, this causes any commands or scripts running remotely to be terminated.","Also see","None","tspnet.reset()","14081.html");
+Page[475]=new Array("This function sets the device line termination sequence.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","type = tspnet.termination(connectionID)","type = tspnet.termination(connectionID, termSequence)","type","An enumerated value indicating the termination type:","1 or tspnet.TERM_LF","4 or tspnet.TERM_CR","2 or tspnet.TERM_CRLF","3 or tspnet.TERM_LFCR","connectionID","The connection ID returned from tspnet.connect()","termSequence","The termination sequence","Details","This function sets and gets the termination character sequence that is used to indicate the end of a line for a TSP-Net connection.","Using the termSequence parameter sets the termination sequence. The present termination sequence is always returned.","For the termSequence parameter, use the same values listed in the table above for type. There are four possible combinations, all of which are made up of line feeds (LF or 0x10) and carriage returns (CR or 0x13). For TSP-enabled devices, the default is tspnet.TERM_LF. For devices that are not TSP‑enabled, the default is tspnet.TERM_CRLF.","Example","deviceID = tspnet.connect("192.0.2.1")","if deviceID then"," tspnet.termination(deviceID, tspnet.TERM_LF)","end","Sets termination type for IP address 192.0.2.1 to TERM_LF.","Also see","tspnet.connect()","tspnet.disconnect()","tspnet.termination()","14082.html");
+Page[476]=new Array("This attribute sets the timeout value for the tspnet.connect(), tspnet.execute(), and tspnet.read() commands.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Recall setup","Not saved ","20.0 (20 s)","Usage","value = tspnet.timeout","tspnet.timeout = value","value","The timeout duration in seconds (0.001 s to 30.000 s)","Details","This attribute sets the amount of time the tspnet.connect(), tspnet.execute(), and tspnet.read() commands will wait for a response.","The time is specified in seconds. The timeout may be specified to millisecond resolution, but is only accurate to the nearest 10 ms.","Example","tspnet.timeout = 2.0","Sets the timeout duration to two seconds.","Also see","tspnet.connect()","tspnet.execute()","tspnet.read()","tspnet.timeout","14084.html");
+Page[477]=new Array("This function causes the TSP-enabled instrument to stop executing any of the commands that were previously sent to it.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","tspnet.tsp.abort(connectionID)","connectionID","Integer value used as a handle for other tspnet commands","Details","This function is appropriate only for TSP-enabled instruments.","Sends an abort command to the remote instrument.","Example","tspnet.tsp.abort(testConnection)","Stops remote instrument execution on testConnection.","Also see","None","tspnet.tsp.abort()","14085.html");
+Page[478]=new Array("This attribute contains the setting for abort on connect to a TSP-enabled instrument.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Attribute (RW)","Yes","Instrument reset Recall setup","Not saved ","1 (enable)","Usage","tspnet.tsp.abortonconnect = value","value = tspnet.tsp.abortonconnect","value","1 (enable) or 0 (disable)","Details","This setting determines if the instrument sends an abort message when it attempts to connect to a TSP‑enabled instrument using the tspnet.connect() function.","When you send the abort command on an interface, it causes any other active interface on that instrument to close. If you do not send an abort command (or if tspnet.tsp.abortonconnect is set to 0) and another interface is active, connecting to a TSP‑enabled remote instrument results in a connection. However, the instrument will not respond to subsequent reads or executes because control of the instrument is not obtained until an abort command has been sent. See Communication interfaces.","Example","tspnet.tsp.abortonconnect = 0","Configure the instrument so that it does not send an abort command when connecting to a TSP‑enabled instrument.","Also see","tspnet.connect()","tspnet.tsp.abortonconnect","14086.html");
+Page[479]=new Array("This function copies a reading buffer synchronous table from a remote instrument to a TSP-enabled instrument.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","table = tspnet.tsp.rbtablecopy(connectionID, name)","table = tspnet.tsp.rbtablecopy(connectionID, name, startIndex, endIndex)","table","A copy of the synchronous table or a string","connectionID","Integer value used as a handle for other tspnet commands","name","The full name of the reading buffer name and synchronous table to copy","startIndex","Integer start value","endIndex","Integer end value","Details","This function is only appropriate for TSP-enabled instruments.","This function reads the data from a reading buffer on a remote instrument and returns an array of numbers or a string representing the data. The startIndex and endIndex parameters specify the portion of the reading buffer to read. If no index is specified, the entire buffer is copied. ","The function will return a table if the table is an array of numbers; otherwise a comma‑delimited string is returned.","This command is limited to transferring 50,000 readings at a time.","Example","t = tspnet.tsp.rbtablecopy(testConnection,"," "testRemotebuffername.readings", 1, 3)","print(t[1], t[2], t[3])","Copy the specified readings table for buffer items 1 through 3, then display the first three readings. Sample output:","4.56534e-01","4.52675e-01","4.57535e-01","Also see","None","tspnet.tsp.rbtablecopy()","14090.html");
+Page[480]=new Array("This function loads and runs a script on a remote TSP-enabled instrument.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","tspnet.tsp.runscript(connectionID, script)","tspnet.tsp.runscript(connectionID, name, script)","connectionID","Integer value used as an identifier for other tspnet commands","name","The name that is assigned to the script","script","The body of the script as a string","Details","This function is appropriate only for TSP-enabled instruments.","This function downloads a script to a remote instrument and runs it. It automatically adds the appropriate loadscript and endscript commands around the script, captures any errors, and reads back any prompts. No additional substitutions are done on the text.","The script is automatically loaded, compiled, and run.","Any output from previous commands is discarded.","This command does not wait for the script to complete.","If you do not want the script to do anything immediately, make sure the script only defines functions for later use. Use the tspnet.execute() function to execute those functions at a later time.","If no name is specified, the script will be loaded as the anonymous script.","Example","tspnet.tsp.runscript(myconnection, "mytest",",""print([[start]]) for d = 1, 10 do print([[work]]) end print([[end]])")","Load and run a script entitled mytest on the TSP‑enabled instrument connected with myconnection.","Also see","tspnet.execute()","tspnet.tsp.runscript()","15280.html");
+Page[481]=new Array("This function writes a string to the remote instrument.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","tspnet.write(connectionID, inputString)","connectionID","The connection ID returned from tspnet.connect()","inputString","The string to be written","Details","The tspnet.write() function sends inputString to the remote instrument. It does not wait for command completion on the remote instrument.","The Model 2657A sends inputString to the remote instrument exactly as indicated. The inputString must contain any necessary new lines, termination, or other syntax elements needed to complete properly.","Because tspnet.write() does not process output from the remote instrument, do not send commands that generate too much output without processing the output. This command can stop executing if there is too much unprocessed output from previous commands.","Example","tspnet.write(myID, "runscript()\\r\\n")","Commands the remote instrument to execute a command or script named "runscript()" on a remote device identified in the system as myID.","Also see","tspnet.connect()","tspnet.read()","tspnet.write()","14089.html");
+Page[482]=new Array("This function adds a user-defined string to nonvolatile memory.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","userstring.add(name, value)","name","The name of the string; the key of the key-value pair","value","The string to associate with name; the value of the key-value pair","Details","This function associates the string value with the string name and stores this key-value pair in nonvolatile memory.","Use the userstring.get() function to retrieve the value associated with the specified name.","Example","userstring.add("assetnumber", "236")","userstring.add("product", "Widgets")","userstring.add("contact", "John Doe")","Stores user-defined strings in nonvolatile memory.","Also see","userstring.catalog()","userstring.delete()","userstring.get()","userstring.add()","13987.html");
+Page[483]=new Array("This function creates an iterator for the user string catalog.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","for name in userstring.catalog() do body end","name","The name of the string; the key of the key-value pair","body","Code to execute in the body of the for loop","Details","The catalog provides access for userstring pairs, allowing you to manipulate all the key-value pairs in nonvolatile memory. The entries are enumerated in no particular order.","Example 1","for name in userstring.catalog() do"," userstring.delete(name)","end","Deletes all user strings in nonvolatile memory.","Example 2","for name in userstring.catalog() do"," print(name .. " = " .."," userstring.get(name))","end","Prints all userstring key‑value pairs.","Output:","product = Widgets","assetnumber = 236","contact = John Doe","The above output lists the user strings added in the example for the userstring.add() function. Notice the key-value pairs are not listed in the order they were added.","Also see","userstring.add()","userstring.delete()","userstring.get()","userstring.catalog()","13988.html");
+Page[484]=new Array("This function deletes a user-defined string from nonvolatile memory.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","userstring.delete(name)","name","The name (key) of the key-value pair of the userstring to delete","Details","This function deletes the string that is associated with name from nonvolatile memory.","Example","userstring.delete("assetnumber")","userstring.delete("product")","userstring.delete("contact")","Deletes the user-defined strings associated with the "assetnumber", "product", and "contact" names.","Also see","userstring.add()","userstring.catalog()","userstring.get()","userstring.delete()","13989.html");
+Page[485]=new Array("This function retrieves a user-defined string from nonvolatile memory.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","Yes","Usage","value = userstring.get(name)","value","The value of the userstring key-value pair","name","The name (key) of the userstring","Details","This function retrieves the string that is associated with name from nonvolatile memory.","Example","value = userstring.get("assetnumber")","print(value)","Read the value associated with a user-string named "assetnumber".","Store it in a variable called value, then print the variable value.","Output:","236","Also see","userstring.add()","userstring.catalog()","userstring.delete()","userstring.get()","13990.html");
+Page[486]=new Array("This function waits for all overlapped commands in a specified group to complete.","Type","TSP-Link accessible","Affected by","Where saved","Default value","Function","No","Usage","waitcomplete()","waitcomplete(group)","group","Specifies which TSP-Link group on which to wait","Details","This function will wait for all previously started overlapped commands to complete.","A group number may only be specified when this node is the master node.","If no group is specified, the local group is used.","If zero (0) is specified for the group, this function waits for all nodes in the system.","@ Any nodes that are not assigned to a group (group number is 0) are part of the master node's group.","Example 1","waitcomplete()","Waits for all nodes in the local group.","Example 2","waitcomplete(G)","Waits for all nodes in group G.","Example 3","waitcomplete(0)","Waits for all nodes on the TSP-Link network.","Also see","None","waitcomplete()","13986.html");
+Page[487]=new Array("See the "2-wire local sensing connections" topic in the Model 2657A reference manual.","2-wire local sensing connections","19568.html");
+Page[488]=new Array("See the "4-wire remote sensing connections" topic in the Model 2657A reference manual.","4-wire remote sensing connections","19569.html");
+Page[489]=new Array("See the "Adjustment" topic in the Model 2657A reference manual.","Adjustment","19563.html");
+Page[490]=new Array("The Model 2657A has two analog-to-digital converters (ADC): An integrating ADC and a fast ADC.","The integrating ADC uses a ratiometric analog-to-digital conversion technique. Depending on the configuration of the integrating ADC, periodic fresh reference measurements are required to minimize drift. The measurement aperture is used to determine the time interval between these measurement updates. For additional information, see Autozero. To help optimize operation of this ADC, the instrument caches the reference and zero values for up to ten of the most recent number of power line cycles. For additional information, see NPLC caching.","The fast ADC can acquire measurements at speeds up to 1 million samples per second. The fast ADC does not take reference measurements. A reading measurement acquisition buffer allows up to 5,000 readings to be made at the maximum acquisition rate of the fast ADCs. If this buffer is filled, the instrument slows its acquisition rate to the rate at which the instrument can process the data.","Data acquisition takes priority over both source operation and display operation. Sustained high data acquisition rates will cause the display to stop updating. A sustained high data acquisition rate during a sweep or pulse train may slow source operations. This can cause erratic sweep or pulse timing and may lead to triggers being missed (trigger overruns). Use the status model to monitor for trigger overruns. If a high sustained data acquisition rate causes undesirable sweep or pulse timing, reduce the data acquisition rate or reduce the total number of measurements until the desired sweep or pulse timing is achieved.","Analog-to-digital converter","18560.html");
+Page[491]=new Array("The integrating ADC of the Model 2657A uses a ratiometric A/D conversion technique. To ensure accuracy of readings, the instrument must periodically obtain fresh measurements of its internal ground and voltage reference. Separate reference and zero measurements are used for each aperture.","As summarized in the "Autozero settings" table, there are three different settings for autozero. By default, the instrument automatically checks these reference measurements whenever a signal measurement is made (AUTO). If the reference measurements are out of date when a signal measurement is made, the instrument will automatically take two more A/D conversions, one for the reference and one for the zero, before returning the result. Thus, occasionally, a measurement takes longer than normal.","This extra time can cause problems in sweeps and other test sequences in which measurement timing is critical. To avoid the extra time for the reference measurements in these situations, the OFF selection can be used to disable the automatic reference measurements. Note that with automatic reference measurements disabled, the instrument may gradually drift out of specification.","To minimize the drift, a reference and zero measurement should be made just prior to the critical test sequence. The ONCE setting can be used to force a refresh of the reference and zero measurements used for the current aperture setting.","Autozero settings","Autozero setting","Description","OFF","Turns automatic reference measurements off.","ONCE","After immediately taking one reference and one zero measurement, turns automatic reference measurements off. ","AUTO","Automatically takes new acquisitions when the Model 2657A determines reference and zero values are out-of-date.","Autozero","11440.html");
+Page[492]=new Array("Base library functions","Function","Description","collectgarbage()","collectgarbage(limit)","Sets the garbage-collection threshold to the given limit (in kilobytes) and checks it against the byte counter. If the new threshold is smaller than the byte counter, Lua immediately runs the garbage collector. If there is no limit parameter, it defaults to zero (0), which forces a garbage‑collection cycle. See the "Lua memory management" topic for more information.","gcinfo()","Returns the number of kilobytes of dynamic memory that the Test Script Processor (TSP®) scripting engine is using, and returns the current garbage collector threshold (also in kilobytes). See the "Lua memory management" topic for more information.","tonumber(x)","tonumber(x, base)","Returns x converted to a number. If x is already a number, or a convertible string, the number is returned; otherwise, it returns nil.","An optional argument specifies the base to interpret the numeral. The base may be any integer between 2 and 36, inclusive. In bases above 10, the letter A (in either upper or lower case) represents 10, B represents 11, and so forth, with Z representing 35. In base 10, the default, the number may have a decimal part, as well as an optional exponent. In other bases, only unsigned integers are accepted.","tostring(x)","Receives an argument of any type and converts it to a string in a reasonable format.","type(v)","Returns (as a string) the type of its only argument. The possible results of this function are "nil" (a string, not the value nil), "number", "string", "boolean", "table", "function", "thread", and "userdata".","Base library functions","2430.html");
+Page[493]=new Array("See the "Calibration" topic in the Model 2657A reference manual.","Calibration","19570.html");
+Page[494]=new Array("A history of the key code for the last pressed front panel key is maintained by the Model 2657A. When the instrument is turned on (or when transitioning from local to remote operation), the key code is set to 0 (display.KEY_NONE).","When a front‑panel key is pressed, the key code value for that key can be captured and returned. There are two functions associated with the capture of key-press codes: display.getlastkey() and display.waitkey().","Capturing key-press codes","12125.html");
+Page[495]=new Array("See the "Configuring and running sweeps" topic in the Model 2657A reference manual.","Configuring and running sweeps","19567.html");
+Page[496]=new Array("See the "Contact check connections" topic in the Model 2657A reference manual.","Contact check connections","19564.html");
+Page[497]=new Array("See the "Contact check measurements" topic in the Model 2657A reference manual.","Contact check measurements","19565.html");
+Page[498]=new Array("Although the digital I/O lines are primarily intended for use with a device handler for limit testing, they can also be used for other purposes such as controlling external logic circuits. You can control lines either from the front panel or over a remote interface.","@ The trigger mode for the line must be set to digio.TRIG_BYPASS in order to use the line for digital I/O. See Triggering for more information.","To set digital I/O values from the front panel:","Press the MENU key, select DIGOUT, and then press the ENTER key or press the navigation wheel @.","Select DIG-IO-OUTPUT, and then press the ENTER key or the navigation wheel @.","Set the decimal value as required to set digital I/O lines within the range of 0 to 16,383 (see the table in Digital I/O bit weighting), and then press the ENTER key or the navigation wheel @.","Press the EXIT (LOCAL) key as needed to return to the main menu.","To write-protect specific digital I/O lines to prevent their values from being changed:","Press the MENU key, then select DIGOUT, and then press the ENTER key or the navigation wheel @.","Select WRITE-PROTECT, and then press the ENTER key or the navigation wheel @.","Set the decimal value as required to write‑protect digital I/O lines within the range of 0 to 16,383 (see Digital I/O bit weighting), and then press the ENTER key or the navigation wheel @.","Press the EXIT (LOCAL) key as needed to return to the main menu.","To remove write protection, repeat the above steps, but enter the original value in step 3.","Controlling digital I/O lines","11508.html");
+Page[499]=new Array("See the "Create a script using the script.new() command" topic in the Model 2657A reference manual.","Create a script using the script.new() command","19556.html");
+Page[500]=new Array("@ These steps remove a script from nonvolatile memory. To completely remove a script from the instrument, there are additional steps you must take. See Delete user scripts from the instrument.","You can delete the script from nonvolatile memory by sending either of the following commands:","script.delete("name")","script.user.delete("name")","Where: name is the user-defined name of the script.","To delete a script from nonvolatile memory using TSB Embedded:","In TSB Embedded, select the script from the User Scripts list.","Click Delete. There is no confirmation message.","Example: Delete a user script from nonvolatile memory","script.delete("test8")","Delete a user script named test8 from nonvolatile memory.","Delete user scripts","16805.html");
+Page[501]=new Array("In most circumstances, you can delete a script using script.delete() (as described in Delete user scripts), and then turn the instrument off and back on again. However, if you cannot turn the instrument off, you can use the following steps to completely remove a script from the instrument.","When you completely remove a script, you delete all references to the script from the run-time environment, the script.user.scripts table, and nonvolatile memory.","To completely remove a script:","Remove the script from the run-time environment. Set any variables that refer to the script to nil or assign the variables a different value. For example, to remove the script "beepTwoSec" from the run-time environment, send the following code: beepTwoSec = nil","Remove the script from the script.user.scripts table. Set the name attribute to an empty string (""). This makes the script nameless, but does not make the script become the anonymous script. For example, to remove the script named "beepTwoSec", send the following code: script.user.scripts.beepTwoSec.name = ""","Remove the script from nonvolatile memory. To delete the script from nonvolatile memory, send the command: script.delete("name")","Where name is the name that the script was saved as. For example, to delete beepTwoSec, you would send: script.delete("beepTwoSec")","Delete user scripts from the instrument","2408.html");
+Page[502]=new Array("See the "Digital I/O" topic in the Model 2657A reference manual.","Digital I/O","19553.html");
+Page[503]=new Array("Bit weighting for the digital I/O lines is shown in the following table.","Digital bit weight","Line #","Bit","Decimal weighting","Hexadecimal weighting","1","B1","1","0x0001","2","B2","2","0x0002","3","B3","4","0x0004","4","B4","8","0x0008","5","B5","16","0x0010","6","B6","32","0x0020","7","B7","64","0x0040","8","B8","128","0x0080","9","B9","256","0x0100","10","B10","512","0x0200","11","B11","1024","0x0400","12","B12","2048","0x0800","13","B13","4096","0x1000","14","B14","8192","0x2000","Digital I/O bit weighting","11500.html");
+Page[504]=new Array("The Model 2657A instruments have a digital input/output port that can be used to control external digital circuitry. For example, a handler that is used to perform binning operations can be used with a digital I/O port. The digital I/O port is a standard female DB-25 connector.","Digital I/O port","1401.html");
+Page[505]=new Array("See the "DUT test connections" topic in the Model 2657A reference manual.","DUT test connections","19573.html");
+Page[506]=new Array("The filter feature lets you set the filter response to stabilize noisy measurements. The Model 2657A uses a digital filter, which is based on reading conversions. The displayed, stored, or transmitted reading is calculated using one or more reading conversions (from 1 to 100).","Filters","11532.html");
+Page[507]=new Array("See the "Global variables and the script.user.scripts table" topic in the Model 2657A reference manual.","Global variables and the script.user.scripts table","19557.html");
+Page[508]=new Array("See the "GPIB operation" topic in the Model 2657A reference manual.","GPIB operation","24524.html");
+Page[509]=new Array("See the "High-capacitance mode" topic in the Model 2657A reference manual.","High-capacitance mode","19566.html");
+Page[510]=new Array("See the "Load a script by sending commands over the remote interface" topic in the Model 2657A reference manual.","Load a script by sending commands over the remote interface","19559.html");
+Page[511]=new Array("The logical operators in Lua are and, or, and not. All logical operators consider both false and nil as false and anything else as true.","The operator not always returns false or true.","The conjunction operator and returns its first argument if this value is false or nil; otherwise, and returns its second argument. The disjunction operator or returns its first argument if this value is different from nil and false; otherwise, or returns its second argument. Both and and or use shortcut evaluation, that is, the second operand is evaluated only if necessary.","Example","print(10 or errorqueue.next())","print(nil or "a")","print(nil and 10)","print(false and errorqueue.next())","print(false and nil)","print(false or nil)","print(10 and 20)","1.00000e+01","a","nil","false","false","nil","2.00000e+01","Logical operators","12893.html");
+Page[512]=new Array("The measure delay is a specific delay applied before each measurement is taken. This delay is set to the auto delay by default (see table). You can change the default delay by setting the smuX.measure.delay attribute either to a specific value or to an auto delay setting (set smua.measure.delay = smua.DELAY_AUTO). If the measure delay is set to the auto delay setting, a range-dependent delay is applied each time the instrument performs a current measurement. This delay also happens for the measurement that is taken after changing current ranges during an autoranged measurement. The following table contains the measure auto delays associated with each current range.","Range","Measure auto delay","120 mA","0.1 ms","20 mA","0.1 ms","2 mA","0.5 ms","1 mA","0.5 ms","100 mA","1 ms","10 mA","1 ms","1 mA","2 ms","100 nA","15 ms","10 nA","150 ms","1 nA","1 s","You can increase or decrease the auto delay by changing the delay factor (for example, to reduce the delay across all ranges by half, set smua.measure.delayfactor = 0.5). For additional information, refer to smuX.measure.delayfactor in the "Remote commands" section.","Measure auto delay","19632.html");
+Page[513]=new Array("See the "Measurement event registers" topic in the Model 2657A reference manual.","Measurement event registers","19571.html");
+Page[514]=new Array("See the "Named scripts" topic in the Model 2657A reference manual.","Named scripts","19558.html");
+Page[515]=new Array("See the "Operation Status Registers" topic in the Model 2657A reference manual.","Operation Status Registers","19578.html");
+Page[516]=new Array("@ Do not depend on the output-off state to protect the user. The Model 2657A is provided with an interlock circuit that must be positively activated in order for the high voltage output to be enabled. The interlock helps facilitate safe operation of the equipment in a test system. Bypassing the interlock could expose the operator to hazardous voltages that could result in personal injury or death."," ","@ Carefully consider and configure the appropriate output-off state, source, and compliance levels before connecting the Model 2657A to a device that can deliver energy (for example, other voltage sources, batteries, capacitors, or solar cells). Program recommended instrument settings before making connections to the device. Failure to consider the output-off state, source, and compliance levels may result in damage to the instrument or to the device under test (DUT).","Output-off states","15424.html");
+Page[517]=new Array("See the "Questionable Status Registers" topic in the Model 2657A reference manual.","Questionable Status Registers","19579.html");
+Page[518]=new Array("See the "Queues" topic in the Model 2657A reference manual.","Queues","19552.html");
+Page[519]=new Array("The selected measurement range effects the accuracy of the measurements as well as the maximum signal that can be measured. If the range is changed, the display may contain dashes instead of a reading (for example, --.---- µA). This indicates that no measurement was taken using the current range. To update the displayed reading, trigger a measurement (if in local control, press the TRIG key).","Range","11993.html");
+Page[520]=new Array("Reading buffers capture measurements, ranges, instrument status, and output state of the Keithley Instruments Model 2657A. The Model 2657A has two dedicated reading buffers. You can use the dedicated reading buffers to acquire readings, or you can use the smua.makebuffer() function to create dynamic reading buffers.","@ You can access dedicated reading buffers from the front panel; both dedicated and dynamic reading buffers can be accessed over the remote command interface.","Each dedicated reading buffer in the Model 2657A can store over 60,000 readings with the timestamps and source values options enabled. To store over 140,000 readings internally, disable the timestamps and source values options.","You can save the dedicated reading buffers to internal nonvolatile memory in the instrument or to a USB flash drive.","Once you save the reading buffers to a USB flash drive, insert the USB flash drive into the USB port on your computer to view the data in any compatible data analysis application, or to transfer the data from the USB flash drive to your computer.","@ Reading buffers (other than the dedicated reading buffers) have fixed capacity and are not specifically limited to 60,000 or 140,000 readings.","Reading buffers","13629.html");
+Page[521]=new Array("The relative offset (REL) feature can be used to set offsets to zero (0) or subtract a baseline reading from present and future readings. With relative offset enabled, subsequent readings are the difference between the actual input value and the relative offset value, as follows:","Displayed reading = Actual input - Relative offset value","Once a relative offset value is established for a measurement function, the value is the same for all ranges. For example, if 50 mA is set as a relative offset value on the 120 mA range, the relative offset value is also 50 mA on the lower current ranges. This can cause an overflow condition if the selected range cannot accommodate the relative offset value.","When relative offset is enabled, the REL indicator turns on. Changing measurement functions changes the relative offset value to the established relative offset value and state for that measurement function.","Relative offset","12001.html");
+Page[522]=new Array("Readings can be obtained by taking overlapped or non-overlapped measurements. Routines that make single‑point measurements can be configured to make multiple measurements where one would ordinarily be made. The measured value is not the only component of a reading. The measurement status (for example, “In Compliance” or “Overranged”) is also an element of data associated with a particular reading.","All routines that return measurements can also store the measurements in the reading buffers. Overlapped measurements always return readings in a reading buffer. Non-overlapped measurement functions can return single-point measurement values or store multiple values in a reading buffer.","A reading buffer is based on a Lua table. The measurements are accessed by ordinary array accesses. If rb is a reading buffer, the first measurement is accessed as rb[1] and the 9th measurement as rb[9], and so on. The additional information in the table is accessed as additional members of the table.","The load, save, and write operations for reading buffers function differently in the remote state. From a remote command interface, you can extract data from reading buffers as the instrument acquires the data.","Remote reading buffer programming","11655.html");
+Page[523]=new Array("The node that acquires the data stores the data for the reading buffer. To optimize data access, all nodes can cache data from the node that stores the reading buffer data.","Running Lua code remotely can cause reading buffer data that is held in the cache to become stale. If the values in the reading buffer change while the Lua code runs remotely, another node can hold stale values. Use the clearcache() command to clear the cache. For additional detail on the reading buffer cache commands, see bufferVar.cachemode and bufferVar.clearcache().","The following example code demonstrates how stale values occur and how to use the clearcache() command to clear the cache on node 2, which is part of group 7.","-- Create a reading buffer on a node in a remote group.","node[2].tsplink.group = 7","node[2].execute("rbremote = smua.makebuffer(20) " .."," "smua.measure.count = 20 " .."," "smua.measure.v(rbremote)")","-- Create a variable on the local node to","-- access the reading buffer.","rblocal = node[2].getglobal("rbremote")","-- Access data from the reading buffer.","print(rblocal[1])","-- Run code on the remote node that updates the reading buffer.","node[2].execute("smua.measure.v(rbremote)")","-- Use the clearcache command if the reading buffer contains cached data.","rblocal.clearcache()","-- If you do not use the clearcache command, the data buffer","-- values will never update. Every time the print command is","-- issued after the first print command, the same data buffer","-- values will print.","print(rblocal[1])","Removing stale values from the reading buffer cache","3249.html");
+Page[524]=new Array("See the "Rename a script" topic in the Model 2657A reference manual.","Rename a script","19560.html");
+Page[525]=new Array("To retrieve the source code one line at a time, send the scriptVar.list() command. When this command is received, the instrument sends the entire script. Each line of the script is sent as a separate response message. The output includes the loadscript or loadandrunscript and endscript keywords.","After retrieving the source code, you can modify and save the command lines as a user script under the same name or a new name.","To retrieve the source code of a script one line at a time, send the command:","scriptVar.list()","Where scriptVar is the name of the script.","@ To retrieve the commands in the anonymous script, use script.anonymous.list().","Example: Retrieve source code one line at a time","test.list()","Retrieve the source of a script named "test".","The output will look similar to:","loadscript","display.clear()","display.settext("This is a test")","print("This is a test")","endscript ","Retrieve source code one line at a time","17030.html");
+Page[526]=new Array("See the "RS-232 interface operation" topic in the Model 2657A reference manual.","RS-232 interface operation","19561.html");
+Page[527]=new Array("You can save scripts to nonvolatile memory using commands or TSB Embedded.","Only named scripts can be saved to nonvolatile memory. The anonymous script must be named before it can be saved to nonvolatile memory.","@ If a script is not saved to nonvolatile memory, the script is lost when the instrument is turned off.","Save a user script","16803.html");
+Page[528]=new Array("The sense mode can be set to use 2-wire local sensing connections or 4-wire remote sensing connections.","@ The default sense setting is 2-wire local.","Sense mode selection","11848.html");
+Page[529]=new Array("There are two ways to adjust a value: the Navigation wheel method or Numeric entry method (using the keypad).","Navigation wheel method:","Use the CURSOR arrow keys (or turn the navigation wheel @) to move the cursor to the desired digit.","Press the navigation wheel @ or the ENTER key to enter edit mode. The EDIT indicator is illuminated.","Rotate the navigation wheel @ to set the appropriate value.","Press the ENTER key to select the value or press the EXIT (LOCAL) key to cancel the change.","(Optional) Press the EXIT (LOCAL) key to return to the main menu.","Numeric entry method:","@ The numeric entry method may only be used if the numeric keypad is enabled.","@ To set a value to zero, press the 0000 numeric entry key. To toggle the polarity of a value, press the +/– numeric entry key.","If the keypad is disabled, press the MENU key, then select DISPLAY > NUMPAD > ENABLE.","Use the CURSOR arrow keys (or turn the navigation wheel @) to move the cursor to the value that you want to edit.","Press the navigation wheel @ or the ENTER key to enter edit mode. The EDIT indicator is illuminated.","Press any of the desired number keys (0-9, +/-, 0000) (see 2. SMU setup, performance control, special operation, and numbers). The cursor moves to the next value on the right.","Repeat the above steps as required to set the desired values.","Press the ENTER key to select the value or press the EXIT (LOCAL) key to cancel change.","(Optional) Press the EXIT (LOCAL) key to return to the main menu.","Setting a value","11815.html");
+Page[530]=new Array("Depending on how it is programmed and what is connected to the output (load or source), the instrument can operate in any of the four quadrants. The four quadrants of operation are shown in the continuous operating boundaries figures. When operating in the first (I) or third (III) quadrant, the instrument is operating as a source (V and I have the same polarity). As a source, the instrument is delivering power to a load.","When operating in the second (II) or fourth (IV) quadrant, the instrument is operating as a sink (V and I have opposite polarity). As a sink, it is dissipating power rather than sourcing it. An external source or an energy storage device, such as a capacitor or battery, can force operation in the sink region.","Source or sink","11584.html");
+Page[531]=new Array("See the "Source-measure concepts" topic in the Model 2657A reference manual.","Source-measure concepts","19572.html");
+Page[532]=new Array("The Model 2657A has two analog-to-digital converters (ADC): one integrating, one high speed. Fastest reading rates are achieved by selecting the fast ADC. You can select the fast ADC by pressing the SPEED key and choosing the FAST option.","You can also use the SPEED key to select the integrating ADC and set the period of time the input signal is measured (this is called the integration time or measurement aperture). The integration time affects the usable digits, the amount of reading noise, and the reading rate of the instrument. The integration time is specified in parameters based on the number of power line cycles (NPLC), where 1 PLC for 60 Hz is 16.67 ms (1/60) and 1 PLC for 50 Hz is 20 ms (1/50).","In general, the fastest integration time (0.001 PLC) results in the fastest reading rate for the integrating ADC, but also causes increased reading noise and fewer usable digits. The slowest integration time (25 PLC) provides the best common-mode and normal-mode noise rejection, but has the slowest reading rate. Settings between the fastest and slowest integration times are a compromise between speed and noise. The default power‑on speed setting is NORMAL (1 PLC).","Speed","11998.html");
+Page[533]=new Array("See the "Standard Event Register" topic in the Model 2657A reference manual.","Standard Event Register","19580.html");
+Page[534]=new Array("You can specify the Model 2657A start-up (power-on) configuration. Use the setup.poweron attribute to select which setup to return to upon power-up. To set the setup.poweron configuration attribute:","setup.poweron = n -- Select power-on setup.","Where:","n","=","0 (*RST/reset() factory defaults)","n","=","1 to 5 (user setups 1-5)","Start-up (power-on) configuration","11613.html");
+Page[535]=new Array("See the "Status byte and service request (SRQ)" topic in the Model 2657A reference manual.","Status byte and service request (SRQ)","19576.html");
+Page[536]=new Array("See the "Status model" topic in the Model 2657A reference manual.","","19551.html");
+Page[537]=new Array("See the "Status model overview" topic in the Model 2657A reference manual.","Status model overview","19575.html");
+Page[538]=new Array("See the "Sweep operation" topic in the Model 2657A reference manual.","Sweep operation","19550.html");
+Page[539]=new Array("See the "System summary and standard event registers" topic in the Model 2657A reference manual.","System summary and standard event registers","19581.html");
+Page[540]=new Array("See the "Triggering" topic in the Model 2657A reference manual.","Triggering","19574.html");
+Page[541]=new Array("See the "TSP advanced features" topic in the Model 2657A reference manual.","TSP advanced features","19555.html");
+Page[542]=new Array("See the "TSP-Link" topic in the Model 2657A reference manual.","TSP-Link","19554.html");
+Page[543]=new Array("The Model 2657A has three synchronization lines that you can use for triggering, digital I/O, and to synchronize multiple instruments on a TSP-Link® network.","TSP-Link synchronization lines","12458.html");
+Page[544]=new Array("See the "User setup" topic in the Model 2657A reference manual.","User setup","19562.html");
+var PageCount=545;
+
+function search(SearchWord){
+var Result="";
+var NrRes=0;
+Result='\n';
+Result+="\n";
+Result+="\n";
+Result+="\n";
+Result+="Search Results\n";
+Result+='\n';
+Result+='\n';
+Result+="\n";
+Result+="\n";
+Result+="\n";
+Result+='
+
+
\ No newline at end of file
diff --git a/WebHelpDocs/Commands_2657A/warninghelp.wmf b/WebHelpDocs/Commands_2657A/warninghelp.wmf
new file mode 100644
index 0000000..6444f24
Binary files /dev/null and b/WebHelpDocs/Commands_2657A/warninghelp.wmf differ
.
.png)
+
+
