[python source code]

smu2460_commands

The SMU2460 commands module.

THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED.

Please report an issue if one is found.

SMU2460CommandConstants

The SMU2460 command argument constants.

This provides access to all the string constants which can be used as arguments for SMU2460 commands.

SMU2460Commands

The SMU2460 commands.

This provides access to all the commands for the SMU2460 device. See the documentation of each property for more usage information.

Properties and methods
  • .available(): The available() function.
  • .beeper: The beeper command tree.
  • .buffer_var: The bufferVar command tree.
  • .buffer: The buffer command tree.
  • .createconfigscript(): The createconfigscript() function.
  • .dataqueue: The dataqueue command tree.
  • .delay(): The delay() function.
  • .digio: The digio command tree.
  • .display: The display command tree.
  • .eventlog: The eventlog command tree.
  • .exit(): The exit() function.
  • .file: The file command tree.
  • .format: The format command tree.
  • .fs: The fs command tree.
  • .gpib: The gpib command tree.
  • .lan: The lan command tree.
  • .localnode: The localnode command tree.
  • .node: The node[N] command tree.
  • .opc(): The opc() function.
  • .print(): The print() function.
  • .printbuffer(): The printbuffer() function.
  • .printnumber(): The printnumber() function.
  • .reset(): The reset() function.
  • .script_var: The scriptVar command tree.
  • .script: The script command tree.
  • .smu: The smu command tree.
  • .status: The status command tree.
  • .timer: The timer command tree.
  • .trigger: The trigger command tree.
  • .tsplink: The tsplink command tree.
  • .tspnet: The tspnet command tree.
  • .upgrade: The upgrade command tree.
  • .userstring: The userstring command tree.
  • .waitcomplete(): The waitcomplete() function.

beeper property 

beeper: Beeper

Return the beeper command tree.

Sub-properties and sub-methods
  • .beep(): The beeper.beep() function.

buffer property 

buffer: Buffer

Return the buffer command tree.

Constants
  • .COL_ALL: Save all data from the specified reading buffer.
  • .COL_BRIEF: Save reading and relative time data from the specified reading buffer.
  • .COL_DISPLAY_DIGITS: Save display digits from the specified reading buffer.
  • .COL_EXTRA: Relative time and additional values if they exist (such as the sense voltage from a dc voltage ratio measurement).
  • .COL_EXTRA_RANGE: Save sxtra value range digits from the specified reading buffer.
  • .COL_EXTRA_UNIT: Save extra value units from the specified reading buffer.
  • .COL_EXTRA_VALUE: Save extra values from the specified reading buffer.
  • .COL_INDEX: Save index into buffer from the specified reading buffer.
  • .COL_LIMITS: The status of all limits.
  • .COL_MATH: Math enabled (F is math is not enabled; T if math is enabled) and relative time.
  • .COL_ORIGIN: Save origin status from the specified reading buffer.
  • .COL_QUESTIONABLE: Save questionable status from the specified reading buffer.
  • .COL_RANGE_DIGITS: Save range digits from the specified reading buffer.
  • .COL_READING: Save the measurement reading from the specified reading buffer.
  • .COL_STANDARD: Save the relative time, reading, channel, and source value from the specified reading buffer.
  • .COL_START: Save the status of the start group from the specified reading buffer.
  • .COL_STATUS: Save the status information associated with the measurement from the specified reading buffer.
  • .COL_TERMINAL: Save the terminal status from the specified reading buffer.
  • .COL_TIMESTAMP_READING: Save the timestamp reading from the specified reading buffer.
  • .COL_TIME_ABSOLUTE: Save the time when the data point was measured as an absolute from the specified reading buffer.
  • .COL_TIME_PARTS: Save absolute time in multiple columns from the specified reading buffer.
  • .COL_TIME_RAW: Save absolute time in seconds from the specified reading buffer.
  • .COL_TIME_RELATIVE: Save the relative time when the data point was measured in seconds from the specified reading buffer.
  • .COL_UNIT: Save the reading and the unit of measure from the specified reading buffer.
  • .DIGITS_3_5: The number of digits to use for the first measurement.
  • .DIGITS_4_5: The number of digits to use for the first measurement.
  • .DIGITS_5_5: The number of digits to use for the first measurement.
  • .DIGITS_6_5: The number of digits to use for the first measurement.
  • .DIGITS_7_5: The number of digits to use for the first measurement.
  • .DIGITS_8_5: The number of digits to use for the first measurement.
  • .EXPR_ADD: Add the present and previous measurements.
  • .EXPR_AVERAGE: Average the present and previous measurements.
  • .EXPR_DIVIDE: Divide the present reading by the previous reading.
  • .EXPR_EXPONENT: Exponent (10^present reading).
  • .EXPR_LOG10: Log10 (log10(present reading)).
  • .EXPR_MULTIPLY: Multiply the present and previous measurements.
  • .EXPR_NONE: Remove the math expression.
  • .EXPR_POLY: Polynomial where r is present reading and c is constant.
  • .EXPR_POWER: Present reading raised to power of defined constant.
  • .EXPR_RATE: Rate of change (present reading - previous reading)/(timestamp of present reading - timestamp of previous reading).
  • .EXPR_RECIPROCAL: Reciprocal (1/present reading).
  • .EXPR_SQROOT: Square root of the present reading.
  • .EXPR_SUBTRACT: Present reading - previous reading.
  • .FILL_CONTINUOUS: Fill the buffer continuously.
  • .FILL_ONCE: Fill the buffer, then stop.
  • .OFF: Do not log information events.
  • .ON: Log information events.
  • .SAVE_FORMAT_TIME: Include dates, times, and fractional seconds in the buffer.
  • .SAVE_RAW_TIME: Include seconds and fractional seconds in the buffer.
  • .SAVE_RELATIVE_TIME: Include relative timestamps in the buffer.
  • .SAVE_TIMESTAMP_TIME: Include timestamps in the buffer.
  • .STAT_LIMIT: Source function level was limited.
  • .STAT_LIMIT1_HIGH: Reading is above high limit 1.
  • .STAT_LIMIT1_LOW: Reading is below low limit 1.
  • .STAT_LIMIT2_HIGH: Reading is above high limit 2.
  • .STAT_LIMIT2_LOW: Reading is below low limit 2.
  • .STAT_ORIGIN: A/D converter from which reading originated; for most instruments, this will always be 0 (main). For digitizing instruments, can be 2 (digitize).
  • .STAT_OUTPUT: Output was on.
  • .STAT_OVER_TEMP: Overtemperature condition was active.
  • .STAT_PROTECTION: Overvoltage protection was active.
  • .STAT_QUESTIONABLE: Measure status questionable.
  • .STAT_READBACK: Measured source value was read.
  • .STAT_REL: Relative offset.
  • .STAT_SCAN: Scan.
  • .STAT_SENSE: Four-wire sense was used.
  • .STAT_START_GROUP: First reading in a group.
  • .STAT_TERMINAL: Measure terminal, front is 1, rear is 0.
  • .STYLE_COMPACT: Store readings with reduced accuracy (6.5 digits) with no formatting information, 1 μs accurate timestamp.
  • .STYLE_FULL: Store the same information with full accuracy with formatting, plus additional information.
  • .STYLE_STANDARD: Store readings with full accuracy with formatting.
  • .STYLE_WRITABLE: Store external reading buffer data.
  • .STYLE_WRITABLE_FULL: Store external reading buffer data with two reading values.
  • .UNIT_AMP: Set units of measure to dc current.
  • .UNIT_AMP_AC: Set units of measure to ac current.
  • .UNIT_CELSIUS: Set units of measure to Celsius.
  • .UNIT_CUSTOM1: Custom unit 1 (defined by buffer.unit()).
  • .UNIT_CUSTOM2: Custom unit 2 (defined by buffer.unit()).
  • .UNIT_CUSTOM3: Custom unit 3 (defined by buffer.unit()).
  • .UNIT_DAC: Set units of measure to DAC (voltage).
  • .UNIT_DBM: Set units of measure to decibel-milliwatts.
  • .UNIT_DECIBEL: Set units of measure to decibels.
  • .UNIT_DIO: Set units of measure to digital I/O.
  • .UNIT_FAHRENHEIT: Set units of measure to Fahrenheit.
  • .UNIT_FARAD: Set units of measure to capacitance.
  • .UNIT_HERTZ: Set units of measure to frequency.
  • .UNIT_KELVIN: Set units of measure to Kelvin.
  • .UNIT_NONE: Set units of measure to no units.
  • .UNIT_OHM: Set units of measure to ohms.
  • .UNIT_PERCENT: Set units of measure to percent.
  • .UNIT_RATIO: Set units of measure to dc voltage ratio.
  • .UNIT_RECIPROCAL: Set units of measure to reciprocal.
  • .UNIT_SECOND: Set units of measure to period.
  • .UNIT_TOT: Set units of measure to totalizer.
  • .UNIT_VOLT: Set units of measure to dc voltage.
  • .UNIT_VOLT_AC: Set units of measure to ac voltage.
  • .UNIT_WATT: Set units of measure to watts.
  • .UNIT_X: Set units of measure to buffer.UNIT_X.
