[python source code]

smux

The smux commands module.

These commands are used in the following models: SMU2651A

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

Please report an issue if one is found.

Attributes and Functions 
- smuX.abort()
- smuX.buffer.getstats()
- smuX.buffer.recalculatestats()
- smuX.cal.adjustdate
- smuX.cal.date
- smuX.cal.due
- smuX.cal.fastadc()
- smuX.cal.lock()
- smuX.cal.password
- smuX.cal.polarity
- smuX.cal.restore()
- smuX.cal.save()
- smuX.cal.state
- smuX.cal.unlock()
- smuX.contact.calibratehi()
- smuX.contact.calibratelo()
- smuX.contact.check()
- smuX.contact.r()
- smuX.contact.speed
- smuX.contact.threshold
- smuX.makebuffer()
- smuX.measure.Y()
- smuX.measure.adc
- smuX.measure.autorangei
- smuX.measure.autorangev
- smuX.measure.autozero
- smuX.measure.calibrateY()
- smuX.measure.count
- smuX.measure.delay
- smuX.measure.delayfactor
- smuX.measure.filter.count
- smuX.measure.filter.enable
- smuX.measure.filter.type
- smuX.measure.highcrangedelayfactor
- smuX.measure.interval
- smuX.measure.lowrangei
- smuX.measure.lowrangev
- smuX.measure.nplc
- smuX.measure.overlappedY()
- smuX.measure.rangei
- smuX.measure.rangev
- smuX.measure.rel.enablei
- smuX.measure.rel.enablep
- smuX.measure.rel.enabler
- smuX.measure.rel.enablev
- smuX.measure.rel.leveli
- smuX.measure.rel.levelp
- smuX.measure.rel.levelr
- smuX.measure.rel.levelv
- smuX.measureYandstep()
- smuX.nvbuffer1
- smuX.nvbuffer2
- smuX.reset()
- smuX.savebuffer()
- smuX.sense
- smuX.source.autorangei
- smuX.source.autorangev
- smuX.source.calibrateY()
- smuX.source.compliance
- smuX.source.delay
- smuX.source.func
- smuX.source.highc
- smuX.source.leveli
- smuX.source.levelv
- smuX.source.limiti
- smuX.source.limitp
- smuX.source.limitv
- smuX.source.lowrangei
- smuX.source.lowrangev
- smuX.source.offfunc
- smuX.source.offlimiti
- smuX.source.offlimitv
- smuX.source.offmode
- smuX.source.output
- smuX.source.outputenableaction
- smuX.source.rangei
- smuX.source.rangev
- smuX.source.settling
- smuX.source.sink
- smuX.trigger.arm.count
- smuX.trigger.arm.set()
- smuX.trigger.arm.stimulus
- smuX.trigger.autoclear
- smuX.trigger.count
- smuX.trigger.endpulse.action
- smuX.trigger.endpulse.set()
- smuX.trigger.endpulse.stimulus
- smuX.trigger.endsweep.action
- smuX.trigger.initiate()
- smuX.trigger.measure.Y()
- smuX.trigger.measure.action
- smuX.trigger.measure.set()
- smuX.trigger.measure.stimulus
- smuX.trigger.source.action
- smuX.trigger.source.limiti
- smuX.trigger.source.limitv
- smuX.trigger.source.linearY()
- smuX.trigger.source.listY()
- smuX.trigger.source.logY()
- smuX.trigger.source.set()
- smuX.trigger.source.stimulus

SmuxItem

Bases: ValidatedChannel, BaseTSPCmd

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.
Properties and 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.

ASYNC class-attribute instance-attribute 

ASYNC = replace('smuX', f'smu{_cmd_syntax[3]}')

AUTORANGE_FOLLOW_LIMIT class-attribute instance-attribute 

AUTORANGE_FOLLOW_LIMIT = replace('smuX', f'smu{_cmd_syntax[3]}')

AUTORANGE_OFF class-attribute instance-attribute 

AUTORANGE_OFF = replace('smuX', f'smu{_cmd_syntax[3]}')

AUTORANGE_ON class-attribute instance-attribute 

AUTORANGE_ON = replace('smuX', f'smu{_cmd_syntax[3]}')

AUTOZERO_AUTO class-attribute instance-attribute 

AUTOZERO_AUTO = replace('smuX', f'smu{_cmd_syntax[3]}')

AUTOZERO_OFF class-attribute instance-attribute 

AUTOZERO_OFF = replace('smuX', f'smu{_cmd_syntax[3]}')

AUTOZERO_ONCE class-attribute instance-attribute 

AUTOZERO_ONCE = replace('smuX', f'smu{_cmd_syntax[3]}')

CALSET_DEFAULT class-attribute instance-attribute 

CALSET_DEFAULT = replace('smuX', f'smu{_cmd_syntax[3]}')

CALSET_FACTORY class-attribute instance-attribute 

CALSET_FACTORY = replace('smuX', f'smu{_cmd_syntax[3]}')

CALSET_NOMINAL class-attribute instance-attribute 

CALSET_NOMINAL = replace('smuX', f'smu{_cmd_syntax[3]}')

CALSET_PREVIOUS class-attribute instance-attribute 

CALSET_PREVIOUS = replace('smuX', f'smu{_cmd_syntax[3]}')

CALSTATE_CALIBRATING class-attribute instance-attribute 

CALSTATE_CALIBRATING = replace('smuX', f'smu{_cmd_syntax[3]}')

CALSTATE_LOCKED class-attribute instance-attribute 

CALSTATE_LOCKED = replace('smuX', f'smu{_cmd_syntax[3]}')

CALSTATE_UNLOCKED class-attribute instance-attribute 

CALSTATE_UNLOCKED = replace('smuX', f'smu{_cmd_syntax[3]}')

CAL_AUTO class-attribute instance-attribute 

CAL_AUTO = replace('smuX', f'smu{_cmd_syntax[3]}')

CAL_NEGATIVE class-attribute instance-attribute 

CAL_NEGATIVE = replace('smuX', f'smu{_cmd_syntax[3]}')

CAL_POSITIVE class-attribute instance-attribute 

CAL_POSITIVE = replace('smuX', f'smu{_cmd_syntax[3]}')

CONTACT_FAST class-attribute instance-attribute 

CONTACT_FAST = replace('smuX', f'smu{_cmd_syntax[3]}')

CONTACT_MEDIUM class-attribute instance-attribute 

CONTACT_MEDIUM = replace('smuX', f'smu{_cmd_syntax[3]}')

CONTACT_SLOW class-attribute instance-attribute 

CONTACT_SLOW = replace('smuX', f'smu{_cmd_syntax[3]}')

DELAY_AUTO class-attribute instance-attribute 

DELAY_AUTO = replace('smuX', f'smu{_cmd_syntax[3]}')

DELAY_OFF class-attribute instance-attribute 

DELAY_OFF = replace('smuX', f'smu{_cmd_syntax[3]}')

DISABLE class-attribute instance-attribute 

DISABLE = replace('smuX', f'smu{_cmd_syntax[3]}')

ENABLE class-attribute instance-attribute 

ENABLE = replace('smuX', f'smu{_cmd_syntax[3]}')

FILL_ONCE class-attribute instance-attribute 

FILL_ONCE = replace('smuX', f'smu{_cmd_syntax[3]}')

FILL_WINDOW class-attribute instance-attribute 

FILL_WINDOW = replace('smuX', f'smu{_cmd_syntax[3]}')

reading at index bufferVar.fillcount.

FILTER_MEDIAN class-attribute instance-attribute 

FILTER_MEDIAN = replace('smuX', f'smu{_cmd_syntax[3]}')

FILTER_MOVING_AVG class-attribute instance-attribute 

FILTER_MOVING_AVG = replace('smuX', f'smu{_cmd_syntax[3]}')

FILTER_OFF class-attribute instance-attribute 

FILTER_OFF = replace('smuX', f'smu{_cmd_syntax[3]}')

FILTER_ON class-attribute instance-attribute 

FILTER_ON = replace('smuX', f'smu{_cmd_syntax[3]}')

FILTER_REPEAT_AVG class-attribute instance-attribute 

FILTER_REPEAT_AVG = replace('smuX', f'smu{_cmd_syntax[3]}')

LIMIT_AUTO class-attribute instance-attribute 

LIMIT_AUTO = replace('smuX', f'smu{_cmd_syntax[3]}')

OE_NONE class-attribute instance-attribute 

OE_NONE = replace('smuX', f'smu{_cmd_syntax[3]}')

OE_OUTPUT_OFF class-attribute instance-attribute 

OE_OUTPUT_OFF = replace('smuX', f'smu{_cmd_syntax[3]}')

OUTPUT_DCAMPS class-attribute instance-attribute 

OUTPUT_DCAMPS = replace('smuX', f'smu{_cmd_syntax[3]}')

OUTPUT_DCVOLTS class-attribute instance-attribute 

OUTPUT_DCVOLTS = replace('smuX', f'smu{_cmd_syntax[3]}')

OUTPUT_HIGH_Z class-attribute instance-attribute 

OUTPUT_HIGH_Z = replace('smuX', f'smu{_cmd_syntax[3]}')

OUTPUT_NORMAL class-attribute instance-attribute 

OUTPUT_NORMAL = replace('smuX', f'smu{_cmd_syntax[3]}')

OUTPUT_OFF class-attribute instance-attribute 

OUTPUT_OFF = replace('smuX', f'smu{_cmd_syntax[3]}')

OUTPUT_ON class-attribute instance-attribute 

OUTPUT_ON = replace('smuX', f'smu{_cmd_syntax[3]}')

OUTPUT_ZERO class-attribute instance-attribute 

OUTPUT_ZERO = replace('smuX', f'smu{_cmd_syntax[3]}')

REL_OFF class-attribute instance-attribute 

REL_OFF = replace('smuX', f'smu{_cmd_syntax[3]}')

