[python source code]

smu2601b_pulse_commands

The SMU2601B_Pulse commands module.

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

Please report an issue if one is found.

SMU2601BPulseCommandConstants

The SMU2601B_Pulse command argument constants.

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

SMU2601BPulseCommands

The SMU2601B-Pulse commands.

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

Properties and methods
  • .beeper: The beeper command tree.
  • .buffer_var: The bufferVar command tree.
  • .dataqueue: The dataqueue command tree.
  • .digio: The digio command tree.
  • .display: The display command tree.
  • .errorqueue: The errorqueue command tree.
  • .eventlog: The eventlog command tree.
  • .format: The format command tree.
  • .gpib: The gpib command tree.
  • .lan: The lan command tree.
  • .localnode: The localnode command tree.
  • .serial: The serial command tree.
  • .smu: The smuX command tree.
  • .status: The status command tree.
  • .trigger: The trigger command tree.
  • .tsplink: The tsplink command tree.
  • .tspnet: The tspnet command tree.

beeper property 

beeper: Beeper

Return the beeper command tree.

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

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
  • .capacity: The bufferVar.capacity attribute.
  • .statuses: The bufferVar.statuses[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.

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
  • .trigger: The digio.trigger[N] command tree.

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
  • .getlastkey(): The display.getlastkey() function.
  • .screen: The display.screen attribute.
  • .sendkey(): The display.sendkey() 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
  • .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.

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.

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
  • .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
  • .config: The lan.config command tree.
  • .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
  • .model: The localnode.model attribute.

serial property 

serial: Serial

Return the serial command tree.

Sub-properties and sub-methods
  • .baud: The serial.baud attribute.
  • .databits: The serial.databits attribute.
  • .parity: The serial.parity attribute.

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.
  • .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.
  • .interlock: The smuX.interlock 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.
  • .pulser: The smuX.pulser command tree.
  • .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
  • .measurement: The status.measurement command tree.
  • .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.
  • .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.

trigger property 

trigger: Trigger

Return the trigger command tree.

Constants
  • .EVENT_ID: Selects the event that causes a trigger to be asserted on the digital output line as a *TRG command received on the remote interface.
Sub-properties and sub-methods
  • .blender: The trigger.blender[N] command tree.
  • .generator: The trigger.generator[N] command tree.
  • .timer: The trigger.timer[N] command tree.
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
  • .trigger: The tsplink.trigger[N] command tree.

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.

SMU2601BPulseMixin

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

Properties
  • .command_argument_constants: The SMU2601B_Pulse command argument constants.
  • .commands: The SMU2601B-Pulse commands.

command_argument_constants cached property 

command_argument_constants: SMU2601BPulseCommandConstants

Return the SMU2601B_Pulse command argument constants.

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

commands cached property 

commands: SMU2601BPulseCommands

Return the SMU2601B-Pulse commands.

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

Sub-properties and sub-methods
  • .beeper: The beeper command tree.
  • .buffer_var: The bufferVar command tree.
  • .dataqueue: The dataqueue command tree.
  • .digio: The digio command tree.
  • .display: The display command tree.
  • .errorqueue: The errorqueue command tree.
  • .eventlog: The eventlog command tree.
  • .format: The format command tree.
  • .gpib: The gpib command tree.
  • .lan: The lan command tree.
  • .localnode: The localnode command tree.
  • .serial: The serial command tree.
  • .smu: The smuX command tree.
  • .status: The status command tree.
  • .trigger: The trigger command tree.
  • .tsplink: The tsplink command tree.
  • .tspnet: The tspnet command tree.