Sub-properties and sub-methods
  • .clearstats(): The buffer.clearstats() function.
  • .delete(): The buffer.delete() function.
  • .getstats(): The buffer.getstats() function.
  • .make(): The buffer.make() function.
  • .save(): The buffer.save() function.
  • .saveappend(): The buffer.saveappend() function.
  • .write: The buffer.write command tree.

buffer_var property 

buffer_var: dict[str, Buffervar]

Return the bufferVar command tree.

Info
  • bufferVar, the name of the reading buffer, which may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer.
Sub-properties and sub-methods
  • .capacity: The bufferVar.capacity attribute.
  • .clear(): The bufferVar.clear() function.
  • .dates: The bufferVar.dates[N] attribute.
  • .endindex: The bufferVar.endindex attribute.
  • .extraformattedvalues: The bufferVar.extraformattedvalues[N] attribute.
  • .extravalues: The bufferVar.extravalues[N] attribute.
  • .extravalueunits: The bufferVar.extravalueunits[N] attribute.
  • .fillmode: The bufferVar.fillmode attribute.
  • .formattedreadings: The bufferVar.formattedreadings[N] attribute.
  • .fractionalseconds: The bufferVar.fractionalseconds[N] attribute.
  • .logstate: The bufferVar.logstate attribute.
  • .n: The bufferVar.n attribute.
  • .readings: The bufferVar.readings[N] attribute.
  • .relativetimestamps: The bufferVar.relativetimestamps[N] attribute.
  • .seconds: The bufferVar.seconds[N] attribute.
  • .sourceformattedvalues: The bufferVar.sourceformattedvalues[N] attribute.
  • .sourcestatuses: The bufferVar.sourcestatuses[N] attribute.
  • .sourceunits: The bufferVar.sourceunits[N] attribute.
  • .sourcevalues: The bufferVar.sourcevalues[N] attribute.
  • .startindex: The bufferVar.startindex attribute.
  • .statuses: The bufferVar.statuses[N] attribute.
  • .times: The bufferVar.times[N] attribute.
  • .timestamps: The bufferVar.timestamps[N] attribute.
  • .units: The bufferVar.units[N] attribute.

dataqueue property 

dataqueue: Dataqueue

Return the dataqueue command tree.

Constants
  • .CAPACITY: The maximum number of entries that you can store in the data queue.
Sub-properties and sub-methods
  • .add(): The dataqueue.add() function.
  • .clear(): The dataqueue.clear() function.
  • .count: The dataqueue.count attribute.
  • .next(): The dataqueue.next() function.

digio property 

digio: Digio

Return the digio command tree.

Constants
  • .MODE_DIGITAL_IN: Set the digital I/O mode to digital control, input.
  • .MODE_DIGITAL_OPEN_DRAIN: Set the digital I/O mode to digital control, open-drain.
  • .MODE_DIGITAL_OUT: Set the digital I/O mode to digital control, output.
  • .MODE_SYNCHRONOUS_ACCEPTOR: Set the digital I/O mode to synchronous acceptor.
  • .MODE_SYNCHRONOUS_MASTER: Set the digital I/O mode to synchronous master.
  • .MODE_TRIGGER_IN: Set the digital I/O mode to trigger control, input.
  • .MODE_TRIGGER_OPEN_DRAIN: Set the digital I/O mode to trigger control, open-drain.
  • .MODE_TRIGGER_OUT: Set the digital I/O mode to trigger control, output.
  • .STATE_HIGH: Set the line high.
  • .STATE_LOW: Set the line low.