REL_ON class-attribute instance-attribute 

REL_ON = replace('smuX', f'smu{_cmd_syntax[3]}')

SENSE_CALA class-attribute instance-attribute 

SENSE_CALA = replace('smuX', f'smu{_cmd_syntax[3]}')

SENSE_LOCAL class-attribute instance-attribute 

SENSE_LOCAL = replace('smuX', f'smu{_cmd_syntax[3]}')

SENSE_REMOTE class-attribute instance-attribute 

SENSE_REMOTE = replace('smuX', f'smu{_cmd_syntax[3]}')

SETTLE_DIRECT_IRANGE class-attribute instance-attribute 

SETTLE_DIRECT_IRANGE = replace('smuX', f'smu{_cmd_syntax[3]}')

SETTLE_FAST_ALL class-attribute instance-attribute 

SETTLE_FAST_ALL = replace('smuX', f'smu{_cmd_syntax[3]}')

SETTLE_FAST_POLARITY class-attribute instance-attribute 

SETTLE_FAST_POLARITY = replace('smuX', f'smu{_cmd_syntax[3]}')

SETTLE_FAST_RANGE class-attribute instance-attribute 

SETTLE_FAST_RANGE = replace('smuX', f'smu{_cmd_syntax[3]}')

SETTLE_SMOOTH class-attribute instance-attribute 

SETTLE_SMOOTH = replace('smuX', f'smu{_cmd_syntax[3]}')

SOURCE_HOLD class-attribute instance-attribute 

SOURCE_HOLD = replace('smuX', f'smu{_cmd_syntax[3]}')

SOURCE_IDLE class-attribute instance-attribute 

SOURCE_IDLE = replace('smuX', f'smu{_cmd_syntax[3]}')

buffer property 

buffer: SmuxItemBuffer

Return the smuX.buffer command tree.

Sub-properties and sub-methods
  • .getstats(): The smuX.buffer.getstats() function.
  • .recalculatestats(): The smuX.buffer.recalculatestats() function.

cal property 

cal: SmuxItemCal

Return the smuX.cal command tree.

Sub-properties and sub-methods
  • .adjustdate: The smuX.cal.adjustdate attribute.
  • .date: The smuX.cal.date attribute.
  • .due: The smuX.cal.due attribute.
  • .fastadc(): The smuX.cal.fastadc() function.
  • .lock(): The smuX.cal.lock() function.
  • .password: The smuX.cal.password attribute.
  • .polarity: The smuX.cal.polarity attribute.
  • .restore(): The smuX.cal.restore() function.
  • .save(): The smuX.cal.save() function.
  • .state: The smuX.cal.state attribute.
  • .unlock(): The smuX.cal.unlock() function.

contact property 

contact: SmuxItemContact

Return the smuX.contact command tree.

Sub-properties and sub-methods
  • .calibratehi(): The smuX.contact.calibratehi() function.
  • .calibratelo(): The smuX.contact.calibratelo() function.
  • .check(): The smuX.contact.check() function.
  • .r(): The smuX.contact.r() function.
  • .speed: The smuX.contact.speed attribute.
  • .threshold: The smuX.contact.threshold attribute.

measure property 

measure: SmuxItemMeasure

Return the smuX.measure command tree.

Sub-properties and sub-methods
  • .i(): The smuX.measure.i() function.
  • .iv(): The smuX.measure.iv() function.
  • .p(): The smuX.measure.p() function.
  • .r(): The smuX.measure.r() function.
  • .v(): The smuX.measure.v() function.
  • .adc: The smuX.measure.adc attribute.
  • .autorangei: The smuX.measure.autorangei attribute.
  • .autorangev: The smuX.measure.autorangev attribute.
  • .autozero: The smuX.measure.autozero attribute.
  • .calibratei(): The smuX.measure.calibratei() function.
  • .calibratev(): The smuX.measure.calibratev() function.
  • .count: The smuX.measure.count attribute.
  • .delay: The smuX.measure.delay attribute.
  • .delayfactor: The smuX.measure.delayfactor attribute.
  • .filter: The smuX.measure.filter command tree.
  • .highcrangedelayfactor: The smuX.measure.highcrangedelayfactor attribute.
  • .interval: The smuX.measure.interval attribute.
  • .lowrangei: The smuX.measure.lowrangei attribute.
  • .lowrangev: The smuX.measure.lowrangev attribute.
  • .nplc: The smuX.measure.nplc attribute.
  • .overlappedi(): The smuX.measure.overlappedi() function.
  • .overlappediv(): The smuX.measure.overlappediv() function.
  • .overlappedp(): The smuX.measure.overlappedp() function.
  • .overlappedr(): The smuX.measure.overlappedr() function.
  • .overlappedv(): The smuX.measure.overlappedv() function.
  • .rangei: The smuX.measure.rangei attribute.
  • .rangev: The smuX.measure.rangev attribute.
  • .rel: The smuX.measure.rel command tree.

nvbuffer1 property 

nvbuffer1: str

Access the smuX.nvbuffer1 attribute.

Description
  • This attribute contains a dedicated reading buffer. (1 = default buffer1)
Usage
  • Accessing this property will send the print(smuX.nvbuffer1) query.
TSP Syntax 
- print(smuX.nvbuffer1)
Raises:

nvbuffer2 property 

nvbuffer2: str

Access the smuX.nvbuffer2 attribute.

Description
  • This attribute contains a dedicated reading buffer. (2 = default buffer2)
Usage
  • Accessing this property will send the print(smuX.nvbuffer2) query.
TSP Syntax 
- print(smuX.nvbuffer2)
Raises:

sense property writable 

sense: str

Access the smuX.sense attribute.

Description
  • This attribute contains the state of the sense mode.
Usage
  • Accessing this property will send the print(smuX.sense) query.
  • Setting this property to a value will send the smuX.sense = value command.
TSP Syntax 
- smuX.sense = value
- print(smuX.sense)
Raises:

source property 

source: SmuxItemSource

Return the smuX.source command tree.

Sub-properties and sub-methods
  • .autorangei: The smuX.source.autorangei attribute.
  • .autorangev: The smuX.source.autorangev attribute.
  • .calibratei(): The smuX.source.calibratei() function.
  • .calibratev(): The smuX.source.calibratev() function.
  • .compliance: The smuX.source.compliance attribute.
  • .delay: The smuX.source.delay attribute.
  • .func: The smuX.source.func attribute.
  • .highc: The smuX.source.highc attribute.
  • .leveli: The smuX.source.leveli attribute.
  • .levelv: The smuX.source.levelv attribute.
  • .limiti: The smuX.source.limiti attribute.
  • .limitp: The smuX.source.limitp attribute.
  • .limitv: The smuX.source.limitv attribute.
  • .lowrangei: The smuX.source.lowrangei attribute.
  • .lowrangev: The smuX.source.lowrangev attribute.
  • .offfunc: The smuX.source.offfunc attribute.
  • .offlimiti: The smuX.source.offlimiti attribute.
  • .offlimitv: The smuX.source.offlimitv attribute.
  • .offmode: The smuX.source.offmode attribute.
  • .output: The smuX.source.output attribute.
  • .outputenableaction: The smuX.source.outputenableaction attribute.
  • .rangei: The smuX.source.rangei attribute.
  • .rangev: The smuX.source.rangev attribute.
  • .settling: The smuX.source.settling attribute.
  • .sink: The smuX.source.sink attribute.

trigger property 

trigger: SmuxItemTrigger

Return the smuX.trigger command tree.

Constants
  • .ARMED_EVENT_ID: The number of the armed event.
  • .IDLE_EVENT_ID: The idle event number.
  • .MEASURE_COMPLETE_EVENT_ID: The measurement complete event number.
  • .PULSE_COMPLETE_EVENT_ID: The pulse complete event number.
  • .SOURCE_COMPLETE_EVENT_ID: The source complete event number.
  • .SWEEPING_EVENT_ID: The sweeping event number.
  • .SWEEP_COMPLETE_EVENT_ID: The sweep complete event number.
Sub-properties and sub-methods
  • .arm: The smuX.trigger.arm command tree.
  • .autoclear: The smuX.trigger.autoclear attribute.
  • .count: The smuX.trigger.count attribute.
  • .endpulse: The smuX.trigger.endpulse command tree.
  • .endsweep: The smuX.trigger.endsweep command tree.
  • .initiate(): The smuX.trigger.initiate() function.
  • .measure: The smuX.trigger.measure command tree.
  • .source: The smuX.trigger.source command tree.

abort 

abort() -> None

Run the smuX.abort() function.

Description
  • This function terminates all overlapped operations on the source-measure unit (SMU).
TSP Syntax 
- smuX.abort()
Raises:

makebuffer 

makebuffer(buffer_size: str, *, buffer_name: str | None = None) -> Buffervar

Run the smuX.makebuffer() function.

Description
  • This function creates a reading buffer.
TSP Syntax 
- smuX.makebuffer()
Parameters:
  • buffer_size (str) –

    Maximum number of readings that can be stored.

  • buffer_name (optional, default: None ) –

    The name of the buffer variable to create. If not provided, an auto-generated variable will be used.
Returns:
Raises:

measureiandstep 

measureiandstep(source_value: float) -> str

Run the smuX.measureiandstep() function.

Description
  • This function makes one or two measurements and then steps the source. (i = current in amperes)
TSP Syntax 
- smuX.measureiandstep()
Parameters:
  • source_value (float) –

    Source value to be set after the measurement is made.
Returns:
  • str –

    The result of the function call.
Raises:

measureivandstep 

measureivandstep(source_value: float) -> str

Run the smuX.measureivandstep() function.

Description
  • This function makes one or two measurements and then steps the source. (i = current in amperes, v = voltage in volts)
TSP Syntax 
- smuX.measureivandstep()
Parameters:
  • source_value (float) –

    Source value to be set after the measurement is made.
