smu2657a_commands ¶

The SMU2657A commands module.

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

Please report an issue if one is found.

SMU2657ACommandConstants ¶

The SMU2657A command argument constants.

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

SMU2657ACommands ¶

The SMU2657A commands.

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

Properties and methods

.beeper: The beeper command tree.
.bit: The bit command tree.
.buffer_var: The bufferVar command tree.
.config_pulse_i_measure_v(): The ConfigPulseIMeasureV() function.
.config_pulse_i_measure_v_sweep_lin(): The ConfigPulseIMeasureVSweepLin() function.
.config_pulse_i_measure_v_sweep_log(): The ConfigPulseIMeasureVSweepLog() function.
.config_pulse_v_measure_i(): The ConfigPulseVMeasureI() function.
.config_pulse_v_measure_i_sweep_lin(): The ConfigPulseVMeasureISweepLin() function.
.config_pulse_v_measure_i_sweep_log(): The ConfigPulseVMeasureISweepLog() function.
.dataqueue: The dataqueue command tree.
.delay(): The delay() function.
.digio: The digio command tree.
.display: The display command tree.
.errorqueue: The errorqueue command tree.
.eventlog: The eventlog command tree.
.exit(): The exit() function.
.format: The format command tree.
.fs: The fs command tree.
.gettimezone(): The gettimezone() function.
.gm_isweep(): The gm_isweep() function.
.gm_vsweep(): The gm_vsweep() function.
.gpib: The gpib command tree.
.initiate_pulse_test(): The InitiatePulseTest() function.
.io: The io command tree.
.lan: The lan command tree.
.localnode: The localnode command tree.
.makegetter(): The makegetter() function.
.makesetter(): The makesetter() function.
.meminfo(): The meminfo() function.
.node: The node[N] command tree.
.opc(): The opc() function.
.os: The os command tree.
.print(): The print() function.
.printbuffer(): The printbuffer() function.
.printnumber(): The printnumber() function.
.pulse_i_measure_v(): The PulseIMeasureV() function.
.pulse_v_measure_i(): The PulseVMeasureI() function.
.query_pulse_config(): The QueryPulseConfig() function.
.reset(): The reset() function.
.savebuffer(): The savebuffer() function.
.script_var: The scriptVar command tree.
.script: The script command tree.
.serial: The serial command tree.
.settime(): The settime() function.
.settimezone(): The settimezone() function.
.setup: The setup command tree.
.smu: The smuX 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.
.userstring: The userstring command tree.
.waitcomplete(): The waitcomplete() function.

beeper `property` ¶

beeper: Beeper

Return the beeper command tree.

Constants

.OFF: This command turns the beeper off.
.ON: This command turns the beeper on.

Sub-properties and sub-methods

.beep(): The beeper.beep() function.
.enable: The beeper.enable attribute.

bit `property` ¶

bit: Bit

Return the bit command tree.

Sub-properties and sub-methods

.bitand(): The bit.bitand() function.
.bitor(): The bit.bitor() function.
.bitxor(): The bit.bitxor() function.
.clear(): The bit.clear() function.
.get(): The bit.get() function.
.getfield(): The bit.getfield() function.
.set(): The bit.set() function.
.setfield(): The bit.setfield() function.
.test(): The bit.test() function.
.toggle(): The bit.toggle() function.

buffer_var `property` ¶

buffer_var: dict[str, Buffervar]

Return the bufferVar command tree.

Info

bufferVar, the reading buffer; can be a dynamically allocated user-defined buffer or a dedicated reading buffer.

Sub-properties and sub-methods