Sub-properties and sub-methods
  • .line: The digio.line[N] command tree.
  • .readport(): The digio.readport() function.
  • .writeport(): The digio.writeport() function.

display property 

display: Display

Return the display command tree.

Constants
  • .BUTTONS_CANCEL: Display CANCEL on dialog.
  • .BUTTONS_NONE: Display nothing on dialog.
  • .BUTTONS_OK: Display OK on dialog.
  • .BUTTONS_OKCANCEL: Display OK and CANCEL on dialog.
  • .BUTTONS_YESNO: Display YES and NO on dialog.
  • .BUTTONS_YESNOCANCEL: Display YES, NO, and CANCEL on dialog.
  • .BUTTON_CANCEL: Return if CANCEL selected.
  • .BUTTON_NO: Return if NO selected.
  • .BUTTON_OK: Return if OK selected.
  • .BUTTON_YES: Return if YES selected.
  • .FORMAT_EXPONENT: Use exponent format to display measurement readings on the front-panel display of the instrument.
  • .FORMAT_PREFIX: Add a prefix to the units symbol, such as k, m, or u, to display measurement readings on the front-panel display of the instrument.
  • .NFORMAT_DECIMAL: Allow decimal values.
  • .NFORMAT_EXPONENT: Display numbers in exponent format.
  • .NFORMAT_INTEGER: Allow integers (negative or positive) only.
  • .NFORMAT_PREFIX: Display numbers with prefixes before the units symbol, such as n, m, or u.
  • .SCREEN_GRAPH: Display the last selected graph screen tab.
  • .SCREEN_GRAPH_SWIPE: Display graph swipe screen.
  • .SCREEN_HISTOGRAM: Display Histogram.
  • .SCREEN_HOME: Display Home screen.
  • .SCREEN_HOME_LARGE_READING: Display Home screen with large readings.
  • .SCREEN_PROCESSING: Open a screen that uses minimal CPU resources.
  • .SCREEN_READING_TABLE: Display Reading Table screen.
  • .SCREEN_SETTINGS_SWIPE: Display SETTINGS swipe screen.
  • .SCREEN_SOURCE_SWIPE: Display SOURCE swipe screen.
  • .SCREEN_STATS_SWIPE: Display STATISTICS swipe screen.
  • .SCREEN_USER_SWIPE: Display USER swipe screen.
  • .SFORMAT_ANY: Allow any characters.
  • .SFORMAT_BUFFER_NAME: Allow both upper- and lower-case letters (no special characters).
  • .SFORMAT_UPPER: Allow only upper-case letters.
  • .SFORMAT_UPPER_LOWER: Allow both upper- and lower-case letters (no special characters).
  • .STATE_BLACKOUT: Set display and all indicators off.
  • .STATE_LCD_100: Set display to full brightness.
  • .STATE_LCD_25: Set display to 25% brightness.
  • .STATE_LCD_50: Set display to 50% brightness.
  • .STATE_LCD_75: Set display to 75% brightness.
  • .STATE_LCD_OFF: Set display to off.
  • .TEXT1: display text line for Line 1.
  • .TEXT2: display text line for Line 2.
Sub-properties and sub-methods
  • .activebuffer: The display.activebuffer attribute.
  • .changescreen(): The display.changescreen() function.
  • .clear(): The display.clear() function.
  • .delete(): The display.delete() function.
  • .input: The display.input command tree.
  • .lightstate: The display.lightstate attribute.
  • .prompt(): The display.prompt() function.
  • .readingformat: The display.readingformat attribute.
  • .settext(): The display.settext() function.
  • .waitevent(): The display.waitevent() function.

eventlog property 

eventlog: Eventlog

Return the eventlog command tree.

Constants
  • .SEV_ALL: Returns the total number of unread events in the event log.
  • .SEV_ERROR: Returns the number of error events in the event log.
  • .SEV_INFO: Returns the number of information messages in the event log.
  • .SEV_WARN: Returns the number of warnings in the event log.
Sub-properties and sub-methods
  • .clear(): The eventlog.clear() function.
  • .getcount(): The eventlog.getcount() function.
  • .next(): The eventlog.next() function.
  • .post(): The eventlog.post() function.
  • .save(): The eventlog.save() function.

file property 

file: File

Return the file command tree.

Constants
  • .MODE_APPEND: Append the file.
  • .MODE_READ: Read the file.
  • .MODE_WRITE: Write to the file.
  • .READ_ALL: Return the whole file, starting at the present position; returns nil if the present file position is at the end of the file.
  • .READ_LINE: Return the next line; returns nil if the present file position is at the end of the file.
  • .READ_NUMBER: Return a string that represents the number found; returns an event string if no number was found; returns nil if the current file position is at the end of file.
Sub-properties and sub-methods
  • .close(): The file.close() function.
  • .flush(): The file.flush() function.
  • .mkdir(): The file.mkdir() function.
  • .open(): The file.open() function.
  • .read(): The file.read() function.
  • .usbdriveexists(): The file.usbdriveexists() function.
  • .write(): The file.write() function.

format property 

format: Format

Return the format command tree.

Constants
  • .ASCII: Sets the data format for data that is printed using the printnumber() and printbuffer() functions to be ASCII format.
  • .BIGENDIAN: Sets the binary byte order for the data that is printed using the printnumber() and printbuffer() functions to be most significant byte first.
  • .LITTLEENDIAN: Sets the binary byte order for the data that is printed using the printnumber() and printbuffer() functions to be least significant byte first.
  • .REAL32: Sets the data format for data that is printed using the printnumber() and printbuffer() functions to be single-precision IEEE Std 754 binary format.
  • .REAL64: Sets the data format for data that is printed using the printnumber() and printbuffer() functions to be double-precision IEEE Std 754 binary format.
Sub-properties and sub-methods
  • .asciiprecision: The format.asciiprecision attribute.
  • .byteorder: The format.byteorder attribute.
  • .data: The format.data attribute.

fs property 

fs: Fs

Return the fs command tree.