Returns:
  • str –

    The result of the function call.
Raises:

measurepandstep 

measurepandstep(source_value: float) -> str

Run the smuX.measurepandstep() function.

Description
  • This function makes one or two measurements and then steps the source. (p = power in watts)
TSP Syntax 
- smuX.measurepandstep()
Parameters:
  • source_value (float) –

    Source value to be set after the measurement is made.
Returns:
  • str –

    The result of the function call.
Raises:

measurerandstep 

measurerandstep(source_value: float) -> str

Run the smuX.measurerandstep() function.

Description
  • This function makes one or two measurements and then steps the source. (r = resistance in ohms)
TSP Syntax 
- smuX.measurerandstep()
Parameters:
  • source_value (float) –

    Source value to be set after the measurement is made.
Returns:
  • str –

    The result of the function call.
Raises:

measurevandstep 

measurevandstep(source_value: float) -> str

Run the smuX.measurevandstep() function.

Description
  • This function makes one or two measurements and then steps the source. (v = voltage in volts)
TSP Syntax 
- smuX.measurevandstep()
Parameters:
  • source_value (float) –

    Source value to be set after the measurement is made.
Returns:
  • str –

    The result of the function call.
Raises:

reset 

reset() -> None

Run the smuX.reset() function.

Description
  • This function turns off the output and resets the commands that begin with smua. to their default settings.
TSP Syntax 
- smuX.reset()
Raises:

savebuffer 

savebuffer(y: str) -> None

Run the smuX.savebuffer() function.

Description
  • This function saves one source-measure unit (SMU) dedicated reading buffer to nonvolatile memory.
TSP Syntax 
- smuX.savebuffer()
Parameters:
  • y (str) –

    SMU dedicated reading buffer (1 or 2).
Raises:

SmuxItemBuffer

Bases: BaseTSPCmd

The smuX.buffer command tree.

Properties and methods
  • .getstats(): The smuX.buffer.getstats() function.
  • .recalculatestats(): The smuX.buffer.recalculatestats() function.

getstats 

getstats(buffer_var: str) -> dict[Any, Any]

Run the smuX.buffer.getstats() function.

Description
  • This function returns the statistics for a specified reading buffer.
TSP Syntax 
- smuX.buffer.getstats()
Parameters:
  • buffer_var (str) –

    The reading buffer to process.
Returns:
  • dict[Any, Any] –

    The result of the function call.
Raises:

recalculatestats 

recalculatestats(buffer_var: str) -> None

Run the smuX.buffer.recalculatestats() function.

Description
  • This function recalculates the statistics of the specified reading buffer.
TSP Syntax 
- smuX.buffer.recalculatestats()
Parameters:
  • buffer_var (str) –

    The reading buffer to process.
Raises:

SmuxItemCal

Bases: BaseTSPCmd

The smuX.cal command tree.

Properties and methods
  • .adjustdate: The smuX.cal.adjustdate attribute.
  • .date: The smuX.cal.date attribute.
  • .due: The smuX.cal.due attribute.
  • .fastadc(): The smuX.cal.fastadc() function.
  • .lock(): The smuX.cal.lock() function.
  • .password: The smuX.cal.password attribute.
  • .polarity: The smuX.cal.polarity attribute.
  • .restore(): The smuX.cal.restore() function.
  • .save(): The smuX.cal.save() function.
  • .state: The smuX.cal.state attribute.
  • .unlock(): The smuX.cal.unlock() function.

adjustdate property writable 

adjustdate: str

Access the smuX.cal.adjustdate attribute.

Description
  • This attribute stores the date of the last calibration adjustment.
Usage
  • Accessing this property will send the print(smuX.cal.adjustdate) query.
  • Setting this property to a value will send the smuX.cal.adjustdate = value command.
TSP Syntax 
- smuX.cal.adjustdate = value
- print(smuX.cal.adjustdate)
Raises:

date property writable 

date: str

Access the smuX.cal.date attribute.

Description
  • This attribute stores the calibration date of the active calibration set.
Usage
  • Accessing this property will send the print(smuX.cal.date) query.
  • Setting this property to a value will send the smuX.cal.date = value command.
TSP Syntax 
- smuX.cal.date = value
- print(smuX.cal.date)
Raises:

due property writable 

due: str

Access the smuX.cal.due attribute.

Description
  • This attribute stores the calibration due date for the next calibration.
Usage
  • Accessing this property will send the print(smuX.cal.due) query.
  • Setting this property to a value will send the smuX.cal.due = value command.
TSP Syntax 
- smuX.cal.due = value
- print(smuX.cal.due)
Raises:

password property writable 

password: str

Access the smuX.cal.password attribute.

Description
  • This attribute stores the password required to enable calibration.
Usage
  • Setting this property to a value will send the smuX.cal.password = value command.
TSP Syntax 
- smuX.cal.password = value
Raises:

polarity property writable 

polarity: str

Access the smuX.cal.polarity attribute.

Description
  • This attribute controls which calibration constants are used for all subsequent measurements.
Usage
  • Accessing this property will send the print(smuX.cal.polarity) query.
  • Setting this property to a value will send the smuX.cal.polarity = value command.
TSP Syntax 
- smuX.cal.polarity = value
- print(smuX.cal.polarity)
Raises:

state property 

state: str

Access the smuX.cal.state attribute.

Description
  • This attribute returns the present calibration state.
Usage
  • Accessing this property will send the print(smuX.cal.state) query.
TSP Syntax 
- print(smuX.cal.state)
Raises:

fastadc 

fastadc() -> None

Run the smuX.cal.fastadc() function.

Description
  • This function performs calibration of the fast analog-to-digital converter (fast ADC).
TSP Syntax 
- smuX.cal.fastadc()
Raises:

lock 

lock() -> None

Run the smuX.cal.lock() function.

Description
  • This function disables the commands that change calibration settings.
TSP Syntax 
- smuX.cal.lock()
Raises:

restore 

restore(calset: str | None = None) -> None

Run the smuX.cal.restore() function.

Description
  • This function loads a stored set of calibration constants.
TSP Syntax 
- smuX.cal.restore()
Parameters:
  • calset (optional, default: None ) –

    The calibration set to be loaded; set calset to one of the following values.
Raises:

save 

save() -> None

Run the smuX.cal.save() function.

Description
  • This function stores the active calibration constants to nonvolatile memory.
TSP Syntax 
- smuX.cal.save()
Raises:

unlock 

unlock(password: str) -> None

Run the smuX.cal.unlock() function.

Description
  • This function enables the commands that change calibration settings.
TSP Syntax 
- smuX.cal.unlock()
Parameters:
  • password (str) –

    Calibration password.
Raises:

SmuxItemContact

Bases: BaseTSPCmd

The smuX.contact command tree.

Properties and methods
  • .calibratehi(): The smuX.contact.calibratehi() function.
  • .calibratelo(): The smuX.contact.calibratelo() function.
  • .check(): The smuX.contact.check() function.
  • .r(): The smuX.contact.r() function.
  • .speed: The smuX.contact.speed attribute.
  • .threshold: The smuX.contact.threshold attribute.

speed property writable 

speed: str

Access the smuX.contact.speed attribute.

Description
  • This attribute stores the speed setting for contact check measurements.
Usage
  • Accessing this property will send the print(smuX.contact.speed) query.
  • Setting this property to a value will send the smuX.contact.speed = value command.
TSP Syntax 
- smuX.contact.speed = value
- print(smuX.contact.speed)
Raises:

threshold property writable 

threshold: str

Access the smuX.contact.threshold attribute.

Description
  • This attribute stores the resistance threshold for the smua.contact.check() function.
Usage
  • Accessing this property will send the print(smuX.contact.threshold) query.
  • Setting this property to a value will send the smuX.contact.threshold = value command.
TSP Syntax 
- smuX.contact.threshold = value
- print(smuX.contact.threshold)
Raises:

calibratehi 

calibratehi(cp1_measured: str, cp1_reference: str, cp2_measured: str, cp2_reference: str) -> None

Run the smuX.contact.calibratehi() function.

Description
  • This function adjusts the high/sense high contact check measurement.
TSP Syntax 
- smuX.contact.calibratehi()
Parameters:
  • cp1_measured (str) –

    The value measured by this SMU for point 1.

  • cp1_reference (str) –

    The reference measurement for point 1 as measured externally.

  • cp2_measured (str) –

    The value measured by this SMU for point 2.

  • cp2_reference (str) –

    The reference measurement for point 2 as measured externally.
Raises:

calibratelo 

calibratelo(cp1_measured: str, cp1_reference: str, cp2_measured: str, cp2_reference: str) -> None

Run the smuX.contact.calibratelo() function.

Description
  • This function adjusts the low/sense low contact check measurement.
TSP Syntax 
- smuX.contact.calibratelo()
Parameters:
  • cp1_measured (str) –

    The value measured by this SMU for point 1.

  • cp1_reference (str) –

    The reference measurement for point 1 as measured externally.

  • cp2_measured (str) –

    The value measured by this SMU for point 2.

  • cp2_reference (str) –

    The reference measurement for point 2 as measured externally.
Raises:

check 

check() -> None

Run the smuX.contact.check() function.

Description
  • This function determines if contact resistance is lower than the threshold.
TSP Syntax 
- smuX.contact.check()
Raises:

r 

r() -> str

Run the smuX.contact.r() function.

Description
  • This function measures aggregate contact resistance.
TSP Syntax 
- smuX.contact.r()
Returns:
  • str –

    The result of the function call.
Raises:

SmuxItemMeasure

Bases: BaseTSPCmd

The smuX.measure command tree.

