smux
¶
The smux commands module.
These commands are used in the following models: SMU2601B_Pulse
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.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.interlock.enable
- smuX.makebuffer()
- smuX.measure.Y()
- 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.pulser.enable
- smuX.pulser.measure.aperture
- smuX.pulser.measure.calibrateY()
- smuX.pulser.measure.delay
- smuX.pulser.protect.sensev
- smuX.pulser.protect.sourcev
- smuX.pulser.protect.tripped
- smuX.pulser.source.calibratebiasi()
- smuX.pulser.source.calibratei()
- 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.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.pulsewidth
- 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..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(): ThesmuX.abort()function..buffer: ThesmuX.buffercommand tree..cal: ThesmuX.calcommand tree..contact: ThesmuX.contactcommand tree..interlock: ThesmuX.interlockcommand tree..makebuffer(): ThesmuX.makebuffer()function..measure: ThesmuX.measurecommand tree..measureiandstep(): ThesmuX.measureiandstep()function..measureivandstep(): ThesmuX.measureivandstep()function..measurepandstep(): ThesmuX.measurepandstep()function..measurerandstep(): ThesmuX.measurerandstep()function..measurevandstep(): ThesmuX.measurevandstep()function..nvbuffer1: ThesmuX.nvbuffer1attribute..nvbuffer2: ThesmuX.nvbuffer2attribute..pulser: ThesmuX.pulsercommand tree..reset(): ThesmuX.reset()function..savebuffer(): ThesmuX.savebuffer()function..sense: ThesmuX.senseattribute..source: ThesmuX.sourcecommand tree..trigger: ThesmuX.triggercommand tree.
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_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]}')
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_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]}')
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_ZERO
class-attribute
instance-attribute
¶
OUTPUT_ZERO = 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(): ThesmuX.buffer.getstats()function..recalculatestats(): ThesmuX.buffer.recalculatestats()function.
cal
property
¶
cal: SmuxItemCal
Return the smuX.cal command tree.
Sub-properties and sub-methods
.adjustdate: ThesmuX.cal.adjustdateattribute..date: ThesmuX.cal.dateattribute..due: ThesmuX.cal.dueattribute..lock(): ThesmuX.cal.lock()function..password: ThesmuX.cal.passwordattribute..polarity: ThesmuX.cal.polarityattribute..restore(): ThesmuX.cal.restore()function..save(): ThesmuX.cal.save()function..state: ThesmuX.cal.stateattribute..unlock(): ThesmuX.cal.unlock()function.
contact
property
¶
contact: SmuxItemContact
Return the smuX.contact command tree.
Sub-properties and sub-methods
.calibratehi(): ThesmuX.contact.calibratehi()function..calibratelo(): ThesmuX.contact.calibratelo()function..check(): ThesmuX.contact.check()function..r(): ThesmuX.contact.r()function..speed: ThesmuX.contact.speedattribute..threshold: ThesmuX.contact.thresholdattribute.
interlock
property
¶
interlock: SmuxItemInterlock
Return the smuX.interlock command tree.
Sub-properties and sub-methods
.enable: ThesmuX.interlock.enableattribute.
measure
property
¶
measure: SmuxItemMeasure
Return the smuX.measure command tree.
Sub-properties and sub-methods
.i(): ThesmuX.measure.i()function..iv(): ThesmuX.measure.iv()function..p(): ThesmuX.measure.p()function..r(): ThesmuX.measure.r()function..v(): ThesmuX.measure.v()function..autorangei: ThesmuX.measure.autorangeiattribute..autorangev: ThesmuX.measure.autorangevattribute..autozero: ThesmuX.measure.autozeroattribute..calibratei(): ThesmuX.measure.calibratei()function..calibratev(): ThesmuX.measure.calibratev()function..count: ThesmuX.measure.countattribute..delay: ThesmuX.measure.delayattribute..delayfactor: ThesmuX.measure.delayfactorattribute..filter: ThesmuX.measure.filtercommand tree..highcrangedelayfactor: ThesmuX.measure.highcrangedelayfactorattribute..interval: ThesmuX.measure.intervalattribute..lowrangei: ThesmuX.measure.lowrangeiattribute..lowrangev: ThesmuX.measure.lowrangevattribute..nplc: ThesmuX.measure.nplcattribute..overlappedi(): ThesmuX.measure.overlappedi()function..overlappediv(): ThesmuX.measure.overlappediv()function..overlappedp(): ThesmuX.measure.overlappedp()function..overlappedr(): ThesmuX.measure.overlappedr()function..overlappedv(): ThesmuX.measure.overlappedv()function..rangei: ThesmuX.measure.rangeiattribute..rangev: ThesmuX.measure.rangevattribute..rel: ThesmuX.measure.relcommand 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: |
|
|---|
pulser
property
¶
pulser: SmuxItemPulser
Return the smuX.pulser command tree.
Sub-properties and sub-methods
.enable: ThesmuX.pulser.enableattribute..measure: ThesmuX.pulser.measurecommand tree..protect: ThesmuX.pulser.protectcommand tree..source: ThesmuX.pulser.sourcecommand tree.
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 = valuecommand.
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: ThesmuX.source.autorangeiattribute..autorangev: ThesmuX.source.autorangevattribute..calibratei(): ThesmuX.source.calibratei()function..calibratev(): ThesmuX.source.calibratev()function..compliance: ThesmuX.source.complianceattribute..delay: ThesmuX.source.delayattribute..func: ThesmuX.source.funcattribute..highc: ThesmuX.source.highcattribute..leveli: ThesmuX.source.leveliattribute..levelv: ThesmuX.source.levelvattribute..limiti: ThesmuX.source.limitiattribute..limitp: ThesmuX.source.limitpattribute..limitv: ThesmuX.source.limitvattribute..lowrangei: ThesmuX.source.lowrangeiattribute..lowrangev: ThesmuX.source.lowrangevattribute..offfunc: ThesmuX.source.offfuncattribute..offlimiti: ThesmuX.source.offlimitiattribute..offlimitv: ThesmuX.source.offlimitvattribute..offmode: ThesmuX.source.offmodeattribute..output: ThesmuX.source.outputattribute..rangei: ThesmuX.source.rangeiattribute..rangev: ThesmuX.source.rangevattribute..settling: ThesmuX.source.settlingattribute..sink: ThesmuX.source.sinkattribute.
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: ThesmuX.trigger.armcommand tree..autoclear: ThesmuX.trigger.autoclearattribute..count: ThesmuX.trigger.countattribute..endpulse: ThesmuX.trigger.endpulsecommand tree..endsweep: ThesmuX.trigger.endsweepcommand tree..initiate(): ThesmuX.trigger.initiate()function..measure: ThesmuX.trigger.measurecommand tree..source: ThesmuX.trigger.sourcecommand 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
¶
Run the smuX.makebuffer() function.
Description
- This function creates a reading buffer.
TSP Syntax
- smuX.makebuffer()
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
measureiandstep
¶
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: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
measureivandstep
¶
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: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
measurepandstep
¶
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: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
measurerandstep
¶
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: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
measurevandstep
¶
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: |
|
|---|
| Returns: |
|
|---|
| 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: |
|
|---|
| Raises: |
|
|---|
SmuxItemBuffer
¶
Bases: BaseTSPCmd
The smuX.buffer command tree.
Properties and methods
.getstats(): ThesmuX.buffer.getstats()function..recalculatestats(): ThesmuX.buffer.recalculatestats()function.
getstats
¶
Run the smuX.buffer.getstats() function.
Description
- This function returns the statistics for a specified reading buffer.
TSP Syntax
- smuX.buffer.getstats()
| Parameters: |
|
|---|
| Returns: |
|---|
| 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: |
|
|---|
| Raises: |
|
|---|
SmuxItemCal
¶
Bases: BaseTSPCmd
The smuX.cal command tree.
Properties and methods
.adjustdate: ThesmuX.cal.adjustdateattribute..date: ThesmuX.cal.dateattribute..due: ThesmuX.cal.dueattribute..lock(): ThesmuX.cal.lock()function..password: ThesmuX.cal.passwordattribute..polarity: ThesmuX.cal.polarityattribute..restore(): ThesmuX.cal.restore()function..save(): ThesmuX.cal.save()function..state: ThesmuX.cal.stateattribute..unlock(): ThesmuX.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 = valuecommand.
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 = valuecommand.
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 = valuecommand.
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 = valuecommand.
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 = valuecommand.
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: |
|
|---|
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: |
|
|---|
| 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: |
|
|---|
| Raises: |
|
|---|
SmuxItemContact
¶
Bases: BaseTSPCmd
The smuX.contact command tree.
Properties and methods
.calibratehi(): ThesmuX.contact.calibratehi()function..calibratelo(): ThesmuX.contact.calibratelo()function..check(): ThesmuX.contact.check()function..r(): ThesmuX.contact.r()function..speed: ThesmuX.contact.speedattribute..threshold: ThesmuX.contact.thresholdattribute.
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 = valuecommand.
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 = valuecommand.
TSP Syntax
- smuX.contact.threshold = value
- print(smuX.contact.threshold)
| Raises: |
|
|---|
calibratehi
¶
Run the smuX.contact.calibratehi() function.
Description
- This function adjusts the high/sense high contact check measurement.
TSP Syntax
- smuX.contact.calibratehi()
| Parameters: |
|---|
| Raises: |
|
|---|
calibratelo
¶
Run the smuX.contact.calibratelo() function.
Description
- This function adjusts the low/sense low contact check measurement.
TSP Syntax
- smuX.contact.calibratelo()
| Parameters: |
|---|
| 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: |
|
|---|
| Raises: |
|
|---|
SmuxItemInterlock
¶
Bases: BaseTSPCmd
The smuX.interlock command tree.
Properties and methods
.enable: ThesmuX.interlock.enableattribute.
enable
property
writable
¶
enable: str
Access the smuX.interlock.enable attribute.
Description
- This attribute enables or disables use of the interlock signal.
Usage
- Accessing this property will send the
print(smuX.interlock.enable)query. - Setting this property to a value will send the
smuX.interlock.enable = valuecommand.
TSP Syntax
- smuX.interlock.enable = value
- print(smuX.interlock.enable)
| Raises: |
|
|---|
SmuxItemMeasure
¶
Bases: BaseTSPCmd
The smuX.measure command tree.
Properties and methods
.i(): ThesmuX.measure.i()function..iv(): ThesmuX.measure.iv()function..p(): ThesmuX.measure.p()function..r(): ThesmuX.measure.r()function..v(): ThesmuX.measure.v()function..autorangei: ThesmuX.measure.autorangeiattribute..autorangev: ThesmuX.measure.autorangevattribute..autozero: ThesmuX.measure.autozeroattribute..calibratei(): ThesmuX.measure.calibratei()function..calibratev(): ThesmuX.measure.calibratev()function..count: ThesmuX.measure.countattribute..delay: ThesmuX.measure.delayattribute..delayfactor: ThesmuX.measure.delayfactorattribute..filter: ThesmuX.measure.filtercommand tree..highcrangedelayfactor: ThesmuX.measure.highcrangedelayfactorattribute..interval: ThesmuX.measure.intervalattribute..lowrangei: ThesmuX.measure.lowrangeiattribute..lowrangev: ThesmuX.measure.lowrangevattribute..nplc: ThesmuX.measure.nplcattribute..overlappedi(): ThesmuX.measure.overlappedi()function..overlappediv(): ThesmuX.measure.overlappediv()function..overlappedp(): ThesmuX.measure.overlappedp()function..overlappedr(): ThesmuX.measure.overlappedr()function..overlappedv(): ThesmuX.measure.overlappedv()function..rangei: ThesmuX.measure.rangeiattribute..rangev: ThesmuX.measure.rangevattribute..rel: ThesmuX.measure.relcommand tree.
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 = valuecommand.
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 = valuecommand.
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 = valuecommand.
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 = valuecommand.
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 = valuecommand.
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 = valuecommand.
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: ThesmuX.measure.filter.countattribute..enable: ThesmuX.measure.filter.enableattribute..type: ThesmuX.measure.filter.typeattribute.
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 = valuecommand.
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 = valuecommand.
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 = valuecommand.
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 = valuecommand.
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 when the pulser is disabled.
Usage
- Accessing this property will send the
print(smuX.measure.nplc)query. - Setting this property to a value will send the
smuX.measure.nplc = valuecommand.
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 = valuecommand.
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 = valuecommand.
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: ThesmuX.measure.rel.enableiattribute..enablep: ThesmuX.measure.rel.enablepattribute..enabler: ThesmuX.measure.rel.enablerattribute..enablev: ThesmuX.measure.rel.enablevattribute..leveli: ThesmuX.measure.rel.leveliattribute..levelp: ThesmuX.measure.rel.levelpattribute..levelr: ThesmuX.measure.rel.levelrattribute..levelv: ThesmuX.measure.rel.levelvattribute.
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: |
|
|---|
| 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: |
|
|---|
| Raises: |
|
|---|
i
¶
Run the smuX.measure.i() function.
Description
- This function makes one or more measurements. (i = current in amperes)
TSP Syntax
- smuX.measure.i()
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
iv
¶
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: |
|
|---|
| Returns: |
|
|---|
| 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: |
|
|---|
| Raises: |
|
|---|
overlappediv
¶
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: |
|---|
| 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: |
|
|---|
| 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: |
|
|---|
| 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: |
|
|---|
| Raises: |
|
|---|
p
¶
Run the smuX.measure.p() function.
Description
- This function makes one or more measurements. (p = power in watts)
TSP Syntax
- smuX.measure.p()
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
r
¶
Run the smuX.measure.r() function.
Description
- This function makes one or more measurements. (r = resistance in ohms)
TSP Syntax
- smuX.measure.r()
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
v
¶
Run the smuX.measure.v() function.
Description
- This function makes one or more measurements. (v = voltage in volts)
TSP Syntax
- smuX.measure.v()
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
SmuxItemMeasureFilter
¶
Bases: BaseTSPCmd
The smuX.measure.filter command tree.
Properties and methods
.count: ThesmuX.measure.filter.countattribute..enable: ThesmuX.measure.filter.enableattribute..type: ThesmuX.measure.filter.typeattribute.
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 = valuecommand.
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 = valuecommand.
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 = valuecommand.
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: ThesmuX.measure.rel.enableiattribute..enablep: ThesmuX.measure.rel.enablepattribute..enabler: ThesmuX.measure.rel.enablerattribute..enablev: ThesmuX.measure.rel.enablevattribute..leveli: ThesmuX.measure.rel.leveliattribute..levelp: ThesmuX.measure.rel.levelpattribute..levelr: ThesmuX.measure.rel.levelrattribute..levelv: ThesmuX.measure.rel.levelvattribute.
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 = valuecommand.
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 = valuecommand.
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 = valuecommand.
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 = valuecommand.
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 = valuecommand.
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 = valuecommand.
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 = valuecommand.
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 = valuecommand.
TSP Syntax
- smuX.measure.rel.levelv = value
- print(smuX.measure.rel.levelv)
| Raises: |
|
|---|
SmuxItemPulser
¶
Bases: BaseTSPCmd
The smuX.pulser command tree.
Properties and methods
.enable: ThesmuX.pulser.enableattribute..measure: ThesmuX.pulser.measurecommand tree..protect: ThesmuX.pulser.protectcommand tree..source: ThesmuX.pulser.sourcecommand tree.
enable
property
writable
¶
enable: str
Access the smuX.pulser.enable attribute.
Description
- This attribute enables or disables the 2601B-PULSE pulser.
Usage
- Accessing this property will send the
print(smuX.pulser.enable)query. - Setting this property to a value will send the
smuX.pulser.enable = valuecommand.
TSP Syntax
- smuX.pulser.enable = value
- print(smuX.pulser.enable)
| Raises: |
|
|---|
measure
property
¶
measure: SmuxItemPulserMeasure
Return the smuX.pulser.measure command tree.
Sub-properties and sub-methods
.aperture: ThesmuX.pulser.measure.apertureattribute..calibratei(): ThesmuX.pulser.measure.calibratei()function..calibratev(): ThesmuX.pulser.measure.calibratev()function..delay: ThesmuX.pulser.measure.delayattribute.
protect
property
¶
protect: SmuxItemPulserProtect
Return the smuX.pulser.protect command tree.
Sub-properties and sub-methods
.sensev: ThesmuX.pulser.protect.sensevattribute..sourcev: ThesmuX.pulser.protect.sourcevattribute..tripped: ThesmuX.pulser.protect.trippedattribute.
source
property
¶
source: SmuxItemPulserSource
Return the smuX.pulser.source command tree.
Sub-properties and sub-methods
.calibratebiasi(): ThesmuX.pulser.source.calibratebiasi()function..calibratei(): ThesmuX.pulser.source.calibratei()function.
SmuxItemPulserMeasure
¶
Bases: BaseTSPCmd
The smuX.pulser.measure command tree.
Properties and methods
.aperture: ThesmuX.pulser.measure.apertureattribute..calibratei(): ThesmuX.pulser.measure.calibratei()function..calibratev(): ThesmuX.pulser.measure.calibratev()function..delay: ThesmuX.pulser.measure.delayattribute.
aperture
property
writable
¶
aperture: str
Access the smuX.pulser.measure.aperture attribute.
Description
- This attribute specifies the pulse measurement aperture when the pulser is enabled.
Usage
- Accessing this property will send the
print(smuX.pulser.measure.aperture)query. - Setting this property to a value will send the
smuX.pulser.measure.aperture = valuecommand.
TSP Syntax
- smuX.pulser.measure.aperture = value
- print(smuX.pulser.measure.aperture)
| Raises: |
|
|---|
delay
property
writable
¶
delay: str
Access the smuX.pulser.measure.delay attribute.
Description
- This attribute sets the measurement delay when the pulser is enabled.
Usage
- Accessing this property will send the
print(smuX.pulser.measure.delay)query. - Setting this property to a value will send the
smuX.pulser.measure.delay = valuecommand.
TSP Syntax
- smuX.pulser.measure.delay = value
- print(smuX.pulser.measure.delay)
| Raises: |
|
|---|
calibratei
¶
calibratei(
range_: str, cp1_measured: str, cp1_reference: str, cp2_measured: str, cp2_reference: str
) -> None
Run the smuX.pulser.measure.calibratei() function.
Description
- This function generates and activates new measurement calibration constants for the pulser. (i = current in amperes)
TSP Syntax
- smuX.pulser.measure.calibratei()
| Parameters: |
|
|---|
| Raises: |
|
|---|
calibratev
¶
calibratev(
range_: str, cp1_measured: str, cp1_reference: str, cp2_measured: str, cp2_reference: str
) -> None
Run the smuX.pulser.measure.calibratev() function.
Description
- This function generates and activates new measurement calibration constants for the pulser. (v = voltage in volts)
TSP Syntax
- smuX.pulser.measure.calibratev()
| Parameters: |
|
|---|
| Raises: |
|
|---|
SmuxItemPulserProtect
¶
Bases: BaseTSPCmd
The smuX.pulser.protect command tree.
Properties and methods
.sensev: ThesmuX.pulser.protect.sensevattribute..sourcev: ThesmuX.pulser.protect.sourcevattribute..tripped: ThesmuX.pulser.protect.trippedattribute.
sensev
property
writable
¶
sensev: str
Access the smuX.pulser.protect.sensev attribute.
Description
- This attribute sets a voltage protection level used to monitor the sense terminals when the pulser is enabled.
Usage
- Accessing this property will send the
print(smuX.pulser.protect.sensev)query. - Setting this property to a value will send the
smuX.pulser.protect.sensev = valuecommand.
TSP Syntax
- smuX.pulser.protect.sensev = value
- print(smuX.pulser.protect.sensev)
| Raises: |
|
|---|
sourcev
property
writable
¶
sourcev: str
Access the smuX.pulser.protect.sourcev attribute.
Description
- This attribute sets an absolute voltage protection level used to monitor the force terminals when the pulser is enabled.
Usage
- Accessing this property will send the
print(smuX.pulser.protect.sourcev)query. - Setting this property to a value will send the
smuX.pulser.protect.sourcev = valuecommand.
TSP Syntax
- smuX.pulser.protect.sourcev = value
- print(smuX.pulser.protect.sourcev)
| Raises: |
|
|---|
tripped
property
¶
tripped: str
Access the smuX.pulser.protect.tripped attribute.
Description
- This attribute indicates if the protection circuit was tripped.
Usage
- Accessing this property will send the
print(smuX.pulser.protect.tripped)query.
TSP Syntax
- print(smuX.pulser.protect.tripped)
| Raises: |
|
|---|
SmuxItemPulserSource
¶
Bases: BaseTSPCmd
The smuX.pulser.source command tree.
Properties and methods
.calibratebiasi(): ThesmuX.pulser.source.calibratebiasi()function..calibratei(): ThesmuX.pulser.source.calibratei()function.
calibratebiasi
¶
calibratebiasi(
range_: str, cp1_expected: str, cp1_reference: str, cp2_expected: str, cp2_reference: str
) -> None
Run the smuX.pulser.source.calibratebiasi() function.
Description
- This function adjusts the new bias source calibration constants for the pulser.
TSP Syntax
- smuX.pulser.source.calibratebiasi()
| Parameters: |
|
|---|
| Raises: |
|
|---|
calibratei
¶
calibratei(
range_: str, cp1_expected: str, cp1_reference: str, cp2_expected: str, cp2_reference: str
) -> None
Run the smuX.pulser.source.calibratei() function.
Description
- This function generates and activates new source calibration constants for the pulser.
TSP Syntax
- smuX.pulser.source.calibratei()
| Parameters: |
|
|---|
| Raises: |
|
|---|
SmuxItemSource
¶
Bases: BaseTSPCmd
The smuX.source command tree.
Properties and methods
.autorangei: ThesmuX.source.autorangeiattribute..autorangev: ThesmuX.source.autorangevattribute..calibratei(): ThesmuX.source.calibratei()function..calibratev(): ThesmuX.source.calibratev()function..compliance: ThesmuX.source.complianceattribute..delay: ThesmuX.source.delayattribute..func: ThesmuX.source.funcattribute..highc: ThesmuX.source.highcattribute..leveli: ThesmuX.source.leveliattribute..levelv: ThesmuX.source.levelvattribute..limiti: ThesmuX.source.limitiattribute..limitp: ThesmuX.source.limitpattribute..limitv: ThesmuX.source.limitvattribute..lowrangei: ThesmuX.source.lowrangeiattribute..lowrangev: ThesmuX.source.lowrangevattribute..offfunc: ThesmuX.source.offfuncattribute..offlimiti: ThesmuX.source.offlimitiattribute..offlimitv: ThesmuX.source.offlimitvattribute..offmode: ThesmuX.source.offmodeattribute..output: ThesmuX.source.outputattribute..rangei: ThesmuX.source.rangeiattribute..rangev: ThesmuX.source.rangevattribute..settling: ThesmuX.source.settlingattribute..sink: ThesmuX.source.sinkattribute.
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 = valuecommand.
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 = valuecommand.
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 = valuecommand.
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 = valuecommand.
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 = valuecommand.
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 = valuecommand.
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 = valuecommand.
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 = valuecommand.
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 = valuecommand.
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 = valuecommand.
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 = valuecommand.
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 = valuecommand.
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 = valuecommand.
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 = valuecommand.
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 = valuecommand.
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 = valuecommand.
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 = valuecommand.
TSP Syntax
- smuX.source.output = value
- print(smuX.source.output)
| 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 = valuecommand.
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 = valuecommand.
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 = valuecommand.
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 = valuecommand.
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: |
|
|---|
| 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: |
|
|---|
| 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: ThesmuX.trigger.armcommand tree..autoclear: ThesmuX.trigger.autoclearattribute..count: ThesmuX.trigger.countattribute..endpulse: ThesmuX.trigger.endpulsecommand tree..endsweep: ThesmuX.trigger.endsweepcommand tree..initiate(): ThesmuX.trigger.initiate()function..measure: ThesmuX.trigger.measurecommand tree..source: ThesmuX.trigger.sourcecommand 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: ThesmuX.trigger.arm.countattribute..set(): ThesmuX.trigger.arm.set()function..stimulus: ThesmuX.trigger.arm.stimulusattribute.
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 = valuecommand.
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 = valuecommand.
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: ThesmuX.trigger.endpulse.actionattribute..set(): ThesmuX.trigger.endpulse.set()function..stimulus: ThesmuX.trigger.endpulse.stimulusattribute.
endsweep
property
¶
endsweep: SmuxItemTriggerEndsweep
Return the smuX.trigger.endsweep command tree.
Sub-properties and sub-methods
.action: ThesmuX.trigger.endsweep.actionattribute.
measure
property
¶
measure: SmuxItemTriggerMeasure
Return the smuX.trigger.measure command tree.
Sub-properties and sub-methods
.i(): ThesmuX.trigger.measure.i()function..iv(): ThesmuX.trigger.measure.iv()function..p(): ThesmuX.trigger.measure.p()function..r(): ThesmuX.trigger.measure.r()function..v(): ThesmuX.trigger.measure.v()function..action: ThesmuX.trigger.measure.actionattribute..set(): ThesmuX.trigger.measure.set()function..stimulus: ThesmuX.trigger.measure.stimulusattribute.
source
property
¶
source: SmuxItemTriggerSource
Return the smuX.trigger.source command tree.
Sub-properties and sub-methods
.action: ThesmuX.trigger.source.actionattribute..limiti: ThesmuX.trigger.source.limitiattribute..limitv: ThesmuX.trigger.source.limitvattribute..lineari(): ThesmuX.trigger.source.lineari()function..linearv(): ThesmuX.trigger.source.linearv()function..listi(): ThesmuX.trigger.source.listi()function..listv(): ThesmuX.trigger.source.listv()function..logi(): ThesmuX.trigger.source.logi()function..logv(): ThesmuX.trigger.source.logv()function..pulsewidth: ThesmuX.trigger.source.pulsewidthattribute..set(): ThesmuX.trigger.source.set()function..stimulus: ThesmuX.trigger.source.stimulusattribute.
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: ThesmuX.trigger.arm.countattribute..set(): ThesmuX.trigger.arm.set()function..stimulus: ThesmuX.trigger.arm.stimulusattribute.
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 = valuecommand.
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 = valuecommand.
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: ThesmuX.trigger.endpulse.actionattribute..set(): ThesmuX.trigger.endpulse.set()function..stimulus: ThesmuX.trigger.endpulse.stimulusattribute.
action
property
writable
¶
action: str
Access the smuX.trigger.endpulse.action attribute.
Description
- This attribute enables or disables pulse sweeps when the pulser is disabled.
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 = valuecommand.
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 = valuecommand.
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: ThesmuX.trigger.endsweep.actionattribute.
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 = valuecommand.
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(): ThesmuX.trigger.measure.i()function..iv(): ThesmuX.trigger.measure.iv()function..p(): ThesmuX.trigger.measure.p()function..r(): ThesmuX.trigger.measure.r()function..v(): ThesmuX.trigger.measure.v()function..action: ThesmuX.trigger.measure.actionattribute..set(): ThesmuX.trigger.measure.set()function..stimulus: ThesmuX.trigger.measure.stimulusattribute.
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 = valuecommand.
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 = valuecommand.
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: |
|
|---|
| Raises: |
|
|---|
iv
¶
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: |
|---|
| 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: |
|
|---|
| 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: |
|
|---|
| 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: |
|
|---|
| Raises: |
|
|---|
SmuxItemTriggerSource
¶
Bases: BaseTSPCmd
The smuX.trigger.source command tree.
Properties and methods
.action: ThesmuX.trigger.source.actionattribute..limiti: ThesmuX.trigger.source.limitiattribute..limitv: ThesmuX.trigger.source.limitvattribute..lineari(): ThesmuX.trigger.source.lineari()function..linearv(): ThesmuX.trigger.source.linearv()function..listi(): ThesmuX.trigger.source.listi()function..listv(): ThesmuX.trigger.source.listv()function..logi(): ThesmuX.trigger.source.logi()function..logv(): ThesmuX.trigger.source.logv()function..pulsewidth: ThesmuX.trigger.source.pulsewidthattribute..set(): ThesmuX.trigger.source.set()function..stimulus: ThesmuX.trigger.source.stimulusattribute.
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 = valuecommand.
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 = valuecommand.
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 = valuecommand.
TSP Syntax
- smuX.trigger.source.limitv = value
- print(smuX.trigger.source.limitv)
| Raises: |
|
|---|
pulsewidth
property
writable
¶
pulsewidth: str
Access the smuX.trigger.source.pulsewidth attribute.
Description
- This attribute sets the source pulse width when using a trigger model sweep when the pulser is enabled
Usage
- Accessing this property will send the
print(smuX.trigger.source.pulsewidth)query. - Setting this property to a value will send the
smuX.trigger.source.pulsewidth = valuecommand.
TSP Syntax
- smuX.trigger.source.pulsewidth = value
- print(smuX.trigger.source.pulsewidth)
| 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 = valuecommand.
TSP Syntax
- smuX.trigger.source.stimulus = value
- print(smuX.trigger.source.stimulus)
| Raises: |
|
|---|
lineari
¶
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: |
|---|
| Raises: |
|
|---|
linearv
¶
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: |
|---|
| Raises: |
|
|---|
listi
¶
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
¶
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
¶
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: |
|---|
| Raises: |
|
|---|
logv
¶
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: |
|---|
| 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: |
|
|---|