Sub-properties and sub-methods
  • .chdir(): The fs.chdir() function.
  • .cwd(): The fs.cwd() function.
  • .is_dir(): The fs.is_dir() function.
  • .is_file(): The fs.is_file() function.
  • .mkdir(): The fs.mkdir() function.
  • .readdir(): The fs.readdir() function.
  • .rmdir(): The fs.rmdir() function.

gpib property 

gpib: Gpib

Return the gpib command tree.

Sub-properties and sub-methods
  • .address: The gpib.address attribute.

lan property 

lan: Lan

Return the lan command tree.

Constants
  • .MODE_AUTO: The instrument automatically assigns LAN settings.
  • .MODE_MANUAL: You specify the LAN settings.
  • .OFF: An open and close on the DST port (5030) closes all open LAN connections.
  • .ON: The DST port needs to be opened, receive the login + , then close the DST port to close all open LAN connections. By turning DST protection ON, you are protecting LAN connections from being inadvertently closed by your IT department doing a port scan across the corporate network.
  • .PROTOCOL_MULTICAST: Sets the LAN protocol to use for sending trigger messages to multicast.
  • .PROTOCOL_TCP: Sets the LAN protocol to use for sending trigger messages to TCP.
  • .PROTOCOL_UDP: Sets the LAN protocol to use for sending trigger messages to UDP.
Sub-properties and sub-methods
  • .ipconfig(): The lan.ipconfig() function.
  • .lxidomain: The lan.lxidomain attribute.
  • .macaddress: The lan.macaddress attribute.

localnode property 

localnode: Localnode

Return the localnode command tree.

Constants
  • .ACCESS_EXCLUSIVE: Allows access by one remote interface at a time with logins required from other interfaces.
  • .ACCESS_FULL: Full access for all users from all interfaces.
  • .ACCESS_LOCKOUT: Allows access by one interface (including the front panel) at a time with passwords required on all interfaces.
  • .ACCESS_PROTECTED: Allows access by one remote interface at a time with passwords required on all interfaces.
  • .DISABLE: Do not generate prompts in response to command messages.
  • .ENABLE: Generate prompts in response to command messages.
Sub-properties and sub-methods
  • .access: The localnode.access attribute.
  • .gettime(): The localnode.gettime() function.
  • .linefreq: The localnode.linefreq attribute.
  • .model: The localnode.model attribute.
  • .password: The localnode.password attribute.
  • .prompts: The localnode.prompts attribute.
  • .prompts4882: The localnode.prompts4882 attribute.
  • .serialno: The localnode.serialno attribute.
  • .settime(): The localnode.settime() function.
  • .showevents: The localnode.showevents attribute.
  • .version: The localnode.version attribute.

node property 

node: dict[int, NodeItem]

Return the node[N] command tree.

Info
  • N, the node number of this instrument (1 to 63).
Sub-properties and sub-methods
  • .execute(): The node[N].execute() function.
  • .getglobal(): The node[N].getglobal() function.
  • .setglobal(): The node[N].setglobal() function.

script property 

script: Script

Return the script command tree.

Sub-properties and sub-methods
  • .delete(): The script.delete() function.
  • .load(): The script.load() function.

script_var property 

script_var: dict[str, Scriptvar]

Return the scriptVar command tree.

Info
  • scriptVar, the name of the variable that references the script.
Sub-properties and sub-methods
  • .run(): The scriptVar.run() function.
  • .save(): The scriptVar.save() function.
  • .source: The scriptVar.source attribute.

smu property 

smu: Smu

Return the smu command tree.