Properties and methods
  • .i(): The smuX.measure.i() function.
  • .iv(): The smuX.measure.iv() function.
  • .p(): The smuX.measure.p() function.
  • .r(): The smuX.measure.r() function.
  • .v(): The smuX.measure.v() function.
  • .adc: The smuX.measure.adc attribute.
  • .autorangei: The smuX.measure.autorangei attribute.
  • .autorangev: The smuX.measure.autorangev attribute.
  • .autozero: The smuX.measure.autozero attribute.
  • .calibratei(): The smuX.measure.calibratei() function.
  • .calibratev(): The smuX.measure.calibratev() function.
  • .count: The smuX.measure.count attribute.
  • .delay: The smuX.measure.delay attribute.
  • .delayfactor: The smuX.measure.delayfactor attribute.
  • .filter: The smuX.measure.filter command tree.
  • .highcrangedelayfactor: The smuX.measure.highcrangedelayfactor attribute.
  • .interval: The smuX.measure.interval attribute.
  • .lowrangei: The smuX.measure.lowrangei attribute.
  • .lowrangev: The smuX.measure.lowrangev attribute.
  • .nplc: The smuX.measure.nplc attribute.
  • .overlappedi(): The smuX.measure.overlappedi() function.
  • .overlappediv(): The smuX.measure.overlappediv() function.
  • .overlappedp(): The smuX.measure.overlappedp() function.
  • .overlappedr(): The smuX.measure.overlappedr() function.
  • .overlappedv(): The smuX.measure.overlappedv() function.
  • .rangei: The smuX.measure.rangei attribute.
  • .rangev: The smuX.measure.rangev attribute.
  • .rel: The smuX.measure.rel command tree.

adc property writable 

adc: str

Access the smuX.measure.adc attribute.

Description
  • This attribute contains the analog-to-digital converter selection.
Usage
  • Accessing this property will send the print(smuX.measure.adc) query.
  • Setting this property to a value will send the smuX.measure.adc = value command.
TSP Syntax 
- smuX.measure.adc = value
- print(smuX.measure.adc)
Info
  • X, the source-measure unit (SMU) channel (for example, smua.measure.adc applies to SMU channel A).
Raises:

autorangei property writable 

autorangei: str

Access the smuX.measure.autorangei attribute.

Description
  • This attribute stores the measurement autorange setting. (i = current in amperes)
Usage
  • Accessing this property will send the print(smuX.measure.autorangei) query.
  • Setting this property to a value will send the smuX.measure.autorangei = value command.
TSP Syntax 
- smuX.measure.autorangei = value
- print(smuX.measure.autorangei)
Raises:

autorangev property writable 

autorangev: str

Access the smuX.measure.autorangev attribute.

Description
  • This attribute stores the measurement autorange setting. (v = voltage in volts)
Usage
  • Accessing this property will send the print(smuX.measure.autorangev) query.
  • Setting this property to a value will send the smuX.measure.autorangev = value command.
TSP Syntax 
- smuX.measure.autorangev = value
- print(smuX.measure.autorangev)
Raises:

autozero property writable 

autozero: str

Access the smuX.measure.autozero attribute.

Description
  • This attribute enables or disables automatic updates to the internal reference measurements (autozero) of the instrument.
Usage
  • Accessing this property will send the print(smuX.measure.autozero) query.
  • Setting this property to a value will send the smuX.measure.autozero = value command.
TSP Syntax 
- smuX.measure.autozero = value
- print(smuX.measure.autozero)
Raises:

count property writable 

count: str

Access the smuX.measure.count attribute.

Description
  • This attribute sets the number of measurements made when a measurement is requested.
Usage
  • Accessing this property will send the print(smuX.measure.count) query.
  • Setting this property to a value will send the smuX.measure.count = value command.
TSP Syntax 
- smuX.measure.count = value
- print(smuX.measure.count)
Raises:

delay property writable 

delay: str

Access the smuX.measure.delay attribute.

Description
  • This attribute controls the measurement delay.
Usage
  • Accessing this property will send the print(smuX.measure.delay) query.
  • Setting this property to a value will send the smuX.measure.delay = value command.
TSP Syntax 
- smuX.measure.delay = value
- print(smuX.measure.delay)
Raises:

delayfactor property writable 

delayfactor: str

Access the smuX.measure.delayfactor attribute.

Description
  • This attribute stores a multiplier to the delays that are used when smua.measure.delay is set to smua.DELAY_AUTO.
Usage
  • Accessing this property will send the print(smuX.measure.delayfactor) query.
  • Setting this property to a value will send the smuX.measure.delayfactor = value command.
TSP Syntax 
- smuX.measure.delayfactor = value
- print(smuX.measure.delayfactor)
Raises:

filter property 

filter: SmuxItemMeasureFilter

Return the smuX.measure.filter command tree.

Sub-properties and sub-methods
  • .count: The smuX.measure.filter.count attribute.
  • .enable: The smuX.measure.filter.enable attribute.
  • .type: The smuX.measure.filter.type attribute.

highcrangedelayfactor property writable 

highcrangedelayfactor: str

Access the smuX.measure.highcrangedelayfactor attribute.

Description
  • This attribute contains a delay multiplier that is only used during range changes when the high-capacitance mode is active.
Usage
  • Accessing this property will send the print(smuX.measure.highcrangedelayfactor) query.
  • Setting this property to a value will send the smuX.measure.highcrangedelayfactor = value command.
TSP Syntax 
- smuX.measure.highcrangedelayfactor = value
- print(smuX.measure.highcrangedelayfactor)
Raises:

interval property writable 

interval: str

Access the smuX.measure.interval attribute.

Description
  • This attribute sets the interval between multiple measurements.
Usage
  • Accessing this property will send the print(smuX.measure.interval) query.
  • Setting this property to a value will send the smuX.measure.interval = value command.
TSP Syntax 
- smuX.measure.interval = value
- print(smuX.measure.interval)
Raises:

lowrangei property writable 

lowrangei: str

Access the smuX.measure.lowrangei attribute.

Description
  • This attribute sets the lowest measurement range that is used when the instrument is autoranging. (i = current in amperes)
Usage
  • Accessing this property will send the print(smuX.measure.lowrangei) query.
  • Setting this property to a value will send the smuX.measure.lowrangei = value command.
TSP Syntax 
- smuX.measure.lowrangei = value
- print(smuX.measure.lowrangei)
Raises:

lowrangev property writable 

lowrangev: str

Access the smuX.measure.lowrangev attribute.

Description
  • This attribute sets the lowest measurement range that is used when the instrument is autoranging. (v = voltage in volts)
Usage
  • Accessing this property will send the print(smuX.measure.lowrangev) query.
  • Setting this property to a value will send the smuX.measure.lowrangev = value command.
TSP Syntax 
- smuX.measure.lowrangev = value
- print(smuX.measure.lowrangev)
Raises:

nplc property writable 

nplc: str

Access the smuX.measure.nplc attribute.

Description
  • This command sets the integration aperture for measurements.
Usage
  • Accessing this property will send the print(smuX.measure.nplc) query.
  • Setting this property to a value will send the smuX.measure.nplc = value command.
TSP Syntax 
- smuX.measure.nplc = value
- print(smuX.measure.nplc)
Raises:

rangei property writable 

rangei: str

Access the smuX.measure.rangei attribute.

Description
  • This attribute contains the positive full-scale value of the measurement range for voltage or current. (i = current in amperes)
Usage
  • Accessing this property will send the print(smuX.measure.rangei) query.
  • Setting this property to a value will send the smuX.measure.rangei = value command.
TSP Syntax 
- smuX.measure.rangei = value
- print(smuX.measure.rangei)
Raises:

rangev property writable 

rangev: str

Access the smuX.measure.rangev attribute.

Description
  • This attribute contains the positive full-scale value of the measurement range for voltage or current. (v = voltage in volts)
Usage
  • Accessing this property will send the print(smuX.measure.rangev) query.
  • Setting this property to a value will send the smuX.measure.rangev = value command.
TSP Syntax 
- smuX.measure.rangev = value
- print(smuX.measure.rangev)
Raises:

rel property 

rel: SmuxItemMeasureRel

Return the smuX.measure.rel command tree.

Sub-properties and sub-methods
  • .enablei: The smuX.measure.rel.enablei attribute.
  • .enablep: The smuX.measure.rel.enablep attribute.
  • .enabler: The smuX.measure.rel.enabler attribute.
  • .enablev: The smuX.measure.rel.enablev attribute.
  • .leveli: The smuX.measure.rel.leveli attribute.
  • .levelp: The smuX.measure.rel.levelp attribute.
  • .levelr: The smuX.measure.rel.levelr attribute.
  • .levelv: The smuX.measure.rel.levelv attribute.

calibratei 

calibratei(
    range_: str, cp1_measured: str, cp1_reference: str, cp2_measured: str, cp2_reference: str
) -> None

Run the smuX.measure.calibratei() function.

Description
  • This function generates and activates new measurement calibration constants. (i = current in amperes)
TSP Syntax 
- smuX.measure.calibratei()
Parameters:
  • range_ (str) –

    The measurement range to adjust.

  • cp1_measured (str) –

    The value measured by this SMU for point 1.

  • cp1_reference (str) –

    The reference measurement for point 1 as measured externally.

  • cp2_measured (str) –

    The value measured by this SMU for point 2.

  • cp2_reference (str) –

    The reference measurement for point 2 as measured externally.
Raises:

calibratev 

calibratev(
    range_: str, cp1_measured: str, cp1_reference: str, cp2_measured: str, cp2_reference: str
) -> None

Run the smuX.measure.calibratev() function.

Description
  • This function generates and activates new measurement calibration constants. (v = voltage in volts)
TSP Syntax 
- smuX.measure.calibratev()
Parameters:
  • range_ (str) –

    The measurement range to adjust.

  • cp1_measured (str) –

    The value measured by this SMU for point 1.

  • cp1_reference (str) –

    The reference measurement for point 1 as measured externally.

  • cp2_measured (str) –

    The value measured by this SMU for point 2.

  • cp2_reference (str) –

    The reference measurement for point 2 as measured externally.