.appendmode: The bufferVar.appendmode attribute.
.basetimestamp: The bufferVar.basetimestamp attribute.
.cachemode: The bufferVar.cachemode attribute.
.capacity: The bufferVar.capacity attribute.
.clear(): The bufferVar.clear() function.
.clearcache(): The bufferVar.clearcache() function.
.collectsourcevalues: The bufferVar.collectsourcevalues attribute.
.collecttimestamps: The bufferVar.collecttimestamps attribute.
.fillcount: The bufferVar.fillcount attribute.
.fillmode: The bufferVar.fillmode attribute.
.measurefunctions: The bufferVar.measurefunctions[N] attribute.
.measureranges: The bufferVar.measureranges[N] attribute.
.n: The bufferVar.n attribute.
.readings: The bufferVar.readings[N] attribute.
.sourcefunctions: The bufferVar.sourcefunctions[N] attribute.
.sourceoutputstates: The bufferVar.sourceoutputstates[N] attribute.
.sourceranges: The bufferVar.sourceranges[N] attribute.
.sourcevalues: The bufferVar.sourcevalues[N] attribute.
.statuses: The bufferVar.statuses[N] attribute.
.timestampresolution: The bufferVar.timestampresolution attribute.
.timestamps: The bufferVar.timestamps[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

.TRIG_BYPASS: Sets the mode in which the trigger event detector and the output trigger generator operate on the specified trigger line to allow direct control of the line.
.TRIG_EITHER: Sets the mode in which the trigger event detector and the output trigger generator operate on the specified trigger line to detect rising- or falling-edge triggers as input and assert a TTL-low pulse for output.
.TRIG_FALLING: Sets the mode in which the trigger event detector and the output trigger generator operate on the specified trigger line to detect falling-edge triggers as input and assert a TTL-low pulse for output.
.TRIG_RISING: Sets the mode in which the trigger event detector and the output trigger generator operate on the specified trigger line so that 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. Only use this setting if necessary for compatibility with other Keithley Instruments products.
.TRIG_RISINGA: Sets the mode in which the trigger event detector and the output trigger generator operate on the specified trigger line to detect rising-edge triggers as input and assert a TTL-low pulse for output.
.TRIG_RISINGM: Sets the mode in which the trigger event detector and the output trigger generator operate on the specified trigger line to assert a TTL-high pulse for output. Input edge detection is not possible in this mode.
.TRIG_SYNCHRONOUS: Sets the mode in which the trigger event detector and the output trigger generator operate on the specified trigger line to detect the falling-edge input triggers and automatically latch and drive the trigger line low. Asserts a TTL-low pulse as an output trigger.
.TRIG_SYNCHRONOUSA: Sets the mode in which the trigger event detector and the output trigger generator operate on the specified trigger line to detect the falling-edge input triggers and automatically latch and drive the trigger line low. Asserting the output trigger releases the latched line.
.TRIG_SYNCHRONOUSM: Sets the mode in which the trigger event detector and the output trigger generator operate on the specified trigger line to detect rising-edge triggers as input and assert a TTL-low pulse for output.

Sub-properties and sub-methods

.readbit(): The digio.readbit() function.
.readport(): The digio.readport() function.
.trigger: The digio.trigger[N] command tree.
.writebit(): The digio.writebit() function.
.writeport(): The digio.writeport() function.
.writeprotect: The digio.writeprotect attribute.

display `property` ¶

display: Display

Return the display command tree.

Constants

.ANNUNCIATOR_4_WIRE: 4W indicator on.
.ANNUNCIATOR_ARM: ARM indicator on.
.ANNUNCIATOR_AUTO: AUTO indicator on.
.ANNUNCIATOR_EDIT: EDIT indicator on.
.ANNUNCIATOR_ERROR: ERR indicator on.
.ANNUNCIATOR_FILTER: FILT indicator on.
.ANNUNCIATOR_LISTEN: LSTN indicator on.
.ANNUNCIATOR_MATH: MATH indicator on.
.ANNUNCIATOR_REAR: REAR indicator on.
.ANNUNCIATOR_REL: REL indicator on.
.ANNUNCIATOR_REMOTE: REM indicator on.
.ANNUNCIATOR_SAMPLE: SMPL indicator on.
.ANNUNCIATOR_SRQ: SRQ indicator on.
.ANNUNCIATOR_STAR: * (asterisk) indicator on.
.ANNUNCIATOR_TALK: TALK indicator on.
.ANNUNCIATOR_TRIGGER: TRIG indicator on.
.DIGITS_4_5: Set the front-panel display resolution to 4.5 digits.
.DIGITS_5_5: Set the front-panel display resolution to 5.5 digits.
.DIGITS_6_5: Set the front-panel display resolution to 6.5 digits.
.DISABLE: Disable the front-panel keys for numeric entry when entering a value.
.DONT_SAVE: Do not save code to nonvolatile memory.
.ENABLE: Enable the front-panel keys for numeric entry when entering a value.
.KEY_AUTO: Represents the range AUTO key.
.KEY_CONFIG: Represents the CONFIG key.
.KEY_DIGITSA: Represents the DIGITS (display resolution) key. For two-channel products, this is the DIGITS key for Channel A.
.KEY_DISPLAY: Represents the DISPLAY key.
.KEY_ENTER: Represents the ENTER key.
.KEY_EXIT: Represents the EXIT key.
.KEY_FILTERA: Represents the FILTER key. For two-channel products, this is the FILTER key for Channel A.
.KEY_LEFT: Represents the left CURSOR key.
.KEY_LIMITA: Represents the LIMIT key. For two-channel products, this is the LIMIT key for Channel A.
.KEY_LOAD: Represents the LOAD (load test) key.
.KEY_MEASA: Represents the MEAS (Measure) key. For two-channel products, this is the MEAS key for Channel A.
.KEY_MENU: Represents the MENU key.
.KEY_MODEA: Represents the MODE (meter mode) key For two-channel products, this is the MODE key for Channel A.
.KEY_NONE: No key was pressed.
.KEY_OUTPUTA: Represents the OUTPUT ON/OFF key. For two-channel products, this is the OUTPUT ON/OFF key for Channel A.
.KEY_RANGEDOWN: Represents the RANGE down key.
.KEY_RANGEUP: Represents the RANGE up key.
.KEY_RECALL: Represents the RECALL key.
.KEY_RELA: Represents the REL key. For two-channel products, this is the REL key for Channel A.
.KEY_RIGHT: Represents the right CURSOR key.
.KEY_RUN: Represents the RUN key.
.KEY_SPEEDA: Represents the SPEED key. For two-channel products, this is the SPEED key for Channel A.
.KEY_SRCA: Represents the SRC (Source) key. For two-channel products, this is the SRC key for Channel A.
.KEY_STORE: Represents the STORE key.
.KEY_TRIG: Represents the TRIG key.
.LIMIT_IV: Display the primary limit value.
.LIMIT_P: Display the power limit value.
.LOCK: Unlock the EXIT (LOCAL) key.
.MEASURE_DCAMPS: Display the current measurement function.
.MEASURE_DCVOLTS: Display the voltage measurement function.
.MEASURE_OHMS: Display the resistance measurement function.
.MEASURE_WATTS: Display the power measurement function.
.SAVE: Save code to nonvolatile memory.
.SMUA: Displays source-measure and compliance screen for SMU A.
.UNLOCK: Lock out the EXIT (LOCAL) key.
.USER: Displays the user screen.
.WHEEL_ENTER: Represents pressing the navigation wheel.
.WHEEL_LEFT: Represents turning the Navigation wheel left.
.WHEEL_RIGHT: Represents turning the Navigation wheel right.

Sub-properties and sub-methods

.clear(): The display.clear() function.
.getannunciators(): The display.getannunciators() function.
.getcursor(): The display.getcursor() function.
.getlastkey(): The display.getlastkey() function.
.gettext(): The display.gettext() function.
.inputvalue(): The display.inputvalue() function.
.loadmenu: The display.loadmenu command tree.
.locallockout: The display.locallockout attribute.
.menu(): The display.menu() function.
.numpad: The display.numpad attribute.
.prompt(): The display.prompt() function.
.screen: The display.screen attribute.
.sendkey(): The display.sendkey() function.
.setcursor(): The display.setcursor() function.
.settext(): The display.settext() function.
.smu: The display.smuX command tree.
.trigger: The display.trigger command tree.
.waitkey(): The display.waitkey() function.

errorqueue `property` ¶

errorqueue: Errorqueue

Return the errorqueue command tree.

Sub-properties and sub-methods

.clear(): The errorqueue.clear() function.
.count: The errorqueue.count attribute.
.next(): The errorqueue.next() function.

eventlog `property` ¶

eventlog: Eventlog

Return the eventlog command tree.

Constants

.DISABLE: Disable the event log.
.DISCARD_NEWEST: Do not log new entries.
.DISCARD_OLDEST: Delete old entries are deleted as new events are logged.
.ENABLE: Enable the event log.

Sub-properties and sub-methods

.all(): The eventlog.all() function.
.clear(): The eventlog.clear() function.
.count: The eventlog.count attribute.
.enable: The eventlog.enable attribute.
.next(): The eventlog.next() function.
.overwritemethod: The eventlog.overwritemethod attribute.

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.
.DREAL: Sets the data format for data that is printed using the printnumber() and printbuffer() functions to be double-precision IEEE Std 754 binary format.
.LITTLEENDIAN: Sets the binary byte order for the data that is printed using the printnumber() and printbuffer() functions to be least significant byte first.
.NETWORK: Sets the binary byte order for the data that is printed using the printnumber() and printbuffer() functions to be most significant byte first.
.NORMAL: Sets the binary byte order for the data that is printed using the printnumber() and printbuffer() functions to be most significant byte first.
.REAL: Sets the data format for data that is printed using the printnumber() and printbuffer() functions to be double-precision IEEE Std 754 binary format.
.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.
.SREAL: Sets the data format for data that is printed using the printnumber() and printbuffer() functions to be single-precision IEEE Std 754 binary format.
.SWAPPED: Sets the binary byte order for the data that is printed using the printnumber() and printbuffer() functions to be least significant byte first.

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.

io `property` ¶

io: Io

Return the io command tree.

Sub-properties and sub-methods

.close(): The io.close() function.
.flush(): The io.flush() function.
.input(): The io.input() function.
.open(): The io.open() function.
.output(): The io.output() function.
.read(): The io.read() function.
.type(): The io.type() function.
.write(): The io.write() function.

lan `property` ¶

lan: Lan

Return the lan command tree.

Constants

.AUTO: Selects automatic sequencing of configuration.
.DISABLE: Disables automatic link reconnection and monitoring.
.ENABLE: Enables automatic link reconnection and monitoring.
.FULL: Full-duplex operation.
.HALF: Half-duplex operation.
.MANUAL: Use only manually specified configuration settings.
.MULTICAST: Sets the LAN protocol to use for sending trigger messages to multicast.
.TCP: Use TCP protocol.
.TRIG_EITHER: Sets the trigger operation and detection mode of the specified LAN event to rising or falling edge (positive or negative state).
.TRIG_FALLING: Sets the trigger operation and detection mode of the specified LAN event to falling edge (negative state).
.TRIG_RISING: Sets the trigger operation and detection mode of the specified LAN event to rising edge (positive state).
.TRIG_RISINGA: Sets the trigger operation and detection mode of the specified LAN event to rising edge (positive state).
.TRIG_RISINGM: Sets the trigger operation and detection mode of the specified LAN event to rising edge (positive state).
.TRIG_SYNCHRONOUS: Use for compatibility with older instruments; sets the trigger operation and detection mode of the specified LAN event to falling edge (negative state).
.TRIG_SYNCHRONOUSA: Sets the trigger operation and detection mode of the specified LAN event to falling edge (negative state).
.TRIG_SYNCHRONOUSM: Sets the trigger operation and detection mode of the specified LAN event to rising edge (positive state).
.UDP: Use UDP protocol.

Sub-properties and sub-methods

.applysettings(): The lan.applysettings() function.
.autoconnect: The lan.autoconnect attribute.
.config: The lan.config command tree.
.linktimeout: The lan.linktimeout attribute.
.lxidomain: The lan.lxidomain attribute.
.nagle: The lan.nagle attribute.
.reset(): The lan.reset() function.
.restoredefaults(): The lan.restoredefaults() function.
.status: The lan.status command tree.
.timedwait: The lan.timedwait attribute.
.trigger: The lan.trigger[N] command tree.

localnode `property` ¶

localnode: Localnode

Return the localnode command tree.

Constants

.PASSWORD_ALL: Use passwords on the web interface and all remote command interfaces.
.PASSWORD_LAN: Use passwords on the web interface and all LAN interfaces.
.PASSWORD_NONE: Disable passwords everywhere.
.PASSWORD_WEB: Use passwords on the web interface only.

Sub-properties and sub-methods

.description: The localnode.description attribute.
.license: The localnode.license attribute.
.linefreq: The localnode.linefreq attribute.
.model: The localnode.model attribute.
.password: The localnode.password attribute.
.passwordmode: The localnode.passwordmode attribute.
.prompts: The localnode.prompts attribute.
.prompts4882: The localnode.prompts4882 attribute.
.reset(): The localnode.reset() function.
.revision: The localnode.revision attribute.
.serialno: The localnode.serialno attribute.
.showerrors: The localnode.showerrors 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.

os `property` ¶

os: Os

Return the os command tree.

Sub-properties and sub-methods

.remove(): The os.remove() function.
.rename(): The os.rename() function.
.time(): The os.time() function.

script `property` ¶

script: Script

Return the script command tree.

Sub-properties and sub-methods

.anonymous: The script.anonymous attribute.
.delete(): The script.delete() function.
.load(): The script.load() function.
.new(): The script.new() function.
.newautorun(): The script.newautorun() function.
.restore(): The script.restore() function.
.run(): The script.run() 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

.autorun: The scriptVar.autorun attribute.
.list(): The scriptVar.list() function.
.name: The scriptVar.name attribute.
.run(): The scriptVar.run() function.
.save(): The scriptVar.save() function.
.source: The scriptVar.source attribute.

serial `property` ¶

serial: Serial

Return the serial command tree.

Constants

.FLOW_HARDWARE: Hardware flow control.
.FLOW_NONE: No flow control.
.PARITY_EVEN: Select even parity.
.PARITY_NONE: Select no parity.
.PARITY_ODD: Select odd parity.

Sub-properties and sub-methods

.baud: The serial.baud attribute.
.databits: The serial.databits attribute.
.flowcontrol: The serial.flowcontrol attribute.
.parity: The serial.parity attribute.
.read(): The serial.read() function.
.write(): The serial.write() function.

setup `property` ¶

setup: Setup

Return the setup command tree.

Sub-properties and sub-methods

.poweron: The setup.poweron attribute.
.recall(): The setup.recall() function.
.save(): The setup.save() function.

smu `property` ¶

smu: dict[str, SmuxItem]

Return the smuX command tree.

Constants

.ASYNC: Make measurements during the sweep, but asynchronously with the source area of the trigger model.
.AUTORANGE_FOLLOW_LIMIT: Set the measure range to the limit range.
.AUTORANGE_OFF: Disable autorange.
.AUTORANGE_ON: Enable autorange.
.AUTOZERO_AUTO: Automatically check reference and zero measurements and perform an autozero when needed.
.AUTOZERO_OFF: Disable autozero.
.AUTOZERO_ONCE: Performs autozero once, then disables autozero.
.CALSET_DEFAULT: Load normal calibration constants.
.CALSET_FACTORY: Load calibration constants when the instrument left the factory.
.CALSET_NOMINAL: Load calibration constants that are uncalibrated, but set to nominal values to allow rudimentary functioning of the instrument.
.CALSET_PREVIOUS: Load the calibration constants that were used before the last default set was overwritten.
.CALSTATE_CALIBRATING: Calibration constants or dates have been changed but not yet saved to nonvolatile memory.
.CALSTATE_LOCKED: Calibration is locked.
.CALSTATE_UNLOCKED: Calibration is unlocked but none of the calibration constants or dates have changed since the last save/restore.
.CAL_AUTO: Use automatic polarity detection for calibration constants.
.CAL_NEGATIVE: Measure with negative polarity calibration constants.
.CAL_POSITIVE: Measure with positive polarity calibration constants.
.CONTACT_FAST: Select the fast speed setting.
.CONTACT_MEDIUM: Select the medium speed setting.
.CONTACT_SLOW: Select the slow speed setting.
.DELAY_AUTO: Use the automatic delay value.
.DELAY_OFF: Do not include a delay before measurements.
.DISABLE: Use conventional pulsing and full source-measure unit (SMU) functionality.
.ENABLE: Allow fast-edge pulsing using the trigger model.
.FILL_ONCE: Set the reading buffer fill mode to not overwrite old data.
.FILL_WINDOW: Set the reading buffer fill mode to restart new readings at index 1 after acquiring reading at index bufferVar.fillcount.
.FILTER_MEDIAN: Selects the median filter when measurement filter is enabled.
.FILTER_MOVING_AVG: Selects the moving filter when measurement filter is enabled.
.FILTER_OFF: Disable filter measurements.
.FILTER_ON: Enable filter measurements.
.FILTER_REPEAT_AVG: Selects the repeating filter when measurement filter is enabled.
.LIMIT_AUTO: Set the sweep source limit to automatic.
.OE_NONE: When output enable is deasserted, take no action.
.OE_OUTPUT_OFF: When output enable is deasserted, turn the source output off.
.OUTPUT_DCAMPS: Select the current function for the pulse.
.OUTPUT_DCVOLTS: Select the voltage function for the pulse.
.OUTPUT_HIGH_Z: Opens the output relay when the output is turned off.
.OUTPUT_NORMAL: Configures the source function according to smuX.source.offfunc attribute.
.OUTPUT_OFF: Turns off the source output.
.OUTPUT_ON: Turn on the source output.
.OUTPUT_ZERO: Configures source to output 0 V as smuX.OUTPUT_NORMAL with different compliance handling.
.REL_OFF: Disables relative measurements.
.REL_ON: Enables relative measurements.
.SENSE_CALA: Set the sense mode to calibration.
.SENSE_LOCAL: Set the sense mode to local sense (2-wire).
.SENSE_REMOTE: Set the sense mode to remote sense (4-wire).
.SETTLE_DIRECT_IRANGE: Instructs the SMU to change the current range directly.
.SETTLE_FAST_ALL: Enable the smuX.SETTLE_FAST_RANGE and smuX.SETTLE_FASTPOLARITY operations.
.SETTLE_FAST_POLARITY: Instructs the SMU to change polarity without going to zero.
.SETTLE_FAST_RANGE: Instructs the source-measure unit (SMU) to use a faster procedure when changing ranges.
.SETTLE_SMOOTH: Turn off additional settling operations.
.SOURCE_HOLD: Disables pulse mode sweeps, holding the source level for the remainder of the step.
.SOURCE_IDLE: Sets the source level to the programmed (idle) level at the end of the pulse.

Sub-properties and sub-methods

.abort(): The smuX.abort() function.
.buffer: The smuX.buffer command tree.
.cal: The smuX.cal command tree.
.contact: The smuX.contact command tree.
.makebuffer(): The smuX.makebuffer() function.
.measure: The smuX.measure command tree.
.measureiandstep(): The smuX.measureiandstep() function.
.measureivandstep(): The smuX.measureivandstep() function.
.measurepandstep(): The smuX.measurepandstep() function.
.measurerandstep(): The smuX.measurerandstep() function.
.measurevandstep(): The smuX.measurevandstep() function.
.nvbuffer1: The smuX.nvbuffer1 attribute.
.nvbuffer2: The smuX.nvbuffer2 attribute.
.reset(): The smuX.reset() function.
.savebuffer(): The smuX.savebuffer() function.
.sense: The smuX.sense attribute.
.source: The smuX.source command tree.
.trigger: The smuX.trigger command tree.

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.
.ERROR_AVAILABLE: 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.
.EVENT_SUMMARY_BIT: B5. Set summary bit indicates that an enabled standard event has occurred.
.MASTER_SUMMARY_STATUS: B6. 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.
.MAV: B4. Set summary bit indicates that a response message is present in the Output Queue.
.MEASUREMENT_SUMMARY_BIT: B0. Set summary bit indicates that an enabled measurement event has occurred.
.MESSAGE_AVAILABLE: 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.
.OPERATION_SUMMARY_BIT: B7. Set summary bit indicates that an enabled operation event has occurred.
.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.
.QUESTIONABLE_SUMMARY_BIT: B3. Set summary bit indicates that an enabled questionable event has occurred.
.SSB: B1. Set summary bit indicates that an enabled system event has occurred.
.SYSTEM_SUMMARY_BIT: B1. Set summary bit indicates that an enabled system event has occurred.

Sub-properties and sub-methods

.condition: The status.condition attribute.
.measurement: The status.measurement command tree.
.node_enable: The status.node_enable attribute.
.node_event: The status.node_event attribute.
.operation: The status.operation command tree.
.questionable: The status.questionable command tree.
.request_enable: The status.request_enable attribute.
.request_event: The status.request_event attribute.
.reset(): The status.reset() function.
.standard: The status.standard command tree.
.system: The status.system command tree.
.system2: The status.system2 command tree.
.system3: The status.system3 command tree.
.system4: The status.system4 command tree.
.system5: The status.system5 command tree.

timer `property` ¶

timer: Timer

Return the timer command tree.

Sub-properties and sub-methods

.measure: The timer.measure command tree.
.reset(): The timer.reset() function.

trigger `property` ¶

trigger: Trigger

Return the trigger command tree.

Constants

.EVENT_ID: The command interface trigger event number.

Sub-properties and sub-methods

.blender: The trigger.blender[N] command tree.
.clear(): The trigger.clear() function.
.generator: The trigger.generator[N] command tree.
.timer: The trigger.timer[N] command tree.
.wait(): The trigger.wait() function.

tsplink `property` ¶

tsplink: Tsplink

Return the tsplink command tree.

Constants

.TRIG_BYPASS: Allows direct control of the line as a digital I/O line.
.TRIG_EITHER: Detects rising-edge or falling-edge triggers as input. Asserts a TTL-low pulse for output.
.TRIG_FALLING: Detects falling-edge triggers as input. Asserts a TTL-low pulse for output.
.TRIG_RISING: If the programmed state of the line is high, the tsplink.TRIG_RISING mode behaves similarly to tsplink.TRIG_RISINGA. If the programmed state of the line is low, the tsplink.TRIG_RISING mode behaves similarly 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.
.TRIG_RISINGA: Detects rising-edge triggers as input. Asserts a TTL-low pulse for output.
.TRIG_RISINGM: Edge detection as an input is not available. Generates a TTL-high pulse as an output trigger.
.TRIG_SYNCHRONOUS: Detects the falling-edge input triggers and automatically latches and drives the trigger line low. Asserts a TTL-low pulse as an output trigger.
.TRIG_SYNCHRONOUSA: Detects the falling-edge input triggers and automatically latches and drives the trigger line low.
.TRIG_SYNCHRONOUSM: Detects rising-edge triggers as an input. Asserts a TTL-low pulse for output.

Sub-properties and sub-methods

.group: The tsplink.group attribute.
.master: The tsplink.master attribute.
.node: The tsplink.node attribute.
.readbit(): The tsplink.readbit() function.
.readport(): The tsplink.readport() function.
.reset(): The tsplink.reset() function.
.state: The tsplink.state attribute.
.trigger: The tsplink.trigger[N] command tree.
.writebit(): The tsplink.writebit() function.
.writeport(): The tsplink.writeport() function.
.writeprotect: The tsplink.writeprotect attribute.

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.

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.

config_pulse_i_measure_v ¶

config_pulse_i_measure_v(
    smu: str,
    bias: float,
    level: float,
    limit: float,
    ton: float,
    toff: float,
    points: int,
    buffer: str,
    tag: int,
    sync_in: str | None = None,
    sync_out: str | None = None,
    sync_in_timeout: float | None = None,
    sync_in_abort: str | None = None,
) -> str

Run the ConfigPulseIMeasureV() function.

Description

This KIPulse factory script function configures a current pulse train with a voltage measurement at each point.

TSP Syntax

- ConfigPulseIMeasureV()

Parameters:

smu (str) –

Instrument channel (set to smua).
bias (float) –

Bias level in amperes.
level (float) –

Pulse level in amperes.
limit (float) –

Voltage limit (for example, compliance) in volts.
ton (float) –

Pulse on time in seconds.
toff (float) –

Pulse off time in seconds.
points (int) –

Number of pulse-measure cycles.
buffer (str) –

Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated.
tag (int) –

Numeric identifier to be assigned to the defined pulse train.
sync_in (optional, default: None ) –

Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse.
sync_out (optional, default: None ) –

Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton.
sync_in_timeout (optional, default: None ) –

Specifies the length of time (in seconds) to wait for input trigger; default value is 10 s.
sync_in_abort (optional, default: None ) –

Specifies whether or not to abort the pulse if an input trigger is not received; if pulse aborts because of a missed trigger, a timer timeout message is returned; true or false.

Returns:	`str` – The result of the function call.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

config_pulse_i_measure_v_sweep_lin ¶

config_pulse_i_measure_v_sweep_lin(
    smu: str,
    bias: float,
    start: float,
    stop: float,
    limit: float,
    ton: float,
    toff: float,
    points: int,
    buffer: str,
    tag: int,
    sync_in: str | None = None,
    sync_out: str | None = None,
    sync_in_timeout: float | None = None,
    sync_in_abort: str | None = None,
) -> str

Run the ConfigPulseIMeasureVSweepLin() function.

Description

This KIPulse factory script function configures a linear pulsed current sweep with a voltage measurement at each point.

TSP Syntax

- ConfigPulseIMeasureVSweepLin()

Parameters:

smu (str) –

Instrument channel (set to smua).
bias (float) –

Bias level in amperes.
start (float) –

Pulse sweep start level in amperes.
stop (float) –

Pulse sweep stop level in amperes.
limit (float) –

Voltage limit (for example, compliance) in volts.
ton (float) –

Pulse on time in seconds.
toff (float) –

Pulse off time in seconds.
points (int) –

Number of pulse-measure cycles.
buffer (str) –

Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated.
tag (int) –

Numeric identifier to be assigned to the defined pulse train.
sync_in (optional, default: None ) –

Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse.
sync_out (optional, default: None ) –

Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton.
sync_in_timeout (optional, default: None ) –

Specifies the length of time (in seconds) to wait for input trigger; default value is 10 s.
sync_in_abort (optional, default: None ) –

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.

Returns:	`str` – The result of the function call.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

config_pulse_i_measure_v_sweep_log ¶

config_pulse_i_measure_v_sweep_log(
    smu: str,
    bias: float,
    start: float,
    stop: float,
    limit: float,
    ton: float,
    toff: float,
    points: int,
    buffer: str,
    tag: int,
    sync_in: str | None = None,
    sync_out: str | None = None,
    sync_in_timeout: float | None = None,
    sync_in_abort: str | None = None,
) -> str

Run the ConfigPulseIMeasureVSweepLog() function.

Description

This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.

TSP Syntax

- ConfigPulseIMeasureVSweepLog()

Parameters:

smu (str) –

Instrument channel (set to smua).
bias (float) –

Bias level in amperes.
start (float) –

Pulse sweep start level in amperes.
stop (float) –

Pulse sweep stop level in amperes.
limit (float) –

Voltage limit (for example, compliance) in volts.
ton (float) –

Pulse on time in seconds.
toff (float) –

Pulse off time in seconds.
points (int) –

Number of pulse-measure cycles.
buffer (str) –

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 (int) –

Numeric identifier to be assigned to the defined pulse train.
sync_in (optional, default: None ) –

Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse.
sync_out (optional, default: None ) –

Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton.
sync_in_timeout (optional, default: None ) –

Specifies the length of time (in seconds) to wait for input trigger; default value is 10 s.
sync_in_abort (optional, default: None ) –

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.

Returns:	`str` – The result of the function call.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

config_pulse_v_measure_i ¶

config_pulse_v_measure_i(
    smu: str,
    bias: float,
    level: float,
    limit: float,
    ton: float,
    toff: float,
    points: int,
    buffer: str,
    tag: int,
    sync_in: str | None = None,
    sync_out: str | None = None,
    sync_in_timeout: float | None = None,
    sync_in_abort: str | None = None,
) -> str

Run the ConfigPulseVMeasureI() function.

Description

This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.

TSP Syntax

- ConfigPulseVMeasureI()

Parameters:

smu (str) –

Instrument channel (set to smua).
bias (float) –

Bias level in volts.
level (float) –

Pulse level in volts.
limit (float) –

Current limit (for example, compliance) in amperes.
ton (float) –

Pulse on time in seconds.
toff (float) –

Pulse off time in seconds.
points (int) –

Number of pulse-measure cycles.
buffer (str) –

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 (int) –

Numeric identifier to be assigned to the defined pulse train.
sync_in (optional, default: None ) –

Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse.
sync_out (optional, default: None ) –

Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton.
sync_in_timeout (optional, default: None ) –

Specifies the length of time (in seconds) to wait for input trigger; default value is 10 s.
sync_in_abort (optional, default: None ) –

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.

Returns:	`str` – The result of the function call.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

config_pulse_v_measure_i_sweep_lin ¶

config_pulse_v_measure_i_sweep_lin(
    smu: str,
    bias: float,
    start: float,
    stop: float,
    limit: float,
    ton: float,
    toff: float,
    points: int,
    buffer: str,
    tag: int,
    sync_in: str | None = None,
    sync_out: str | None = None,
    sync_in_timeout: float | None = None,
    sync_in_abort: str | None = None,
) -> str

Run the ConfigPulseVMeasureISweepLin() function.

Description

This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.

TSP Syntax

- ConfigPulseVMeasureISweepLin()

Parameters:

smu (str) –

Instrument channel (set to smua).
bias (float) –

Bias level in volts.
start (float) –

Pulse sweep start level in volts.
stop (float) –

Pulse sweep stop level in volts.
limit (float) –

Current limit (for example, compliance) in amperes.
ton (float) –

Pulse on time in seconds.
toff (float) –

Pulse off time in seconds.
points (int) –

Number of pulse-measure cycles.
buffer (str) –

Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated.
tag (int) –

Numeric identifier to be assigned to the defined pulse train.
sync_in (optional, default: None ) –

Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse.
sync_out (optional, default: None ) –

Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton.
sync_in_timeout (optional, default: None ) –

Specifies the length of time (in seconds) to wait for input trigger; default value is 10 s.
sync_in_abort (optional, default: None ) –

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.

Returns:	`str` – The result of the function call.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

config_pulse_v_measure_i_sweep_log ¶

config_pulse_v_measure_i_sweep_log(
    smu: str,
    bias: float,
    start: float,
    stop: float,
    limit: float,
    ton: float,
    toff: float,
    points: int,
    buffer: str,
    tag: int,
    sync_in: str | None = None,
    sync_out: str | None = None,
    sync_in_timeout: float | None = None,
    sync_in_abort: str | None = None,
) -> str

Run the ConfigPulseVMeasureISweepLog() function.

Description

This KIPulse factory script function configures a voltage pulse train with a current measurement at each point.

TSP Syntax

- ConfigPulseVMeasureISweepLog()

Parameters:

smu (str) –

Instrument channel (set to smua).
bias (float) –

Bias level in volts.
start (float) –

Pulse sweep start level in volts.
stop (float) –

Pulse sweep stop level in volts.
limit (float) –

Current limit (for example, compliance) in amperes.
ton (float) –

Pulse on time in seconds.
toff (float) –

Pulse off time in seconds.
points (int) –

Number of pulse-measure cycles.
buffer (str) –

Reading buffer where pulsed measurements are stored; if this is nil when the function is called, no measurements are made when the pulse train is initiated.
tag (int) –

Numeric identifier to be assigned to the defined pulse train.
sync_in (optional, default: None ) –

Defines a digital I/O trigger input line; if programmed, the pulse train waits for a trigger input before executing each pulse.
sync_out (optional, default: None ) –

Defines a digital I/O trigger output line; if programmed, the pulse train generates a trigger output immediately before the start of ton.
sync_in_timeout (optional, default: None ) –

Specifies the length of time (in seconds) to wait for input trigger; default value is 10 s.
sync_in_abort (optional, default: None ) –

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.

Returns:	`str` – The result of the function call.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

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:	`NoDeviceProvidedError` – Indicates that no device connection exists.

exit ¶

exit() -> None

Run the exit() function.

Description

This function stops a script that is presently running.

TSP Syntax

- exit()

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

gettimezone ¶

gettimezone() -> str

Run the gettimezone() function.

Description

This function retrieves the local time zone.

TSP Syntax

- gettimezone()

Returns:	`str` – The result of the function call.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

gm_isweep ¶

gm_isweep(smu: str, start_i: str, stop_i: str, points: str) -> str

Run the gm_isweep() function.

Description

This KIParlib factory script function performs a linear current sweep and calculates the transconductance (Gm) at each point.

TSP Syntax

- gm_isweep()

Parameters:	`smu` (`str`) – Instrument channel (set to smua). `start_i` (`str`) – Starting current level of the sweep. `stop_i` (`str`) – Ending current level of the sweep. `points` (`str`) – Number of measurements between start_i and stop_i (must be ≥2).

Returns:	`str` – The result of the function call.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

gm_vsweep ¶

gm_vsweep(smu: str, start_v: str, stop_v: str, points: str) -> str

Run the gm_vsweep() function.

Description

This KIParlib factory script function performs a linear voltage sweep and calculates the transconductance (Gm) at each point.

TSP Syntax

- gm_vsweep()

Parameters:	`smu` (`str`) – Instrument channel (set to smua). `start_v` (`str`) – Starting voltage level of the sweep. `stop_v` (`str`) – Ending voltage level of the sweep. `points` (`str`) – Number of measurements between start_v and stop_v (must be ≥ 2).

Returns:	`str` – The result of the function call.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

initiate_pulse_test ¶

initiate_pulse_test(tag: int) -> str

Run the InitiatePulseTest() function.

Description

This KIPulse factory script function initiates the pulse configuration assigned to tag.

TSP Syntax

- InitiatePulseTest()

Parameters:	`tag` (`int`) – Numeric identifier of the pulse configuration to be initiated.

Returns:	`str` – The result of the function call.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

makegetter ¶

makegetter(table: str, attribute_name: str) -> str

Run the makegetter() function.

Description

This function creates a function to get the value of an attribute.

TSP Syntax

- makegetter()

Parameters:	`table` (`str`) – Read-only table where the attribute is located. `attribute_name` (`str`) – A string representing the name of the attribute.

Returns:	`str` – The result of the function call.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

makesetter ¶

makesetter(table: str, attribute_name: str) -> str

Run the makesetter() function.

Description

This function creates a function that, when called, sets the value of an attribute.

TSP Syntax

- makesetter()

Parameters:	`table` (`str`) – Read-only table where the attribute is located. `attribute_name` (`str`) – The string name of the attribute.

Returns:	`str` – The result of the function call.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

meminfo ¶

meminfo() -> str

Run the meminfo() function.

Description

This function returns the present amount of available memory and the total amount of memory in the instrument.

TSP Syntax

- meminfo()

Returns:	`str` – The result of the function call.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

opc ¶

opc() -> None

Run the opc() function.

Description

This function sets the operation complete status bit when all overlapped commands are completed.

TSP Syntax

- opc()

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

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:	`NoDeviceProvidedError` – Indicates that no device connection exists.

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`) – First table or reading buffer subtable to print.

Returns:	`str` – The result of the function call.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

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:	`NoDeviceProvidedError` – Indicates that no device connection exists.

pulse_i_measure_v ¶

pulse_i_measure_v(
    smu: str, bias: float, level: float, ton: float, toff: float, points: int
) -> None

Run the PulseIMeasureV() function.

Description

This KIPulse factory script function performs a specified number of pulse I, measure V cycles.

TSP Syntax

- PulseIMeasureV()

Parameters:	`smu` (`str`) – Instrument channel (set to smua). `bias` (`float`) – Bias level in amperes. `level` (`float`) – Pulse level in amperes. `ton` (`float`) – Pulse on time in seconds. `toff` (`float`) – Pulse off time in seconds. `points` (`int`) – Number of pulse-measure cycles.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

pulse_v_measure_i ¶

pulse_v_measure_i(
    smu: str, bias: float, level: float, ton: float, toff: float, points: int
) -> None

Run the PulseVMeasureI() function.

Description

This KIPulse factory script function performs a specified number of pulse V, measure I cycles.

TSP Syntax

- PulseVMeasureI()

Parameters:	`smu` (`str`) – Instrument channel (set to smua). `bias` (`float`) – Bias level in volts. `level` (`float`) – Pulse level in volts. `ton` (`float`) – Pulse on time in seconds. `toff` (`float`) – Pulse off time in seconds. `points` (`int`) – Number of pulse-measure cycles.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

query_pulse_config ¶

query_pulse_config(tag: int) -> str

Run the QueryPulseConfig() function.

Description

This KIPulse factory script function allows you to inspect the settings of the preconfigured pulse train assigned to tag.

TSP Syntax

- QueryPulseConfig()

Parameters:	`tag` (`int`) – Numeric identifier to be assigned to the defined pulse train.

Returns:	`str` – The result of the function call.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

reset ¶

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

Run the reset() function.

Description

This function resets commands to their default settings.

TSP Syntax

- reset()

Parameters:	`system` (`optional`, default: `None` ) – What to reset.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

savebuffer ¶

savebuffer(buffer: str, format_type: str, file_name: str) -> None

Run the savebuffer() function.

Description

This KISavebuffer factory script function saves a specified reading buffer as either a .csv file or an .xml file.

TSP Syntax

- savebuffer()

Parameters:	`buffer` (`str`) – The reading buffer to save. `format_type` (`str`) – A string indicating which file type to use. `file_name` (`str`) – The file name of the saved buffer.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

settime ¶

settime(time: str) -> None

Run the settime() function.

Description

This function sets the real-time clock (sets present time of the system).

TSP Syntax

- settime()

Parameters:	`time` (`str`) – The time in seconds since January 1, 1970 UTC.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

settimezone ¶

settimezone(
    offset: str,
    dst_offset: str | None = None,
    dst_start: str | None = None,
    dst_end: str | None = None,
) -> None

Run the settimezone() function.

Description

This function sets the local time zone.

TSP Syntax

- settimezone()

Parameters:	`offset` (`str`) – String representing offset from UTC. `dst_offset` (`optional`, default: `None` ) – String representing the daylight savings offset from UTC. `dst_start` (`optional`, default: `None` ) – String representing when daylight savings time starts. `dst_end` (`optional`, default: `None` ) – String representing when daylight savings time ends.

Raises:	`NoDeviceProvidedError` – Indicates that no device connection exists.

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:	`NoDeviceProvidedError` – Indicates that no device connection exists.

SMU2657AMixin ¶

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

Properties

.command_argument_constants: The SMU2657A command argument constants.
.commands: The SMU2657A commands.

command_argument_constants `cached` `property` ¶

command_argument_constants: SMU2657ACommandConstants

Return the SMU2657A command argument constants.

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

commands `cached` `property` ¶

commands: SMU2657ACommands

Return the SMU2657A commands.

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

Sub-properties and sub-methods

.beeper: The beeper command tree.
.bit: The bit command tree.
.buffer_var: The bufferVar command tree.
.config_pulse_i_measure_v(): The ConfigPulseIMeasureV() function.
.config_pulse_i_measure_v_sweep_lin(): The ConfigPulseIMeasureVSweepLin() function.
.config_pulse_i_measure_v_sweep_log(): The ConfigPulseIMeasureVSweepLog() function.
.config_pulse_v_measure_i(): The ConfigPulseVMeasureI() function.
.config_pulse_v_measure_i_sweep_lin(): The ConfigPulseVMeasureISweepLin() function.
.config_pulse_v_measure_i_sweep_log(): The ConfigPulseVMeasureISweepLog() function.
.dataqueue: The dataqueue command tree.
.delay(): The delay() function.
.digio: The digio command tree.
.display: The display command tree.
.errorqueue: The errorqueue command tree.
.eventlog: The eventlog command tree.
.exit(): The exit() function.
.format: The format command tree.
.fs: The fs command tree.
.gettimezone(): The gettimezone() function.
.gm_isweep(): The gm_isweep() function.
.gm_vsweep(): The gm_vsweep() function.
.gpib: The gpib command tree.
.initiate_pulse_test(): The InitiatePulseTest() function.
.io: The io command tree.
.lan: The lan command tree.
.localnode: The localnode command tree.
.makegetter(): The makegetter() function.
.makesetter(): The makesetter() function.
.meminfo(): The meminfo() function.
.node: The node[N] command tree.
.opc(): The opc() function.
.os: The os command tree.
.print(): The print() function.
.printbuffer(): The printbuffer() function.
.printnumber(): The printnumber() function.
.pulse_i_measure_v(): The PulseIMeasureV() function.
.pulse_v_measure_i(): The PulseVMeasureI() function.
.query_pulse_config(): The QueryPulseConfig() function.
.reset(): The reset() function.
.savebuffer(): The savebuffer() function.
.script_var: The scriptVar command tree.
.script: The script command tree.
.serial: The serial command tree.
.settime(): The settime() function.
.settimezone(): The settimezone() function.
.setup: The setup command tree.
.smu: The smuX 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.
.userstring: The userstring command tree.
.waitcomplete(): The waitcomplete() function.

smu2657a_commands ¶

SMU2657ACommandConstants ¶

SMU2657ACommands ¶

beeper property ¶

bit property ¶

buffer_var property ¶

dataqueue property ¶

digio property ¶

display property ¶

errorqueue property ¶

eventlog property ¶

format property ¶

fs property ¶

gpib property ¶

io property ¶

lan property ¶

localnode property ¶

node property ¶

os property ¶

script property ¶

script_var property ¶

serial property ¶

setup property ¶

smu property ¶

status property ¶

timer property ¶

trigger property ¶

tsplink property ¶

tspnet property ¶

userstring property ¶

config_pulse_i_measure_v ¶

config_pulse_i_measure_v_sweep_lin ¶

config_pulse_i_measure_v_sweep_log ¶

config_pulse_v_measure_i ¶

config_pulse_v_measure_i_sweep_lin ¶

config_pulse_v_measure_i_sweep_log ¶

delay ¶

exit ¶

gettimezone ¶

gm_isweep ¶

gm_vsweep ¶

initiate_pulse_test ¶

makegetter ¶

makesetter ¶

meminfo ¶

opc ¶

print ¶

printbuffer ¶

printnumber ¶

pulse_i_measure_v ¶

pulse_v_measure_i ¶

query_pulse_config ¶

reset ¶

savebuffer ¶

settime ¶

settimezone ¶

waitcomplete ¶

SMU2657AMixin ¶

command_argument_constants cached property ¶

commands cached property ¶

beeper `property` ¶

bit `property` ¶

buffer_var `property` ¶

dataqueue `property` ¶

digio `property` ¶

display `property` ¶

errorqueue `property` ¶

eventlog `property` ¶

format `property` ¶

fs `property` ¶

gpib `property` ¶

io `property` ¶

lan `property` ¶

localnode `property` ¶

node `property` ¶

os `property` ¶

script `property` ¶

script_var `property` ¶

serial `property` ¶

setup `property` ¶

smu `property` ¶

status `property` ¶

timer `property` ¶

trigger `property` ¶

tsplink `property` ¶

tspnet `property` ¶

userstring `property` ¶

command_argument_constants `cached` `property` ¶

commands `cached` `property` ¶