Constants
  • .ATTR_MEAS_AUTO_ZERO: Autozero enable.
  • .ATTR_MEAS_COUNT: Set the measure count.
  • .ATTR_MEAS_DIGITS: Display digits.
  • .ATTR_MEAS_FILTER_COUNT: Set filter count.
  • .ATTR_MEAS_FILTER_ENABLE: Enable or disable filter.
  • .ATTR_MEAS_FILTER_TYPE: Set filter type.
  • .ATTR_MEAS_LIMIT_AUDIBLE_1: Set limit 1 audible.
  • .ATTR_MEAS_LIMIT_AUDIBLE_2: Set limit 2 audible.
  • .ATTR_MEAS_LIMIT_AUTO_CLEAR_1: Enable or disable limit 1 autoclear.
  • .ATTR_MEAS_LIMIT_AUTO_CLEAR_2: Enable or disable limit 2 autoclear.
  • .ATTR_MEAS_LIMIT_ENABLE_1: Enable or disable limit 1.
  • .ATTR_MEAS_LIMIT_ENABLE_2: Limit 2 enable.
  • .ATTR_MEAS_LIMIT_FAIL_1: Limit 1 fail.
  • .ATTR_MEAS_LIMIT_FAIL_2: Limit 2 fail.
  • .ATTR_MEAS_LIMIT_HIGH_1: Set limit 1 high value.
  • .ATTR_MEAS_LIMIT_HIGH_2: Set limit 2 high value.
  • .ATTR_MEAS_LIMIT_LOW_1: Set limit 1 low value.
  • .ATTR_MEAS_LIMIT_LOW_2: Set limit 2 low value.
  • .ATTR_MEAS_MATH_ENABLE: Enable or disable math.
  • .ATTR_MEAS_MATH_FORMAT: Select the math format.
  • .ATTR_MEAS_MATH_MXB_BF: Set the mxb b (offset) value.
  • .ATTR_MEAS_MATH_MXB_MF: Set the mxb m (scalar) value.
  • .ATTR_MEAS_MATH_PERCENT: Set the percent match function.
  • .ATTR_MEAS_NPLC: NPLC.
  • .ATTR_MEAS_OFFSET_COMP: Offset compensation.
  • .ATTR_MEAS_RANGE: Range.
  • .ATTR_MEAS_RANGE_AUTO: Set up autorange.
  • .ATTR_MEAS_RANGE_HIGH: Set up autorange high limit.
  • .ATTR_MEAS_RANGE_LOW: Set up autorange low limit.
  • .ATTR_MEAS_RANGE_REBOUND: Set autorange rebound.
  • .ATTR_MEAS_REL_ENABLE: Relative offset enable.
  • .ATTR_MEAS_REL_LEVEL: Relative offset level.
  • .ATTR_MEAS_SENSE: Sense (2-wire or 4-wire).
  • .ATTR_MEAS_UNIT: Measurement unit.
  • .ATTR_MEAS_USER_DELAY_N: Set user delay, where N is 1 to 5.
  • .ATTR_SRC_DELAY: Delay in addition to normal settling times after turning on the source.
  • .ATTR_SRC_DELAY_AUTO: Set autodelay.
  • .ATTR_SRC_FUNCTION: Set the function.
  • .ATTR_SRC_HIGHC: Set high capacitance.
  • .ATTR_SRC_LEVEL: Set level.
  • .ATTR_SRC_LIMIT_LEVEL: Set limit level.
  • .ATTR_SRC_LIMIT_TRIPPED: Source limit exceeded.
  • .ATTR_SRC_OFFMODE: Set output off mode.
  • .ATTR_SRC_PROTECT_LEVEL: Set overvoltage protection limit.
  • .ATTR_SRC_PROTECT_TRIPPED: The overvoltage protection limit is active.
  • .ATTR_SRC_RANGE: Set range.
  • .ATTR_SRC_RANGE_AUTO: Set autorange.
  • .ATTR_SRC_READBACK: Set source readback.
  • .ATTR_SRC_USER_DELAY_N: User delay N, where N is the user delay, 1 to 5.
  • .AUDIBLE_FAIL: Beeper sound on test failure.
  • .AUDIBLE_NONE: Beeper never sounds.
  • .AUDIBLE_PASS: Beeper sound on test pass.
  • .DELAY_AUTO: Delay between measurement points set to autodelay.
  • .DIGITS_3_5: Set display to 3.5 digits.
  • .DIGITS_4_5: Set display to 4.5 digits.
  • .DIGITS_5_5: Set display to 5.5 digits.
  • .DIGITS_6_5: Set display to 6.5 digits.
  • .FAIL_BOTH: Test failed; measurement exceeded both limits.
  • .FAIL_HIGH: Test failed; measurement exceeded high limit.
  • .FAIL_LOW: Test failed; measurement exceeded low limit.
  • .FAIL_NONE: Test passed; measurement under or equal to the high limit.
  • .FILTER_MOVING_AVG: Use the moving average filter for the selected measure function when the measurement filter is enabled.
  • .FILTER_REPEAT_AVG: Use the repeatinter average filter for the selected measure function when the measurement filter is enabled.
  • .FUNC_DC_CURRENT: Current measurement function.
  • .FUNC_DC_VOLTAGE: Voltage measurement function.
  • .FUNC_RESISTANCE: Resistance measurement function.
  • .INFINITE: Set count to infinite.
  • .MATH_MXB: Perform y = mx+b operation on measurement.
  • .MATH_PERCENT: Perform percent operation on measurements.
  • .MATH_RECIPROCAL: Perform reciprocal math operation on measurements.
  • .OFF: Allow the output to be turned on when the interlock is not engaged.
  • .OFFMODE_GUARD: Set the state when the output is turned off to guard.
  • .OFFMODE_HIGHZ: Set the state when the output is turned off to high impedance.
  • .OFFMODE_NORMAL: Set the state when the output is turned off to normal.
  • .OFFMODE_ZERO: Set the state when the output is turned off to zero.
  • .ON: Only allow the output to be turned on if the interlock is engaged.
  • .PROTECT_100V: The overvoltage protection value.
  • .PROTECT_10V: The overvoltage protection value.
  • .PROTECT_120V: The overvoltage protection value.
  • .PROTECT_140V: The overvoltage protection value.
  • .PROTECT_160V: The overvoltage protection value.
  • .PROTECT_180V: The overvoltage protection value.
  • .PROTECT_20V: The overvoltage protection value.
  • .PROTECT_2V: The overvoltage protection value.
  • .PROTECT_40V: The overvoltage protection value.
  • .PROTECT_5V: The overvoltage protection value.
  • .PROTECT_60V: The overvoltage protection value.
  • .PROTECT_80V: The overvoltage protection value.
  • .PROTECT_NONE: The overvoltage protection value.
  • .RANGE_AUTO: Most sensitive source range for each source level in the sweep.
  • .RANGE_BEST: Best fixed range.
  • .RANGE_FIXED: Present source range for the entire sweep.
  • .SENSE_2WIRE: Use two-wire sensing.
  • .SENSE_4WIRE: Use four-wire sensing.
  • .TERMINALS_FRONT: Use the front-panel input and output terminals.
  • .TERMINALS_REAR: Use the rear-panel input and output terminals.
  • .UNIT_AMP: Set unit of measure to amps (only available for current measurements).
  • .UNIT_OHM: Set unit of measure to ohms (available for voltage, current, or resistance measurements).
  • .UNIT_VOLT: Set unit of measure to volts (only available for voltage measurements).
  • .UNIT_WATT: Set unit of measure to power (only available for voltage or current measurements).
Sub-properties and sub-methods
  • .interlock: The smu.interlock command tree.
  • .measure: The smu.measure command tree.
  • .reset(): The smu.reset() function.
  • .source: The smu.source command tree.
  • .terminals: The smu.terminals attribute.

status property 

status: Status

Return the status command tree.

Constants
  • .EAV: B2. Set summary bit indicates that an error or status message is present in the Error Queue.
  • .ESB: B5. Set summary bit indicates that an enabled standard event has occurred.
  • .MAV: B4. Set summary bit indicates that a response message is present in the Output Queue.
  • .MSB: B0. Set summary bit indicates that an enabled measurement event has occurred.
  • .MSS: An enabled summary bit of the status byte register is set.
  • .OSB: B7. Set summary bit indicates that an enabled operation event has occurred.
  • .QSB: B3. Set summary bit indicates that an enabled questionable event has occurred.
Sub-properties and sub-methods
  • .clear(): The status.clear() function.
  • .condition: The status.condition attribute.
  • .operation: The status.operation command tree.
  • .preset(): The status.preset() function.
  • .questionable: The status.questionable command tree.
  • .request_enable: The status.request_enable attribute.
  • .standard: The status.standard command tree.

timer property 

timer: Timer

Return the timer command tree.

Sub-properties and sub-methods
  • .cleartime(): The timer.cleartime() function.
  • .gettime(): The timer.gettime() function.