Raises:

i 

i(reading_buffer: str | None = None) -> str

Run the smuX.measure.i() function.

Description
  • This function makes one or more measurements. (i = current in amperes)
TSP Syntax 
- smuX.measure.i()
Parameters:
  • reading_buffer (optional, default: None ) –

    A reading buffer object where all readings are stored.
Returns:
  • str –

    The result of the function call.
Raises:

iv 

iv(i_reading_buffer: str | None = None, v_reading_buffer: str | None = None) -> str

Run the smuX.measure.iv() function.

Description
  • This function makes one or more measurements. (i = current in amperes, v = voltage in volts)
TSP Syntax 
- smuX.measure.iv()
Parameters:
  • i_reading_buffer (optional, default: None ) –

    A reading buffer object where current readings are stored.

  • v_reading_buffer (optional, default: None ) –

    A reading buffer object where voltage readings are stored.
Returns:
  • str –

    The result of the function call.
Raises:

overlappedi 

overlappedi(rbuffer: str) -> None

Run the smuX.measure.overlappedi() function.

Description
  • This function starts an asynchronous (background) measurement. (i = current in amperes)
TSP Syntax 
- smuX.measure.overlappedi()
Parameters:
  • rbuffer (str) –

    A reading buffer object where the readings are stored.
Raises:

overlappediv 

overlappediv(ibuffer: str, vbuffer: str) -> None

Run the smuX.measure.overlappediv() function.

Description
  • This function starts an asynchronous (background) measurement. (i = current in amperes, v = voltage in volts)
TSP Syntax 
- smuX.measure.overlappediv()
Parameters:
  • ibuffer (str) –

    A reading buffer object where current readings are stored.

  • vbuffer (str) –

    A reading buffer object where voltage readings are stored.
Raises:

overlappedp 

overlappedp(rbuffer: str) -> None

Run the smuX.measure.overlappedp() function.

Description
  • This function starts an asynchronous (background) measurement. (p = power in watts)
TSP Syntax 
- smuX.measure.overlappedp()
Parameters:
  • rbuffer (str) –

    A reading buffer object where the readings are stored.
Raises:

overlappedr 

overlappedr(rbuffer: str) -> None

Run the smuX.measure.overlappedr() function.

Description
  • This function starts an asynchronous (background) measurement. (r = resistance in ohms)
TSP Syntax 
- smuX.measure.overlappedr()
Parameters:
  • rbuffer (str) –

    A reading buffer object where the readings are stored.
Raises:

overlappedv 

overlappedv(rbuffer: str) -> None

Run the smuX.measure.overlappedv() function.

Description
  • This function starts an asynchronous (background) measurement. (v = voltage in volts)
TSP Syntax 
- smuX.measure.overlappedv()
Parameters:
  • rbuffer (str) –

    A reading buffer object where the readings are stored.
Raises:

p 

p(reading_buffer: str | None = None) -> str

Run the smuX.measure.p() function.

Description
  • This function makes one or more measurements. (p = power in watts)
TSP Syntax 
- smuX.measure.p()
Parameters:
  • reading_buffer (optional, default: None ) –

    A reading buffer object where all readings are stored.
Returns:
  • str –

    The result of the function call.
Raises:

r 

r(reading_buffer: str | None = None) -> str

Run the smuX.measure.r() function.

Description
  • This function makes one or more measurements. (r = resistance in ohms)
TSP Syntax 
- smuX.measure.r()
Parameters:
  • reading_buffer (optional, default: None ) –

    A reading buffer object where all readings are stored.
Returns:
  • str –

    The result of the function call.
Raises:

v 

v(reading_buffer: str | None = None) -> str

Run the smuX.measure.v() function.

Description
  • This function makes one or more measurements. (v = voltage in volts)
TSP Syntax 
- smuX.measure.v()
Parameters:
  • reading_buffer (optional, default: None ) –

    A reading buffer object where all readings are stored.
Returns:
  • str –

    The result of the function call.
Raises:

SmuxItemMeasureFilter

Bases: BaseTSPCmd

The smuX.measure.filter command tree.

Properties and methods
  • .count: The smuX.measure.filter.count attribute.
  • .enable: The smuX.measure.filter.enable attribute.
  • .type: The smuX.measure.filter.type attribute.

count property writable 

count: str

Access the smuX.measure.filter.count attribute.

Description
  • This command sets the number of measured readings that are required to yield one filtered measurement.
Usage
  • Accessing this property will send the print(smuX.measure.filter.count) query.
  • Setting this property to a value will send the smuX.measure.filter.count = value command.
TSP Syntax 
- smuX.measure.filter.count = value
- print(smuX.measure.filter.count)
Raises:

enable property writable 

enable: str

Access the smuX.measure.filter.enable attribute.

Description
  • This command enables or disables filtered measurements.
Usage
  • Accessing this property will send the print(smuX.measure.filter.enable) query.
  • Setting this property to a value will send the smuX.measure.filter.enable = value command.
TSP Syntax 
- smuX.measure.filter.enable = value
- print(smuX.measure.filter.enable)
Raises:

type property writable 

type: str

Access the smuX.measure.filter.type attribute.

Description
  • This command sets the type of filter used for measurements when the measurement filter is enabled.
Usage
  • Accessing this property will send the print(smuX.measure.filter.type) query.
  • Setting this property to a value will send the smuX.measure.filter.type = value command.
TSP Syntax 
- smuX.measure.filter.type = value
- print(smuX.measure.filter.type)
Raises:

SmuxItemMeasureRel

Bases: BaseTSPCmd

The smuX.measure.rel command tree.

Properties and methods
  • .enablei: The smuX.measure.rel.enablei attribute.
  • .enablep: The smuX.measure.rel.enablep attribute.
  • .enabler: The smuX.measure.rel.enabler attribute.
  • .enablev: The smuX.measure.rel.enablev attribute.
  • .leveli: The smuX.measure.rel.leveli attribute.
  • .levelp: The smuX.measure.rel.levelp attribute.
  • .levelr: The smuX.measure.rel.levelr attribute.
  • .levelv: The smuX.measure.rel.levelv attribute.

enablei property writable 

enablei: str

Access the smuX.measure.rel.enablei attribute.

Description
  • This attribute turns relative measurements on or off. (i = current in amperes)
Usage
  • Accessing this property will send the print(smuX.measure.rel.enablei) query.
  • Setting this property to a value will send the smuX.measure.rel.enablei = value command.
TSP Syntax 
- smuX.measure.rel.enablei = value
- print(smuX.measure.rel.enablei)
Raises:

enablep property writable 

enablep: str

Access the smuX.measure.rel.enablep attribute.

Description
  • This attribute turns relative measurements on or off. (p = power in watts)
Usage
  • Accessing this property will send the print(smuX.measure.rel.enablep) query.
  • Setting this property to a value will send the smuX.measure.rel.enablep = value command.
TSP Syntax 
- smuX.measure.rel.enablep = value
- print(smuX.measure.rel.enablep)
Raises:

enabler property writable 

enabler: str

Access the smuX.measure.rel.enabler attribute.

Description
  • This attribute turns relative measurements on or off. (r = resistance in ohms)
Usage
  • Accessing this property will send the print(smuX.measure.rel.enabler) query.
  • Setting this property to a value will send the smuX.measure.rel.enabler = value command.
TSP Syntax 
- smuX.measure.rel.enabler = value
- print(smuX.measure.rel.enabler)
Raises:

enablev property writable 

enablev: str

Access the smuX.measure.rel.enablev attribute.

Description
  • This attribute turns relative measurements on or off. (v = voltage in volts)
Usage
  • Accessing this property will send the print(smuX.measure.rel.enablev) query.
  • Setting this property to a value will send the smuX.measure.rel.enablev = value command.
TSP Syntax 
- smuX.measure.rel.enablev = value
- print(smuX.measure.rel.enablev)
Raises:

leveli property writable 

leveli: str

Access the smuX.measure.rel.leveli attribute.

Description
  • This attribute sets the offset value for relative measurements. (i = current in amperes)
Usage
  • Accessing this property will send the print(smuX.measure.rel.leveli) query.
  • Setting this property to a value will send the smuX.measure.rel.leveli = value command.
TSP Syntax 
- smuX.measure.rel.leveli = value
- print(smuX.measure.rel.leveli)
Raises:

levelp property writable 

levelp: str

Access the smuX.measure.rel.levelp attribute.

Description
  • This attribute sets the offset value for relative measurements. (p = power in watts)
Usage
  • Accessing this property will send the print(smuX.measure.rel.levelp) query.
  • Setting this property to a value will send the smuX.measure.rel.levelp = value command.
TSP Syntax 
- smuX.measure.rel.levelp = value
- print(smuX.measure.rel.levelp)
Raises:

levelr property writable 

levelr: str

Access the smuX.measure.rel.levelr attribute.

Description
  • This attribute sets the offset value for relative measurements. (r = resistance in ohms)
Usage
  • Accessing this property will send the print(smuX.measure.rel.levelr) query.
  • Setting this property to a value will send the smuX.measure.rel.levelr = value command.
TSP Syntax 
- smuX.measure.rel.levelr = value
- print(smuX.measure.rel.levelr)
Raises:

levelv property writable 

levelv: str

Access the smuX.measure.rel.levelv attribute.

Description
  • This attribute sets the offset value for relative measurements. (v = voltage in volts)
Usage
  • Accessing this property will send the print(smuX.measure.rel.levelv) query.
  • Setting this property to a value will send the smuX.measure.rel.levelv = value command.
TSP Syntax 
- smuX.measure.rel.levelv = value
- print(smuX.measure.rel.levelv)
Raises:

SmuxItemSource

Bases: BaseTSPCmd

The smuX.source command tree.