trigger property 

trigger: Trigger

Return the trigger command tree.

Constants
  • .BLOCK_BRANCH_ALWAYS: Defines a trigger model block that always goes to a specific block.
  • .BLOCK_BRANCH_COUNTER: Defines a trigger model block that branches to a specified block a specified number of times.
  • .BLOCK_BRANCH_DELTA: Defines a trigger model block that goes to a specified block if the difference of two measurements meets preset criteria.
  • .BLOCK_BRANCH_LIMIT_CONSTANT: Defines a trigger model block that goes to a specified block if a measurement meets preset criteria.
  • .BLOCK_BRANCH_LIMIT_DYNAMIC: Defines a trigger model block that goes to a specified block in the trigger model if a measurement meets user-defined criteria.
  • .BLOCK_BRANCH_ONCE: Causes the trigger model to branch to a specified building block the first time it is encountered in the trigger model.
  • .BLOCK_BRANCH_ONCE_EXCLUDED: Causes the trigger model to go to a specified building block every time the trigger model encounters it, except for the first time.
  • .BLOCK_BRANCH_ON_EVENT: Branches to a specified block when a specified trigger event occurs.
  • .BLOCK_BUFFER_CLEAR: Defines a trigger model block that clears the reading buffer.
  • .BLOCK_CONFIG_NEXT: Recalls the settings at the next index of a configuration list.
  • .BLOCK_CONFIG_PREV: Recalls the settings stored at the previous index of a configuration list.
  • .BLOCK_CONFIG_RECALL: Recalls the system settings that are stored in a source or measure configuration list, or both a source and measure configuration list.
  • .BLOCK_DELAY_CONSTANT: Adds a constant delay to the execution of a trigger model.
  • .BLOCK_DELAY_DYNAMIC: Adds a user delay to the execution of the trigger model.
  • .BLOCK_DIGITAL_IO: Defines a trigger model block that sets the lines on the digital I/O port high or low.
  • .BLOCK_LOG_EVENT: Allows you to log an event in the event log when the trigger model is running.
  • .BLOCK_MEASURE: Deprecated; use trigger.BLOCK_MEASURE_DIGITIZE instead.
  • .BLOCK_MEASURE_DIGITIZE: defines a trigger block that makes or digitizes a measurement.
  • .BLOCK_NOP: Creates a placeholder that performs no action in the trigger model.
  • .BLOCK_NOTIFY: Defines a trigger-model block that generates a trigger event and immediately continues to the next block.
  • .BLOCK_RESET_BRANCH_COUNT: Creates a block in the trigger model that resets a branch counter to 0.
  • .BLOCK_SOURCE_OUTPUT: Defines a trigger block that turns the output source on or off.
  • .BLOCK_WAIT: Defines a trigger model block that waits for an event before allowing the trigger model to continue.
  • .CLEAR_ENTER: Clear previously detected trigger events when entering the wait block.
  • .CLEAR_NEVER: Immediately act on any previously detected triggers and not clear them (default).
  • .CONT_AUTO: Start continuous measurements after boot.
  • .CONT_OFF: Do not start continuous measurements after boot.
  • .CONT_RESTART: Place the instrument into local control and start continuous measurements after boot.
  • .COUNT_AUTO: Use most recent count value.
  • .COUNT_INFINITE: Infinite (run continuously until stopped).
  • .COUNT_STOP: Stop infinite to stop the block.
  • .EDGE_EITHER: Sets the selected trigger line to detect either rising-edge or falling-edge triggers as input when the line is configured as an input or open drain.
  • .EDGE_FALLING: Sets the selected trigger line to detect falling-edge triggers as input when the line is configured as an input or open drain.
  • .EDGE_RISING: Sets the selected trigger line to detect rising-edge triggers as input when the line is configured as an input or open drain.
  • .EVENT_BLENDER1: Trigger event blender1, which combines trigger events.
  • .EVENT_BLENDER2: Trigger event blender2, which combines trigger events.
  • .EVENT_COMMAND: A command interface trigger.
  • .EVENT_DIGIO1: Digital input line edge (either rising, falling, or either based on the configuration of the line) detected on digital input line 1.
  • .EVENT_DIGIO2: Digital input line edge (either rising, falling, or either based on the configuration of the line) detected on digital input line 2.
  • .EVENT_DIGIO3: Digital input line edge (either rising, falling, or either based on the configuration of the line) detected on digital input line 3.
  • .EVENT_DIGIO4: Digital input line edge (either rising, falling, or either based on the configuration of the line) detected on digital input line 4.
  • .EVENT_DIGIO5: Digital input line edge (either rising, falling, or either based on the configuration of the line) detected on digital input line 5.
  • .EVENT_DIGIO6: Digital input line edge (either rising, falling, or either based on the configuration of the line) detected on digital input line 6.
  • .EVENT_DIGION: Line edge (either rising, falling, or either based on the configuration of the line) detected on digital input line N (1 to 6).
  • .EVENT_DISPLAY: Front-panel TRIGGER key press.
  • .EVENT_LANN: Appropriate LXI trigger packet is received on LAN trigger object N (1 to 8).
  • .EVENT_NONE: No trigger event.
  • .EVENT_NOTIFY1: Notify trigger block1 generates a trigger event when the trigger model executes it.
  • .EVENT_NOTIFY2: Notify trigger block2 generates a trigger event when the trigger model executes it.
  • .EVENT_NOTIFY3: Notify trigger block3 generates a trigger event when the trigger model executes it.
  • .EVENT_NOTIFY4: Notify trigger block4 generates a trigger event when the trigger model executes it.
  • .EVENT_NOTIFY5: Notify trigger block5 generates a trigger event when the trigger model executes it.
  • .EVENT_NOTIFY6: Notify trigger block6 generates a trigger event when the trigger model executes it.
  • .EVENT_NOTIFY7: Notify trigger block7 generates a trigger event when the trigger model executes it.
  • .EVENT_NOTIFY8: Notify trigger block8 generates a trigger event when the trigger model executes it.
  • .EVENT_NOTIFYN: Notify trigger block N (1 to 3) generates a trigger event when the trigger model executes it.
  • .EVENT_SOURCE_LIMIT: Before asserting a trigger on the selected digital output line, wait until a source limit condition occurs.
  • .EVENT_TIMER1: Trigger timer 1 expired.
  • .EVENT_TIMER2: Trigger timer 2 expired.
  • .EVENT_TIMER3: Trigger timer 3 expired.
  • .EVENT_TIMER4: Trigger timer 4 expired.
  • .EVENT_TSPLINK1: Line edge detected on TSP-Link synchronization line 1.
  • .EVENT_TSPLINK2: Line edge detected on TSP-Link synchronization line 2.
  • .EVENT_TSPLINK3: Line edge detected on TSP-Link synchronization line 3.
  • .EVENT_TSPLINKN: Line edge detected on TSP-Link synchronization line N (1 to 3).
  • .LIMIT_ABOVE: The measurement is above the value set by limit B; limit A must be set, but is ignored when this type is selected.
  • .LIMIT_BELOW: The measurement is below the value set by limit A; limit B must be set, but is ignored when this type is selected.
  • .LIMIT_INSIDE: The measurement is inside the values set by limits A and B; limit A must be the low value and Limit B must be the high value.
  • .LIMIT_OUTSIDE: The measurement is outside the values set by limits A and B; limit A must be the low value and Limit B must be the high value.
  • .LOGIC_NEGATIVE: Asserts a TTL-low pulse for the output logic of the trigger event generator for the specified line.
  • .LOGIC_POSITIVE: Asserts a TTL-high pulse for the output logic of the trigger event generator for the specified line.
  • .LOG_ERROR1: Log error event 1 in the event log when trigger model execution reaches this block.
  • .LOG_ERROR2: Log error event 2 in the event log when trigger model execution reaches this block.
  • .LOG_ERROR3: Log error event 3 in the event log when trigger model execution reaches this block.
  • .LOG_ERROR4: Log error event 4 in the event log when trigger model execution reaches this block.
  • .LOG_INFO1: Log information event 1 in the event log when trigger model execution reaches this block.
  • .LOG_INFO2: Log information event 2 in the event log when trigger model execution reaches this block.
  • .LOG_INFO3: Log information event 3 in the event log when trigger model execution reaches this block.
  • .LOG_INFO4: Log information event 4 in the event log when trigger model execution reaches this block.
  • .LOG_WARN1: Log warning event 1 in the event log when trigger model execution reaches this block.
  • .LOG_WARN2: Log warning event 2 in the event log when trigger model execution reaches this block.
  • .LOG_WARN3: Log warning event 3 in the event log when trigger model execution reaches this block.
  • .LOG_WARN4: Log warning event 4 in the event log when trigger model execution reaches this block.
  • .LOG_WARN_ABORT: Abort the trigger model immediately and post a warning event log message.
  • .OFF: Disable the trigger timer.
  • .ON: Enable the trigger timer.
  • .STATE_ABORTED: The trigger model is stopped.
  • .STATE_ABORTING: The trigger model is stopping.
  • .STATE_BUILDING: Blocks have been added.
  • .STATE_EMPTY: The trigger model is selected, but no blocks are defined.
  • .STATE_FAILED: The trigger model is stopped because of an error.
  • .STATE_IDLE: The trigger model is stopped.
  • .STATE_RUNNING: The trigger model is running.
  • .STATE_WAITING: The trigger model has been in the same wait block for more than 100 ms.
  • .USER_DELAY_M1: trigger.USER_DELAY_M1, where the user delay 1 is set by smu.measure.userdelay[N].
  • .USER_DELAY_M2: trigger.USER_DELAY_M2, where the user delay 2 is set by smu.measure.userdelay[N].
  • .USER_DELAY_M3: trigger.USER_DELAY_M3, where the user delay 3 is set by smu.measure.userdelay[N].
  • .USER_DELAY_M4: trigger.USER_DELAY_M4, where the user delay 4 is set by smu.measure.userdelay[N].
  • .USER_DELAY_M5: trigger.USER_DELAY_M5, where the user delay 5 is set by smu.measure.userdelay[N].
  • .USER_DELAY_S1: Delay 1 is set by smu.source.userdelay[N].
  • .USER_DELAY_S2: Delay 1 is set by smu.source.userdelay[N].
  • .USER_DELAY_S3: Delay 1 is set by smu.source.userdelay[N].
  • .USER_DELAY_S4: Delay 1 is set by smu.source.userdelay[N].
  • .USER_DELAY_S5: Delay 1 is set by smu.source.userdelay[N].
  • .WAIT_AND: Each event must occur before the trigger model continues.
  • .WAIT_OR: At least one of the events must occur before the trigger model continues.
Sub-properties and sub-methods
  • .blender: The trigger.blender[N] command tree.
  • .clear(): The trigger.clear() function.
  • .continuous: The trigger.continuous attribute.
  • .digin: The trigger.digin[N] command tree.
  • .digout: The trigger.digout[N] command tree.
  • .lanin: The trigger.lanin[N] command tree.
  • .lanout: The trigger.lanout[N] command tree.
  • .model: The trigger.model command tree.
  • .timer: The trigger.timer[N] command tree.
  • .tsplinkin: The trigger.tsplinkin[N] command tree.
  • .tsplinkout: The trigger.tsplinkout[N] command tree.
  • .wait(): The trigger.wait() function.
tsplink: Tsplink

Return the tsplink command tree.

Constants
  • .MODE_DIGITAL_OPEN_DRAIN: TSP-Link digital open drain line.
  • .MODE_SYNCHRONOUS_ACCEPTOR: TSP-Link trigger synchronous acceptor.
  • .MODE_SYNCHRONOUS_MASTER: TSP-Link trigger synchronous master.
  • .MODE_TRIGGER_OPEN_DRAIN: TSP-Link trigger open drain line.
  • .STATE_HIGH: High state of the synchronization line.
  • .STATE_LOW: Low state of the synchronization line.
Sub-properties and sub-methods
  • .group: The tsplink.group attribute.
  • .initialize(): The tsplink.initialize() function.
  • .line: The tsplink.line[N] command tree.
  • .master: The tsplink.master attribute.
  • .node: The tsplink.node attribute.
  • .readport(): The tsplink.readport() function.
  • .state: The tsplink.state attribute.
  • .writeport(): The tsplink.writeport() function.

tspnet property 