Properties and methods
  • .autorangei: The smuX.source.autorangei attribute.
  • .autorangev: The smuX.source.autorangev attribute.
  • .calibratei(): The smuX.source.calibratei() function.
  • .calibratev(): The smuX.source.calibratev() function.
  • .compliance: The smuX.source.compliance attribute.
  • .delay: The smuX.source.delay attribute.
  • .func: The smuX.source.func attribute.
  • .highc: The smuX.source.highc attribute.
  • .leveli: The smuX.source.leveli attribute.
  • .levelv: The smuX.source.levelv attribute.
  • .limiti: The smuX.source.limiti attribute.
  • .limitp: The smuX.source.limitp attribute.
  • .limitv: The smuX.source.limitv attribute.
  • .lowrangei: The smuX.source.lowrangei attribute.
  • .lowrangev: The smuX.source.lowrangev attribute.
  • .offfunc: The smuX.source.offfunc attribute.
  • .offlimiti: The smuX.source.offlimiti attribute.
  • .offlimitv: The smuX.source.offlimitv attribute.
  • .offmode: The smuX.source.offmode attribute.
  • .output: The smuX.source.output attribute.
  • .outputenableaction: The smuX.source.outputenableaction attribute.
  • .rangei: The smuX.source.rangei attribute.
  • .rangev: The smuX.source.rangev attribute.
  • .settling: The smuX.source.settling attribute.
  • .sink: The smuX.source.sink attribute.

autorangei property writable 

autorangei: str

Access the smuX.source.autorangei attribute.

Description
  • This attribute contains the state of the source autorange control (on/off). (i = current in amperes)
Usage
  • Accessing this property will send the print(smuX.source.autorangei) query.
  • Setting this property to a value will send the smuX.source.autorangei = value command.
TSP Syntax 
- smuX.source.autorangei = value
- print(smuX.source.autorangei)
Raises:

autorangev property writable 

autorangev: str

Access the smuX.source.autorangev attribute.

Description
  • This attribute contains the state of the source autorange control (on/off). (v = voltage in volts)
Usage
  • Accessing this property will send the print(smuX.source.autorangev) query.
  • Setting this property to a value will send the smuX.source.autorangev = value command.
TSP Syntax 
- smuX.source.autorangev = value
- print(smuX.source.autorangev)
Raises:

compliance property 

compliance: str

Access the smuX.source.compliance attribute.

Description
  • This attribute contains the state of source compliance.
Usage
  • Accessing this property will send the print(smuX.source.compliance) query.
TSP Syntax 
- print(smuX.source.compliance)
Raises:

delay property writable 

delay: str

Access the smuX.source.delay attribute.

Description
  • This attribute contains the source delay.
Usage
  • Accessing this property will send the print(smuX.source.delay) query.
  • Setting this property to a value will send the smuX.source.delay = value command.
TSP Syntax 
- smuX.source.delay = value
- print(smuX.source.delay)
Raises:

func property writable 

func: str

Access the smuX.source.func attribute.

Description
  • This attribute contains the source function, which can be voltage or current.
Usage
  • Accessing this property will send the print(smuX.source.func) query.
  • Setting this property to a value will send the smuX.source.func = value command.
TSP Syntax 
- smuX.source.func = value
- print(smuX.source.func)
Raises:

highc property writable 

highc: str

Access the smuX.source.highc attribute.

Description
  • This attribute enables or disables high-capacitance mode.
Usage
  • Accessing this property will send the print(smuX.source.highc) query.
  • Setting this property to a value will send the smuX.source.highc = value command.
TSP Syntax 
- smuX.source.highc = value
- print(smuX.source.highc)
Raises:

leveli property writable 

leveli: str

Access the smuX.source.leveli attribute.

Description
  • This attribute sets the source level. (i = current in amperes)
Usage
  • Accessing this property will send the print(smuX.source.leveli) query.
  • Setting this property to a value will send the smuX.source.leveli = value command.
TSP Syntax 
- smuX.source.leveli = value
- print(smuX.source.leveli)
Raises:

levelv property writable 

levelv: str

Access the smuX.source.levelv attribute.

Description
  • This attribute sets the source level. (v = voltage in volts)
Usage
  • Accessing this property will send the print(smuX.source.levelv) query.
  • Setting this property to a value will send the smuX.source.levelv = value command.
TSP Syntax 
- smuX.source.levelv = value
- print(smuX.source.levelv)
Raises:

limiti property writable 

limiti: str

Access the smuX.source.limiti attribute.

Description
  • This attribute sets compliance limits. (i = current in amperes)
Usage
  • Accessing this property will send the print(smuX.source.limiti) query.
  • Setting this property to a value will send the smuX.source.limiti = value command.
TSP Syntax 
- smuX.source.limiti = value
- print(smuX.source.limiti)
Raises:

limitp property writable 

limitp: str

Access the smuX.source.limitp attribute.

Description
  • This attribute sets compliance limits. (p = power in watts)
Usage
  • Accessing this property will send the print(smuX.source.limitp) query.
  • Setting this property to a value will send the smuX.source.limitp = value command.
TSP Syntax 
- smuX.source.limitp = value
- print(smuX.source.limitp)
Raises:

limitv property writable 

limitv: str

Access the smuX.source.limitv attribute.

Description
  • This attribute sets compliance limits. (v = voltage in volts)
Usage
  • Accessing this property will send the print(smuX.source.limitv) query.
  • Setting this property to a value will send the smuX.source.limitv = value command.
TSP Syntax 
- smuX.source.limitv = value
- print(smuX.source.limitv)
Raises:

lowrangei property writable 

lowrangei: str

Access the smuX.source.lowrangei attribute.

Description
  • This attribute sets the lowest source range that is used during autoranging. (i = current in amperes)
Usage
  • Accessing this property will send the print(smuX.source.lowrangei) query.
  • Setting this property to a value will send the smuX.source.lowrangei = value command.
TSP Syntax 
- smuX.source.lowrangei = value
- print(smuX.source.lowrangei)
Raises:

lowrangev property writable 

lowrangev: str

Access the smuX.source.lowrangev attribute.

Description
  • This attribute sets the lowest source range that is used during autoranging. (v = voltage in volts)
Usage
  • Accessing this property will send the print(smuX.source.lowrangev) query.
  • Setting this property to a value will send the smuX.source.lowrangev = value command.
TSP Syntax 
- smuX.source.lowrangev = value
- print(smuX.source.lowrangev)
Raises:

offfunc property writable 

offfunc: str

Access the smuX.source.offfunc attribute.

Description
  • This attribute sets the source function that is used (source 0 A or 0 V) when the output is turned off and the source-measure unit (SMU) is in normal output-off mode.
Usage
  • Accessing this property will send the print(smuX.source.offfunc) query.
  • Setting this property to a value will send the smuX.source.offfunc = value command.
TSP Syntax 
- smuX.source.offfunc = value
- print(smuX.source.offfunc)
Raises:

offlimiti property writable 

offlimiti: str

Access the smuX.source.offlimiti attribute.

Description
  • This attribute sets the limit (current or voltage) used when the source-measure unit (SMU) is in normal output-off mode. (i = current in amperes)
Usage
  • Accessing this property will send the print(smuX.source.offlimiti) query.
  • Setting this property to a value will send the smuX.source.offlimiti = value command.
TSP Syntax 
- smuX.source.offlimiti = value
- print(smuX.source.offlimiti)
Raises:

offlimitv property writable 

offlimitv: str

Access the smuX.source.offlimitv attribute.

Description
  • This attribute sets the limit (current or voltage) used when the source-measure unit (SMU) is in normal output-off mode. (v = voltage in volts)
Usage
  • Accessing this property will send the print(smuX.source.offlimitv) query.
  • Setting this property to a value will send the smuX.source.offlimitv = value command.
TSP Syntax 
- smuX.source.offlimitv = value
- print(smuX.source.offlimitv)
Raises:

offmode property writable 

offmode: str

Access the smuX.source.offmode attribute.

Description
  • This attribute sets the source output-off mode.
Usage
  • Accessing this property will send the print(smuX.source.offmode) query.
  • Setting this property to a value will send the smuX.source.offmode = value command.
TSP Syntax 
- smuX.source.offmode = value
- print(smuX.source.offmode)
Raises:

output property writable 

output: str

Access the smuX.source.output attribute.

Description
  • This attribute enables or disables the source output.
Usage
  • Accessing this property will send the print(smuX.source.output) query.
  • Setting this property to a value will send the smuX.source.output = value command.
TSP Syntax 
- smuX.source.output = value
- print(smuX.source.output)
Raises:

outputenableaction property writable 

outputenableaction: str

Access the smuX.source.outputenableaction attribute.

Description
  • This attribute controls output enable action of the source.
Usage
  • Accessing this property will send the print(smuX.source.outputenableaction) query.
  • Setting this property to a value will send the smuX.source.outputenableaction = value command.
TSP Syntax 
- smuX.source.outputenableaction = value
- print(smuX.source.outputenableaction)
Raises:

rangei property writable 

rangei: str

Access the smuX.source.rangei attribute.

Description
  • This attribute contains the source range. (i = current in amperes)
Usage
  • Accessing this property will send the print(smuX.source.rangei) query.
  • Setting this property to a value will send the smuX.source.rangei = value command.
TSP Syntax 
- smuX.source.rangei = value
- print(smuX.source.rangei)
Raises:

rangev property writable 

rangev: str

Access the smuX.source.rangev attribute.

Description
  • This attribute contains the source range. (v = voltage in volts)
Usage
  • Accessing this property will send the print(smuX.source.rangev) query.
  • Setting this property to a value will send the smuX.source.rangev = value command.
TSP Syntax 
- smuX.source.rangev = value
- print(smuX.source.rangev)
Raises:

settling property writable 

settling: str

Access the smuX.source.settling attribute.

Description
  • This attribute contains the source settling mode.
Usage
  • Accessing this property will send the print(smuX.source.settling) query.
  • Setting this property to a value will send the smuX.source.settling = value command.