tspnet: Tspnet

Return the tspnet command tree.

Constants
  • .TERM_CR: Set the device line termination sequence to CR.
  • .TERM_CRLF: Set the device line termination sequence to CRLF.
  • .TERM_LF: Set the device line termination sequence to LF.
  • .TERM_LFCR: Set the device line termination sequence to LFCR.
Sub-properties and sub-methods
  • .clear(): The tspnet.clear() function.
  • .connect(): The tspnet.connect() function.
  • .disconnect(): The tspnet.disconnect() function.
  • .execute(): The tspnet.execute() function.
  • .idn(): The tspnet.idn() function.
  • .read(): The tspnet.read() function.
  • .readavailable(): The tspnet.readavailable() function.
  • .reset(): The tspnet.reset() function.
  • .termination(): The tspnet.termination() function.
  • .timeout: The tspnet.timeout attribute.
  • .tsp: The tspnet.tsp command tree.
  • .write(): The tspnet.write() function.

upgrade property 

upgrade: Upgrade

Return the upgrade command tree.

Sub-properties and sub-methods
  • .previous(): The upgrade.previous() function.
  • .unit(): The upgrade.unit() function.

userstring property 

userstring: Userstring

Return the userstring command tree.

Sub-properties and sub-methods
  • .add(): The userstring.add() function.
  • .delete(): The userstring.delete() function.
  • .get(): The userstring.get() function.

available 

available(functionality: str) -> str

Run the available() function.

Description
  • This function checks for the presence of specific instrument functionality.
TSP Syntax 
- available()
Parameters:
  • functionality (str) –

    The functionality to check for.
Returns:
  • str –

    The result of the function call.
Raises:

createconfigscript 

createconfigscript(script_name: str) -> None

Run the createconfigscript() function.

Description
  • This function creates a setup file that captures most of the present settings of the instrument.
TSP Syntax 
- createconfigscript()
Parameters:
  • script_name (str) –

    A string that represents the name of the script to be created.
Raises:

delay 

delay(seconds: int) -> None

Run the delay() function.

Description
  • This function delays the execution of the commands that follow it.
TSP Syntax 
- delay()
Parameters:
  • seconds (int) –

    The number of seconds to delay (0 s to 100 ks).
Raises:

exit 

exit() -> None

Run the exit() function.

Description
  • This function stops a script that is presently running.
TSP Syntax 
- exit()
Raises:

opc 

opc() -> None

Run the opc() function.

Description
  • This function sets the operation complete (OPC) bit after all pending commands, including overlapped commands, have been executed.
TSP Syntax 
- opc()
Raises:

print 

print(value: str) -> None

Run the print() function.

Description
  • This function generates a response message.
TSP Syntax 
- print()
Parameters:
  • value (str) –

    The first argument to output.
Raises:

printbuffer 

printbuffer(start_index: int, end_index: int, buffer_var: str) -> str

Run the printbuffer() function.

Description
  • This function prints data from tables or reading buffer subtables.
TSP Syntax 
- printbuffer()
Parameters:
  • start_index (int) –

    Beginning index of the buffer to print; this must be more than one and less than endIndex.

  • end_index (int) –

    Ending index of the buffer to print; this must be more than startIndex and less than the index of the last entry in the tables.

  • buffer_var (str) –

    Name of first table or reading buffer subtable to print; may be a default buffer (defbuffer1 or defbuffer2) or a user-defined buffer.
Returns:
  • str –

    The result of the function call.
Raises:

printnumber 

printnumber(value: str) -> str

Run the printnumber() function.

Description
  • This function prints numbers using the configured format.
TSP Syntax 
- printnumber()
Parameters:
  • value (str) –

    First value to print in the configured format.
Returns:
  • str –

    The result of the function call.
Raises:

reset 

reset(system: str | None = None) -> None

Run the reset() function.

Description
  • This function resets commands to their default settings and clears the buffers.
TSP Syntax 
- reset()
Parameters:
  • system (optional, default: None ) –

    If the node is the master, the entire system is reset.
Raises:

waitcomplete 

waitcomplete(group: str | None = None) -> None

Run the waitcomplete() function.

Description
  • This function waits for all previously started overlapped commands to complete.
TSP Syntax 
- waitcomplete()
Parameters:
  • group (optional, default: None ) –

    Specifies which TSP-Link group on which to wait.
Raises:

SMU2460Mixin

A mixin that provides access to the SMU2460 commands and constants.

Properties
  • .command_argument_constants: The SMU2460 command argument constants.
  • .commands: The SMU2460 commands.

command_argument_constants cached property 

command_argument_constants: SMU2460CommandConstants

Return the SMU2460 command argument constants.

This provides access to all the string constants which can be used as arguments for SMU2460 commands.

commands cached property 

commands: SMU2460Commands

Return the SMU2460 commands.

This provides access to all the commands for the SMU2460 device. See the documentation of each sub-property for more usage information.

Sub-properties and sub-methods
  • .available(): The available() function.
  • .beeper: The beeper command tree.
  • .buffer_var: The bufferVar command tree.
  • .buffer: The buffer command tree.
  • .createconfigscript(): The createconfigscript() function.
  • .dataqueue: The dataqueue command tree.
  • .delay(): The delay() function.
  • .digio: The digio command tree.
  • .display: The display command tree.
  • .eventlog: The eventlog command tree.
  • .exit(): The exit() function.
  • .file: The file command tree.
  • .format: The format command tree.
  • .fs: The fs command tree.
  • .gpib: The gpib command tree.
  • .lan: The lan command tree.
  • .localnode: The localnode command tree.
  • .node: The node[N] command tree.
  • .opc(): The opc() function.
  • .print(): The print() function.
  • .printbuffer(): The printbuffer() function.
  • .printnumber(): The printnumber() function.
  • .reset(): The reset() function.
  • .script_var: The scriptVar command tree.
  • .script: The script command tree.
  • .smu: The smu command tree.
  • .status: The status command tree.
  • .timer: The timer command tree.
  • .trigger: The trigger command tree.
  • .tsplink: The tsplink command tree.
  • .tspnet: The tspnet command tree.
  • .upgrade: The upgrade command tree.
  • .userstring: The userstring command tree.
  • .waitcomplete(): The waitcomplete() function.