TSP Syntax 
- smuX.source.settling = value
- print(smuX.source.settling)
Raises:

sink property writable 

sink: str

Access the smuX.source.sink attribute.

Description
  • This attribute turns sink mode on or off.
Usage
  • Accessing this property will send the print(smuX.source.sink) query.
  • Setting this property to a value will send the smuX.source.sink = value command.
TSP Syntax 
- smuX.source.sink = value
- print(smuX.source.sink)
Raises:

calibratei 

calibratei(
    range_: str, cp1_expected: str, cp1_reference: str, cp2_expected: str, cp2_reference: str
) -> None

Run the smuX.source.calibratei() function.

Description
  • This function generates and activates new source calibration constants. (i = current in amperes)
TSP Syntax 
- smuX.source.calibratei()
Parameters:
  • range_ (str) –

    The measurement range to adjust.

  • cp1_expected (str) –

    The source value set for point 1.

  • cp1_reference (str) –

    The reference measurement for point 1 as measured externally.

  • cp2_expected (str) –

    The source value set for point 2.

  • cp2_reference (str) –

    The reference measurement for point 2 as measured externally.
Raises:

calibratev 

calibratev(
    range_: str, cp1_expected: str, cp1_reference: str, cp2_expected: str, cp2_reference: str
) -> None

Run the smuX.source.calibratev() function.

Description
  • This function generates and activates new source calibration constants. (v = voltage in volts)
TSP Syntax 
- smuX.source.calibratev()
Parameters:
  • range_ (str) –

    The measurement range to adjust.

  • cp1_expected (str) –

    The source value set for point 1.

  • cp1_reference (str) –

    The reference measurement for point 1 as measured externally.

  • cp2_expected (str) –

    The source value set for point 2.

  • cp2_reference (str) –

    The reference measurement for point 2 as measured externally.
Raises:

SmuxItemTrigger

Bases: BaseTSPCmd

The smuX.trigger command tree.

Constants
  • .ARMED_EVENT_ID: The number of the armed event.
  • .IDLE_EVENT_ID: The idle event number.
  • .MEASURE_COMPLETE_EVENT_ID: The measurement complete event number.
  • .PULSE_COMPLETE_EVENT_ID: The pulse complete event number.
  • .SOURCE_COMPLETE_EVENT_ID: The source complete event number.
  • .SWEEPING_EVENT_ID: The sweeping event number.
  • .SWEEP_COMPLETE_EVENT_ID: The sweep complete event number.
Properties and methods
  • .arm: The smuX.trigger.arm command tree.
  • .autoclear: The smuX.trigger.autoclear attribute.
  • .count: The smuX.trigger.count attribute.
  • .endpulse: The smuX.trigger.endpulse command tree.
  • .endsweep: The smuX.trigger.endsweep command tree.
  • .initiate(): The smuX.trigger.initiate() function.
  • .measure: The smuX.trigger.measure command tree.
  • .source: The smuX.trigger.source command tree.

ARMED_EVENT_ID class-attribute instance-attribute 

ARMED_EVENT_ID = replace('smuX', f'smu{_cmd_syntax[3]}')

IDLE_EVENT_ID class-attribute instance-attribute 

IDLE_EVENT_ID = replace('smuX', f'smu{_cmd_syntax[3]}')

MEASURE_COMPLETE_EVENT_ID class-attribute instance-attribute 

MEASURE_COMPLETE_EVENT_ID = replace('smuX', f'smu{_cmd_syntax[3]}')

PULSE_COMPLETE_EVENT_ID class-attribute instance-attribute 

PULSE_COMPLETE_EVENT_ID = replace('smuX', f'smu{_cmd_syntax[3]}')

SOURCE_COMPLETE_EVENT_ID class-attribute instance-attribute 

SOURCE_COMPLETE_EVENT_ID = replace('smuX', f'smu{_cmd_syntax[3]}')

SWEEPING_EVENT_ID class-attribute instance-attribute 

SWEEPING_EVENT_ID = replace('smuX', f'smu{_cmd_syntax[3]}')

SWEEP_COMPLETE_EVENT_ID class-attribute instance-attribute 

SWEEP_COMPLETE_EVENT_ID = replace('smuX', f'smu{_cmd_syntax[3]}')

arm property 

arm: SmuxItemTriggerArm

Return the smuX.trigger.arm command tree.

Sub-properties and sub-methods
  • .count: The smuX.trigger.arm.count attribute.
  • .set(): The smuX.trigger.arm.set() function.
  • .stimulus: The smuX.trigger.arm.stimulus attribute.

autoclear property writable 

autoclear: str

Access the smuX.trigger.autoclear attribute.

Description
  • This attribute turns automatic clearing of the event detectors on or off.
Usage
  • Accessing this property will send the print(smuX.trigger.autoclear) query.
  • Setting this property to a value will send the smuX.trigger.autoclear = value command.
TSP Syntax 
- smuX.trigger.autoclear = value
- print(smuX.trigger.autoclear)
Raises:

count property writable 

count: str

Access the smuX.trigger.count attribute.

Description
  • This attribute sets the trigger count in the trigger model.
Usage
  • Accessing this property will send the print(smuX.trigger.count) query.
  • Setting this property to a value will send the smuX.trigger.count = value command.
TSP Syntax 
- smuX.trigger.count = value
- print(smuX.trigger.count)
Raises:

endpulse property 

endpulse: SmuxItemTriggerEndpulse

Return the smuX.trigger.endpulse command tree.

Sub-properties and sub-methods
  • .action: The smuX.trigger.endpulse.action attribute.
  • .set(): The smuX.trigger.endpulse.set() function.
  • .stimulus: The smuX.trigger.endpulse.stimulus attribute.

endsweep property 

endsweep: SmuxItemTriggerEndsweep

Return the smuX.trigger.endsweep command tree.

Sub-properties and sub-methods
  • .action: The smuX.trigger.endsweep.action attribute.

measure property 

measure: SmuxItemTriggerMeasure

Return the smuX.trigger.measure command tree.

Sub-properties and sub-methods
  • .i(): The smuX.trigger.measure.i() function.
  • .iv(): The smuX.trigger.measure.iv() function.
  • .p(): The smuX.trigger.measure.p() function.
  • .r(): The smuX.trigger.measure.r() function.
  • .v(): The smuX.trigger.measure.v() function.
  • .action: The smuX.trigger.measure.action attribute.
  • .set(): The smuX.trigger.measure.set() function.
  • .stimulus: The smuX.trigger.measure.stimulus attribute.

source property 

source: SmuxItemTriggerSource

Return the smuX.trigger.source command tree.

Sub-properties and sub-methods
  • .action: The smuX.trigger.source.action attribute.
  • .limiti: The smuX.trigger.source.limiti attribute.
  • .limitv: The smuX.trigger.source.limitv attribute.
  • .lineari(): The smuX.trigger.source.lineari() function.
  • .linearv(): The smuX.trigger.source.linearv() function.
  • .listi(): The smuX.trigger.source.listi() function.
  • .listv(): The smuX.trigger.source.listv() function.
  • .logi(): The smuX.trigger.source.logi() function.
  • .logv(): The smuX.trigger.source.logv() function.
  • .set(): The smuX.trigger.source.set() function.
  • .stimulus: The smuX.trigger.source.stimulus attribute.

initiate 

initiate() -> None

Run the smuX.trigger.initiate() function.

Description
  • This function initiates a sweep operation.
TSP Syntax 
- smuX.trigger.initiate()
Raises:

SmuxItemTriggerArm

Bases: BaseTSPCmd

The smuX.trigger.arm command tree.

Properties and methods
  • .count: The smuX.trigger.arm.count attribute.
  • .set(): The smuX.trigger.arm.set() function.
  • .stimulus: The smuX.trigger.arm.stimulus attribute.

count property writable 

count: str

Access the smuX.trigger.arm.count attribute.

Description
  • This attribute sets the arm count in the trigger model.
Usage
  • Accessing this property will send the print(smuX.trigger.arm.count) query.
  • Setting this property to a value will send the smuX.trigger.arm.count = value command.
TSP Syntax 
- smuX.trigger.arm.count = value
- print(smuX.trigger.arm.count)
Raises:

stimulus property writable 

stimulus: str

Access the smuX.trigger.arm.stimulus attribute.

Description
  • This attribute selects the event that causes the arm event detector to enter the detected state.
Usage
  • Accessing this property will send the print(smuX.trigger.arm.stimulus) query.
  • Setting this property to a value will send the smuX.trigger.arm.stimulus = value command.
TSP Syntax 
- smuX.trigger.arm.stimulus = value
- print(smuX.trigger.arm.stimulus)
Raises:

set_ 

set_() -> None

Run the smuX.trigger.arm.set() function.

Description
  • This function sets the arm event detector to the detected state.
TSP Syntax 
- smuX.trigger.arm.set()
Raises:

SmuxItemTriggerEndpulse

Bases: BaseTSPCmd

The smuX.trigger.endpulse command tree.

Properties and methods
  • .action: The smuX.trigger.endpulse.action attribute.
  • .set(): The smuX.trigger.endpulse.set() function.
  • .stimulus: The smuX.trigger.endpulse.stimulus attribute.

action property writable 

action: str

Access the smuX.trigger.endpulse.action attribute.

Description
  • This attribute enables or disables pulse mode sweeps.
Usage
  • Accessing this property will send the print(smuX.trigger.endpulse.action) query.
  • Setting this property to a value will send the smuX.trigger.endpulse.action = value command.
TSP Syntax 
- smuX.trigger.endpulse.action = value
- print(smuX.trigger.endpulse.action)
Raises:

stimulus property writable 

stimulus: str

Access the smuX.trigger.endpulse.stimulus attribute.

Description
  • This attribute defines which event causes the end pulse event detector to enter the detected state.
Usage
  • Accessing this property will send the print(smuX.trigger.endpulse.stimulus) query.
  • Setting this property to a value will send the smuX.trigger.endpulse.stimulus = value command.
TSP Syntax 
- smuX.trigger.endpulse.stimulus = value
- print(smuX.trigger.endpulse.stimulus)
Raises:

set_ 

set_() -> None

Run the smuX.trigger.endpulse.set() function.

Description
  • This function sets the end pulse event detector to the detected state.
TSP Syntax 
- smuX.trigger.endpulse.set()
Raises:

SmuxItemTriggerEndsweep

Bases: BaseTSPCmd

The smuX.trigger.endsweep command tree.

Properties and methods
  • .action: The smuX.trigger.endsweep.action attribute.

action property writable 

action: str

Access the smuX.trigger.endsweep.action attribute.

Description
  • This attribute sets the action of the source at the end of a sweep.
Usage
  • Accessing this property will send the print(smuX.trigger.endsweep.action) query.
  • Setting this property to a value will send the smuX.trigger.endsweep.action = value command.
TSP Syntax 
- smuX.trigger.endsweep.action = value
- print(smuX.trigger.endsweep.action)
Raises:

SmuxItemTriggerMeasure

Bases: BaseTSPCmd

The smuX.trigger.measure command tree.

Properties and methods
  • .i(): The smuX.trigger.measure.i() function.
  • .iv(): The smuX.trigger.measure.iv() function.
  • .p(): The smuX.trigger.measure.p() function.
  • .r(): The smuX.trigger.measure.r() function.
  • .v(): The smuX.trigger.measure.v() function.
  • .action: The smuX.trigger.measure.action attribute.
  • .set(): The smuX.trigger.measure.set() function.
  • .stimulus: The smuX.trigger.measure.stimulus attribute.

action property writable 

action: str

Access the smuX.trigger.measure.action attribute.

Description
  • This attribute controls measurement actions during a sweep.
Usage
  • Accessing this property will send the print(smuX.trigger.measure.action) query.
  • Setting this property to a value will send the smuX.trigger.measure.action = value command.
TSP Syntax 
- smuX.trigger.measure.action = value
- print(smuX.trigger.measure.action)
Raises:

stimulus property writable 

stimulus: str

Access the smuX.trigger.measure.stimulus attribute.

Description
  • This attribute selects the event that causes the measure event detector to enter the detected state.
Usage
  • Accessing this property will send the print(smuX.trigger.measure.stimulus) query.
  • Setting this property to a value will send the smuX.trigger.measure.stimulus = value command.
TSP Syntax 
- smuX.trigger.measure.stimulus = value
- print(smuX.trigger.measure.stimulus)
Raises:

i 

i(rbuffer: str) -> None

Run the smuX.trigger.measure.i() function.

Description
  • This function configures the measurements that are to be made in a subsequent sweep. (i = current in amperes)
TSP Syntax 
- smuX.trigger.measure.i()
Parameters:
  • rbuffer (str) –

    A reading buffer object where the readings are stored.
Raises:

iv 

iv(ibuffer: str, vbuffer: str) -> None

Run the smuX.trigger.measure.iv() function.

Description
  • This function configures the measurements that are to be made in a subsequent sweep. (i = current in amperes, v = voltage in volts)
TSP Syntax 
- smuX.trigger.measure.iv()
Parameters:
  • ibuffer (str) –

    A reading buffer object where current readings are stored.

  • vbuffer (str) –

    A reading buffer object where voltage readings are stored.
Raises:

p 

p(rbuffer: str) -> None

Run the smuX.trigger.measure.p() function.

Description
  • This function configures the measurements that are to be made in a subsequent sweep. (p = power in watts)
TSP Syntax 
- smuX.trigger.measure.p()
Parameters:
  • rbuffer (str) –

    A reading buffer object where the readings are stored.
Raises:

r 

r(rbuffer: str) -> None

Run the smuX.trigger.measure.r() function.

Description
  • This function configures the measurements that are to be made in a subsequent sweep. (r = resistance in ohms)
TSP Syntax 
- smuX.trigger.measure.r()
Parameters:
  • rbuffer (str) –

    A reading buffer object where the readings are stored.
Raises:

set_ 

set_() -> None

Run the smuX.trigger.measure.set() function.

Description
  • This function sets the measurement event detector to the detected state.
TSP Syntax 
- smuX.trigger.measure.set()
Raises:

v 

v(rbuffer: str) -> None

Run the smuX.trigger.measure.v() function.

Description
  • This function configures the measurements that are to be made in a subsequent sweep. (v = voltage in volts)
TSP Syntax 
- smuX.trigger.measure.v()
Parameters:
  • rbuffer (str) –

    A reading buffer object where the readings are stored.
Raises:

SmuxItemTriggerSource

Bases: BaseTSPCmd

The smuX.trigger.source command tree.

Properties and methods
  • .action: The smuX.trigger.source.action attribute.
  • .limiti: The smuX.trigger.source.limiti attribute.
  • .limitv: The smuX.trigger.source.limitv attribute.
  • .lineari(): The smuX.trigger.source.lineari() function.
  • .linearv(): The smuX.trigger.source.linearv() function.
  • .listi(): The smuX.trigger.source.listi() function.
  • .listv(): The smuX.trigger.source.listv() function.
  • .logi(): The smuX.trigger.source.logi() function.
  • .logv(): The smuX.trigger.source.logv() function.
  • .set(): The smuX.trigger.source.set() function.
  • .stimulus: The smuX.trigger.source.stimulus attribute.

action property writable 

action: str

Access the smuX.trigger.source.action attribute.

Description
  • This attribute enables or disables sweeping the source (on or off).
Usage
  • Accessing this property will send the print(smuX.trigger.source.action) query.
  • Setting this property to a value will send the smuX.trigger.source.action = value command.
TSP Syntax 
- smuX.trigger.source.action = value
- print(smuX.trigger.source.action)
Raises:

limiti property writable 

limiti: str

Access the smuX.trigger.source.limiti attribute.

Description
  • This attribute sets the sweep source limit. (i = current in amperes)
Usage
  • Accessing this property will send the print(smuX.trigger.source.limiti) query.
  • Setting this property to a value will send the smuX.trigger.source.limiti = value command.
TSP Syntax 
- smuX.trigger.source.limiti = value
- print(smuX.trigger.source.limiti)
Raises:

limitv property writable 

limitv: str

Access the smuX.trigger.source.limitv attribute.

Description
  • This attribute sets the sweep source limit. (v = voltage in volts)
Usage
  • Accessing this property will send the print(smuX.trigger.source.limitv) query.
  • Setting this property to a value will send the smuX.trigger.source.limitv = value command.
TSP Syntax 
- smuX.trigger.source.limitv = value
- print(smuX.trigger.source.limitv)
Raises:

stimulus property writable 

stimulus: str

Access the smuX.trigger.source.stimulus attribute.

Description
  • This attribute defines which event causes the source event detector to enter the detected state.
Usage
  • Accessing this property will send the print(smuX.trigger.source.stimulus) query.
  • Setting this property to a value will send the smuX.trigger.source.stimulus = value command.
TSP Syntax 
- smuX.trigger.source.stimulus = value
- print(smuX.trigger.source.stimulus)
Raises:

lineari 

lineari(start_value: float, end_value: float, points: int) -> None

Run the smuX.trigger.source.lineari() function.

Description
  • This function configures a linear source sweep. (i = current in amperes)
TSP Syntax 
- smuX.trigger.source.lineari()
Parameters:
  • start_value (float) –

    Source value of the first point.

  • end_value (float) –

    Source value of the last point.

  • points (int) –

    The number of points used to calculate the step size.
Raises:

linearv 

linearv(start_value: float, end_value: float, points: int) -> None

Run the smuX.trigger.source.linearv() function.

Description
  • This function configures a linear source sweep. (v = voltage in volts)
TSP Syntax 
- smuX.trigger.source.linearv()
Parameters:
  • start_value (float) –

    Source value of the first point.

  • end_value (float) –

    Source value of the last point.

  • points (int) –

    The number of points used to calculate the step size.
Raises:

listi 

listi(sweep_list: Sequence[str | float]) -> None

Run the smuX.trigger.source.listi() function.

Description
  • This function configures an array-based source sweep. (i = current in amperes)
TSP Syntax 
- smuX.trigger.source.listi()
Parameters:
Raises:

listv 

listv(sweep_list: Sequence[str | float]) -> None

Run the smuX.trigger.source.listv() function.

Description
  • This function configures an array-based source sweep. (v = voltage in volts)
TSP Syntax 
- smuX.trigger.source.listv()
Parameters:
Raises:

logi 

logi(start_value: float, end_value: float, points: int, asymptote: str) -> None

Run the smuX.trigger.source.logi() function.

Description
  • This function configures an exponential (geometric) source sweep. (i = current in amperes)
TSP Syntax 
- smuX.trigger.source.logi()
Parameters:
  • start_value (float) –

    Source value of the first point.

  • end_value (float) –

    Source value of the last point.

  • points (int) –

    The number of points used to calculate the step size.

  • asymptote (str) –

    The asymptotic offset value.
Raises:

logv 

logv(start_value: float, end_value: float, points: int, asymptote: str) -> None

Run the smuX.trigger.source.logv() function.

Description
  • This function configures an exponential (geometric) source sweep. (v = voltage in volts)
TSP Syntax 
- smuX.trigger.source.logv()
Parameters:
  • start_value (float) –

    Source value of the first point.

  • end_value (float) –

    Source value of the last point.

  • points (int) –

    The number of points used to calculate the step size.

  • asymptote (str) –

    The asymptotic offset value.
Raises:

set_ 

set_() -> None

Run the smuX.trigger.source.set() function.

Description
  • This function sets the source event detector to the detected state.
TSP Syntax 
- smuX.trigger.source.set()
Raises: