smu
¶
The smu commands module.
These commands are used in the following models: SMU2450
THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED.
Please report an issue if one is found.
Attributes and Functions
- smu.interlock.enable
- smu.interlock.tripped
- smu.measure.autorange
- smu.measure.autorangehigh
- smu.measure.autorangelow
- smu.measure.autorangerebound
- smu.measure.autozero.enable
- smu.measure.autozero.once()
- smu.measure.configlist.catalog()
- smu.measure.configlist.create()
- smu.measure.configlist.delete()
- smu.measure.configlist.query()
- smu.measure.configlist.recall()
- smu.measure.configlist.size()
- smu.measure.configlist.store()
- smu.measure.configlist.storefunc()
- smu.measure.count
- smu.measure.displaydigits
- smu.measure.filter.count
- smu.measure.filter.enable
- smu.measure.filter.type
- smu.measure.func
- smu.measure.getattribute()
- smu.measure.limit[Y].audible
- smu.measure.limit[Y].autoclear
- smu.measure.limit[Y].clear()
- smu.measure.limit[Y].enable
- smu.measure.limit[Y].fail
- smu.measure.limit[Y].high.value
- smu.measure.limit[Y].low.value
- smu.measure.math.enable
- smu.measure.math.format
- smu.measure.math.mxb.bfactor
- smu.measure.math.mxb.mfactor
- smu.measure.math.percent
- smu.measure.nplc
- smu.measure.offsetcompensation
- smu.measure.range
- smu.measure.read()
- smu.measure.readwithtime()
- smu.measure.rel.acquire()
- smu.measure.rel.enable
- smu.measure.rel.level
- smu.measure.sense
- smu.measure.setattribute()
- smu.measure.unit
- smu.measure.userdelay[N]
- smu.reset()
- smu.source.autodelay
- smu.source.autorange
- smu.source.configlist.catalog()
- smu.source.configlist.create()
- smu.source.configlist.delete()
- smu.source.configlist.query()
- smu.source.configlist.recall()
- smu.source.configlist.size()
- smu.source.configlist.store()
- smu.source.configlist.storefunc()
- smu.source.delay
- smu.source.func
- smu.source.getattribute()
- smu.source.highc
- smu.source.ilimit.level
- smu.source.ilimit.tripped
- smu.source.level
- smu.source.offmode
- smu.source.output
- smu.source.protect.level
- smu.source.protect.tripped
- smu.source.range
- smu.source.readback
- smu.source.setattribute()
- smu.source.sweeplinear()
- smu.source.sweeplinearstep()
- smu.source.sweeplist()
- smu.source.sweeplog()
- smu.source.userdelay[N]
- smu.source.vlimit.level
- smu.source.vlimit.tripped
- smu.terminals
Smu
¶
Bases: BaseTSPCmd
The smu command tree.
Constants
.ATTR_MEAS_AUTO_ZERO: Autozero enable..ATTR_MEAS_COUNT: Set the measure count..ATTR_MEAS_DIGITS: Display digits..ATTR_MEAS_FILTER_COUNT: Set filter count..ATTR_MEAS_FILTER_ENABLE: Enable or disable filter..ATTR_MEAS_FILTER_TYPE: Set filter type..ATTR_MEAS_LIMIT_AUDIBLE_1: Set limit 1 audible..ATTR_MEAS_LIMIT_AUDIBLE_2: Set limit 2 audible..ATTR_MEAS_LIMIT_AUTO_CLEAR_1: Enable or disable limit 1 autoclear..ATTR_MEAS_LIMIT_AUTO_CLEAR_2: Enable or disable limit 2 autoclear..ATTR_MEAS_LIMIT_ENABLE_1: Enable or disable limit 1..ATTR_MEAS_LIMIT_ENABLE_2: Limit 2 enable..ATTR_MEAS_LIMIT_FAIL_1: Limit 1 fail..ATTR_MEAS_LIMIT_FAIL_2: Limit 2 fail..ATTR_MEAS_LIMIT_HIGH_1: Set limit 1 high value..ATTR_MEAS_LIMIT_HIGH_2: Set limit 2 high value..ATTR_MEAS_LIMIT_LOW_1: Set limit 1 low value..ATTR_MEAS_LIMIT_LOW_2: Set limit 2 low value..ATTR_MEAS_MATH_ENABLE: Enable or disable math..ATTR_MEAS_MATH_FORMAT: Select the math format..ATTR_MEAS_MATH_MXB_BF: Set the mxb b (offset) value..ATTR_MEAS_MATH_MXB_MF: Set the mxb m (scalar) value..ATTR_MEAS_MATH_PERCENT: Set the percent match function..ATTR_MEAS_NPLC: NPLC..ATTR_MEAS_OFFSET_COMP: Offset compensation..ATTR_MEAS_RANGE: Range..ATTR_MEAS_RANGE_AUTO: Set up autorange..ATTR_MEAS_RANGE_HIGH: Set up autorange high limit..ATTR_MEAS_RANGE_LOW: Set up autorange low limit..ATTR_MEAS_RANGE_REBOUND: Set autorange rebound..ATTR_MEAS_REL_ENABLE: Relative offset enable..ATTR_MEAS_REL_LEVEL: Relative offset level..ATTR_MEAS_SENSE: Sense (2-wire or 4-wire)..ATTR_MEAS_UNIT: Measurement unit..ATTR_MEAS_USER_DELAY_N: Set user delay, where N is 1 to 5..ATTR_SRC_DELAY: Delay in addition to normal settling times after turning on the source..ATTR_SRC_DELAY_AUTO: Set autodelay..ATTR_SRC_FUNCTION: Set the function..ATTR_SRC_HIGHC: Set high capacitance..ATTR_SRC_LEVEL: Set level..ATTR_SRC_LIMIT_LEVEL: Set limit level..ATTR_SRC_LIMIT_TRIPPED: Source limit exceeded..ATTR_SRC_OFFMODE: Set output off mode..ATTR_SRC_PROTECT_LEVEL: Set overvoltage protection limit..ATTR_SRC_PROTECT_TRIPPED: The overvoltage protection limit is active..ATTR_SRC_RANGE: Set range..ATTR_SRC_RANGE_AUTO: Set autorange..ATTR_SRC_READBACK: Set source readback..ATTR_SRC_USER_DELAY_N: User delay N, where N is the user delay, 1 to 5..AUDIBLE_FAIL: Beeper sound on test failure..AUDIBLE_NONE: Beeper never sounds..AUDIBLE_PASS: Beeper sound on test pass..DELAY_AUTO: Delay between measurement points set to autodelay..DIGITS_3_5: Set display to 3.5 digits..DIGITS_4_5: Set display to 4.5 digits..DIGITS_5_5: Set display to 5.5 digits..DIGITS_6_5: Set display to 6.5 digits..FAIL_BOTH: Test failed; measurement exceeded both limits..FAIL_HIGH: Test failed; measurement exceeded high limit..FAIL_LOW: Test failed; measurement exceeded low limit..FAIL_NONE: Test passed; measurement under or equal to the high limit..FILTER_MOVING_AVG: Use the moving average filter for the selected measure function when the measurement filter is enabled..FILTER_REPEAT_AVG: Use the repeatinter average filter for the selected measure function when the measurement filter is enabled..FUNC_DC_CURRENT: Current measurement function..FUNC_DC_VOLTAGE: Voltage measurement function..FUNC_RESISTANCE: Resistance measurement function..INFINITE: Set count to infinite..MATH_MXB: Perform y = mx+b operation on measurement..MATH_PERCENT: Perform percent operation on measurements..MATH_RECIPROCAL: Perform reciprocal math operation on measurements..OFF: Allow the output to be turned on when the interlock is not engaged..OFFMODE_GUARD: Set the state when the output is turned off to guard..OFFMODE_HIGHZ: Set the state when the output is turned off to high impedance..OFFMODE_NORMAL: Set the state when the output is turned off to normal..OFFMODE_ZERO: Set the state when the output is turned off to zero..ON: Only allow the output to be turned on if the interlock is engaged..PROTECT_100V: The overvoltage protection value..PROTECT_10V: The overvoltage protection value..PROTECT_120V: The overvoltage protection value..PROTECT_140V: The overvoltage protection value..PROTECT_160V: The overvoltage protection value..PROTECT_180V: The overvoltage protection value..PROTECT_20V: The overvoltage protection value..PROTECT_2V: The overvoltage protection value..PROTECT_40V: The overvoltage protection value..PROTECT_5V: The overvoltage protection value..PROTECT_60V: The overvoltage protection value..PROTECT_80V: The overvoltage protection value..PROTECT_NONE: The overvoltage protection value..RANGE_AUTO: Most sensitive source range for each source level in the sweep..RANGE_BEST: Best fixed range..RANGE_FIXED: Present source range for the entire sweep..SENSE_2WIRE: Use two-wire sensing..SENSE_4WIRE: Use four-wire sensing..TERMINALS_FRONT: Use the front-panel input and output terminals..TERMINALS_REAR: Use the rear-panel input and output terminals..UNIT_AMP: Set unit of measure to amps (only available for current measurements)..UNIT_OHM: Set unit of measure to ohms (available for voltage, current, or resistance measurements)..UNIT_VOLT: Set unit of measure to volts (only available for voltage measurements)..UNIT_WATT: Set unit of measure to power (only available for voltage or current measurements).
Properties and methods
.interlock: Thesmu.interlockcommand tree..measure: Thesmu.measurecommand tree..reset(): Thesmu.reset()function..source: Thesmu.sourcecommand tree..terminals: Thesmu.terminalsattribute.
ATTR_MEAS_AUTO_ZERO
class-attribute
instance-attribute
¶
ATTR_MEAS_AUTO_ZERO = 'smu.ATTR_MEAS_AUTO_ZERO'
ATTR_MEAS_FILTER_COUNT
class-attribute
instance-attribute
¶
ATTR_MEAS_FILTER_COUNT = 'smu.ATTR_MEAS_FILTER_COUNT'
ATTR_MEAS_FILTER_ENABLE
class-attribute
instance-attribute
¶
ATTR_MEAS_FILTER_ENABLE = 'smu.ATTR_MEAS_FILTER_ENABLE'
ATTR_MEAS_FILTER_TYPE
class-attribute
instance-attribute
¶
ATTR_MEAS_FILTER_TYPE = 'smu.ATTR_MEAS_FILTER_TYPE'
ATTR_MEAS_LIMIT_AUDIBLE_1
class-attribute
instance-attribute
¶
ATTR_MEAS_LIMIT_AUDIBLE_1 = 'smu.ATTR_MEAS_LIMIT_AUDIBLE_1'
ATTR_MEAS_LIMIT_AUDIBLE_2
class-attribute
instance-attribute
¶
ATTR_MEAS_LIMIT_AUDIBLE_2 = 'smu.ATTR_MEAS_LIMIT_AUDIBLE_2'
ATTR_MEAS_LIMIT_AUTO_CLEAR_1
class-attribute
instance-attribute
¶
ATTR_MEAS_LIMIT_AUTO_CLEAR_1 = 'smu.ATTR_MEAS_LIMIT_AUTO_CLEAR_1'
ATTR_MEAS_LIMIT_AUTO_CLEAR_2
class-attribute
instance-attribute
¶
ATTR_MEAS_LIMIT_AUTO_CLEAR_2 = 'smu.ATTR_MEAS_LIMIT_AUTO_CLEAR_2'
ATTR_MEAS_LIMIT_ENABLE_1
class-attribute
instance-attribute
¶
ATTR_MEAS_LIMIT_ENABLE_1 = 'smu.ATTR_MEAS_LIMIT_ENABLE_1'
ATTR_MEAS_LIMIT_ENABLE_2
class-attribute
instance-attribute
¶
ATTR_MEAS_LIMIT_ENABLE_2 = 'smu.ATTR_MEAS_LIMIT_ENABLE_2'
ATTR_MEAS_LIMIT_FAIL_1
class-attribute
instance-attribute
¶
ATTR_MEAS_LIMIT_FAIL_1 = 'smu.ATTR_MEAS_LIMIT_FAIL_1'
ATTR_MEAS_LIMIT_FAIL_2
class-attribute
instance-attribute
¶
ATTR_MEAS_LIMIT_FAIL_2 = 'smu.ATTR_MEAS_LIMIT_FAIL_2'
ATTR_MEAS_LIMIT_HIGH_1
class-attribute
instance-attribute
¶
ATTR_MEAS_LIMIT_HIGH_1 = 'smu.ATTR_MEAS_LIMIT_HIGH_1'
ATTR_MEAS_LIMIT_HIGH_2
class-attribute
instance-attribute
¶
ATTR_MEAS_LIMIT_HIGH_2 = 'smu.ATTR_MEAS_LIMIT_HIGH_2'
ATTR_MEAS_LIMIT_LOW_1
class-attribute
instance-attribute
¶
ATTR_MEAS_LIMIT_LOW_1 = 'smu.ATTR_MEAS_LIMIT_LOW_1'
ATTR_MEAS_LIMIT_LOW_2
class-attribute
instance-attribute
¶
ATTR_MEAS_LIMIT_LOW_2 = 'smu.ATTR_MEAS_LIMIT_LOW_2'
ATTR_MEAS_MATH_ENABLE
class-attribute
instance-attribute
¶
ATTR_MEAS_MATH_ENABLE = 'smu.ATTR_MEAS_MATH_ENABLE'
ATTR_MEAS_MATH_FORMAT
class-attribute
instance-attribute
¶
ATTR_MEAS_MATH_FORMAT = 'smu.ATTR_MEAS_MATH_FORMAT'
ATTR_MEAS_MATH_MXB_BF
class-attribute
instance-attribute
¶
ATTR_MEAS_MATH_MXB_BF = 'smu.ATTR_MEAS_MATH_MXB_BF'
ATTR_MEAS_MATH_MXB_MF
class-attribute
instance-attribute
¶
ATTR_MEAS_MATH_MXB_MF = 'smu.ATTR_MEAS_MATH_MXB_MF'
ATTR_MEAS_MATH_PERCENT
class-attribute
instance-attribute
¶
ATTR_MEAS_MATH_PERCENT = 'smu.ATTR_MEAS_MATH_PERCENT'
ATTR_MEAS_OFFSET_COMP
class-attribute
instance-attribute
¶
ATTR_MEAS_OFFSET_COMP = 'smu.ATTR_MEAS_OFFSET_COMP'
ATTR_MEAS_RANGE_AUTO
class-attribute
instance-attribute
¶
ATTR_MEAS_RANGE_AUTO = 'smu.ATTR_MEAS_RANGE_AUTO'
ATTR_MEAS_RANGE_HIGH
class-attribute
instance-attribute
¶
ATTR_MEAS_RANGE_HIGH = 'smu.ATTR_MEAS_RANGE_HIGH'
ATTR_MEAS_RANGE_LOW
class-attribute
instance-attribute
¶
ATTR_MEAS_RANGE_LOW = 'smu.ATTR_MEAS_RANGE_LOW'
ATTR_MEAS_RANGE_REBOUND
class-attribute
instance-attribute
¶
ATTR_MEAS_RANGE_REBOUND = 'smu.ATTR_MEAS_RANGE_REBOUND'
ATTR_MEAS_REL_ENABLE
class-attribute
instance-attribute
¶
ATTR_MEAS_REL_ENABLE = 'smu.ATTR_MEAS_REL_ENABLE'
ATTR_MEAS_REL_LEVEL
class-attribute
instance-attribute
¶
ATTR_MEAS_REL_LEVEL = 'smu.ATTR_MEAS_REL_LEVEL'
ATTR_MEAS_USER_DELAY_N
class-attribute
instance-attribute
¶
ATTR_MEAS_USER_DELAY_N = 'smu.ATTR_MEAS_USER_DELAY_N'
ATTR_SRC_DELAY_AUTO
class-attribute
instance-attribute
¶
ATTR_SRC_DELAY_AUTO = 'smu.ATTR_SRC_DELAY_AUTO'
ATTR_SRC_LIMIT_LEVEL
class-attribute
instance-attribute
¶
ATTR_SRC_LIMIT_LEVEL = 'smu.ATTR_SRC_LIMIT_LEVEL'
ATTR_SRC_LIMIT_TRIPPED
class-attribute
instance-attribute
¶
ATTR_SRC_LIMIT_TRIPPED = 'smu.ATTR_SRC_LIMIT_TRIPPED'
ATTR_SRC_PROTECT_LEVEL
class-attribute
instance-attribute
¶
ATTR_SRC_PROTECT_LEVEL = 'smu.ATTR_SRC_PROTECT_LEVEL'
ATTR_SRC_PROTECT_TRIPPED
class-attribute
instance-attribute
¶
ATTR_SRC_PROTECT_TRIPPED = 'smu.ATTR_SRC_PROTECT_TRIPPED'
ATTR_SRC_RANGE_AUTO
class-attribute
instance-attribute
¶
ATTR_SRC_RANGE_AUTO = 'smu.ATTR_SRC_RANGE_AUTO'
ATTR_SRC_USER_DELAY_N
class-attribute
instance-attribute
¶
ATTR_SRC_USER_DELAY_N = 'smu.ATTR_SRC_USER_DELAY_N'
interlock
property
¶
interlock: SmuInterlock
Return the smu.interlock command tree.
Sub-properties and sub-methods
.enable: Thesmu.interlock.enableattribute..tripped: Thesmu.interlock.trippedattribute.
measure
property
¶
measure: SmuMeasure
Return the smu.measure command tree.
Sub-properties and sub-methods
.autorange: Thesmu.measure.autorangeattribute..autorangehigh: Thesmu.measure.autorangehighattribute..autorangelow: Thesmu.measure.autorangelowattribute..autorangerebound: Thesmu.measure.autorangereboundattribute..autozero: Thesmu.measure.autozerocommand tree..configlist: Thesmu.measure.configlistcommand tree..count: Thesmu.measure.countattribute..displaydigits: Thesmu.measure.displaydigitsattribute..filter: Thesmu.measure.filtercommand tree..func: Thesmu.measure.funcattribute..getattribute(): Thesmu.measure.getattribute()function..limit: Thesmu.measure.limit[Y]command tree..math: Thesmu.measure.mathcommand tree..nplc: Thesmu.measure.nplcattribute..offsetcompensation: Thesmu.measure.offsetcompensationattribute..range: Thesmu.measure.rangeattribute..read(): Thesmu.measure.read()function..readwithtime(): Thesmu.measure.readwithtime()function..rel: Thesmu.measure.relcommand tree..sense: Thesmu.measure.senseattribute..setattribute(): Thesmu.measure.setattribute()function..unit: Thesmu.measure.unitattribute..userdelay: Thesmu.measure.userdelay[N]attribute.
source
property
¶
source: SmuSource
Return the smu.source command tree.
Sub-properties and sub-methods
.autodelay: Thesmu.source.autodelayattribute..autorange: Thesmu.source.autorangeattribute..configlist: Thesmu.source.configlistcommand tree..delay: Thesmu.source.delayattribute..func: Thesmu.source.funcattribute..getattribute(): Thesmu.source.getattribute()function..highc: Thesmu.source.highcattribute..level: Thesmu.source.levelattribute..offmode: Thesmu.source.offmodeattribute..output: Thesmu.source.outputattribute..protect: Thesmu.source.protectcommand tree..range: Thesmu.source.rangeattribute..readback: Thesmu.source.readbackattribute..setattribute(): Thesmu.source.setattribute()function..sweeplinear(): Thesmu.source.sweeplinear()function..sweeplinearstep(): Thesmu.source.sweeplinearstep()function..sweeplist(): Thesmu.source.sweeplist()function..sweeplog(): Thesmu.source.sweeplog()function..userdelay: Thesmu.source.userdelay[N]attribute..ilimit: Thesmu.source.ilimitcommand tree..vlimit: Thesmu.source.vlimitcommand tree.
terminals
property
writable
¶
terminals: str
Access the smu.terminals attribute.
Description
- This attribute describes which set of input and output terminals the instrument is using.
Usage
- Accessing this property will send the
print(smu.terminals)query. - Setting this property to a value will send the
smu.terminals = valuecommand.
TSP Syntax
- smu.terminals = value
- print(smu.terminals)
| Raises: |
|
|---|
reset
¶
reset() -> None
Run the smu.reset() function.
Description
- This function turns off the output and resets the commands that begin with . to their default settings.
TSP Syntax
- smu.reset()
| Raises: |
|
|---|
SmuInterlock
¶
Bases: BaseTSPCmd
The smu.interlock command tree.
Properties and methods
.enable: Thesmu.interlock.enableattribute..tripped: Thesmu.interlock.trippedattribute.
enable
property
writable
¶
enable: str
Access the smu.interlock.enable attribute.
Description
- This attribute determines if the output can be turned on when the interlock is not engaged.
Usage
- Accessing this property will send the
print(smu.interlock.enable)query. - Setting this property to a value will send the
smu.interlock.enable = valuecommand.
TSP Syntax
- smu.interlock.enable = value
- print(smu.interlock.enable)
| Raises: |
|
|---|
tripped
property
¶
tripped: str
Access the smu.interlock.tripped attribute.
Description
- This attribute indicates that the interlock has been tripped.
Usage
- Accessing this property will send the
print(smu.interlock.tripped)query.
TSP Syntax
- print(smu.interlock.tripped)
| Raises: |
|
|---|
SmuMeasure
¶
Bases: BaseTSPCmd
The smu.measure command tree.
Properties and methods
.autorange: Thesmu.measure.autorangeattribute..autorangehigh: Thesmu.measure.autorangehighattribute..autorangelow: Thesmu.measure.autorangelowattribute..autorangerebound: Thesmu.measure.autorangereboundattribute..autozero: Thesmu.measure.autozerocommand tree..configlist: Thesmu.measure.configlistcommand tree..count: Thesmu.measure.countattribute..displaydigits: Thesmu.measure.displaydigitsattribute..filter: Thesmu.measure.filtercommand tree..func: Thesmu.measure.funcattribute..getattribute(): Thesmu.measure.getattribute()function..limit: Thesmu.measure.limit[Y]command tree..math: Thesmu.measure.mathcommand tree..nplc: Thesmu.measure.nplcattribute..offsetcompensation: Thesmu.measure.offsetcompensationattribute..range: Thesmu.measure.rangeattribute..read(): Thesmu.measure.read()function..readwithtime(): Thesmu.measure.readwithtime()function..rel: Thesmu.measure.relcommand tree..sense: Thesmu.measure.senseattribute..setattribute(): Thesmu.measure.setattribute()function..unit: Thesmu.measure.unitattribute..userdelay: Thesmu.measure.userdelay[N]attribute.
autorange
property
writable
¶
autorange: str
Access the smu.measure.autorange attribute.
Description
- This attribute determines if the measurement range is set manually or automatically for the selected measure function.
Usage
- Accessing this property will send the
print(smu.measure.autorange)query. - Setting this property to a value will send the
smu.measure.autorange = valuecommand.
TSP Syntax
- smu.measure.autorange = value
- print(smu.measure.autorange)
| Raises: |
|
|---|
autorangehigh
property
writable
¶
autorangehigh: str
Access the smu.measure.autorangehigh attribute.
Description
- When autorange is selected, this attribute represents the highest measurement range that is used when the instrument selects the measurement range automatically.
Usage
- Accessing this property will send the
print(smu.measure.autorangehigh)query. - Setting this property to a value will send the
smu.measure.autorangehigh = valuecommand.
TSP Syntax
- smu.measure.autorangehigh = value
- print(smu.measure.autorangehigh)
| Raises: |
|
|---|
autorangelow
property
writable
¶
autorangelow: str
Access the smu.measure.autorangelow attribute.
Description
- This attribute selects the lower limit for measurements of the selected function when the range is selected automatically.
Usage
- Accessing this property will send the
print(smu.measure.autorangelow)query. - Setting this property to a value will send the
smu.measure.autorangelow = valuecommand.
TSP Syntax
- smu.measure.autorangelow = value
- print(smu.measure.autorangelow)
| Raises: |
|
|---|
autorangerebound
property
writable
¶
autorangerebound: str
Access the smu.measure.autorangerebound attribute.
Description
- This attribute determines if the instrument restores the measure range to match the limit range after making a measurement.
Usage
- Accessing this property will send the
print(smu.measure.autorangerebound)query. - Setting this property to a value will send the
smu.measure.autorangerebound = valuecommand.
TSP Syntax
- smu.measure.autorangerebound = value
- print(smu.measure.autorangerebound)
| Raises: |
|
|---|
autozero
property
¶
autozero: SmuMeasureAutozero
Return the smu.measure.autozero command tree.
Sub-properties and sub-methods
.enable: Thesmu.measure.autozero.enableattribute..once(): Thesmu.measure.autozero.once()function.
configlist
property
¶
configlist: SmuMeasureConfiglist
Return the smu.measure.configlist command tree.
Sub-properties and sub-methods
.catalog(): Thesmu.measure.configlist.catalog()function..create(): Thesmu.measure.configlist.create()function..delete(): Thesmu.measure.configlist.delete()function..query(): Thesmu.measure.configlist.query()function..recall(): Thesmu.measure.configlist.recall()function..size(): Thesmu.measure.configlist.size()function..store(): Thesmu.measure.configlist.store()function..storefunc(): Thesmu.measure.configlist.storefunc()function.
count
property
writable
¶
count: str
Access the smu.measure.count attribute.
Description
- This attribute sets the number of measurements to make when a measurement is requested.
Usage
- Accessing this property will send the
print(smu.measure.count)query. - Setting this property to a value will send the
smu.measure.count = valuecommand.
TSP Syntax
- smu.measure.count = value
- print(smu.measure.count)
| Raises: |
|
|---|
displaydigits
property
writable
¶
displaydigits: str
Access the smu.measure.displaydigits attribute.
Description
- This attribute determines the number of digits that are displayed for measurements on the front panel for the selected function.
Usage
- Accessing this property will send the
print(smu.measure.displaydigits)query. - Setting this property to a value will send the
smu.measure.displaydigits = valuecommand.
TSP Syntax
- smu.measure.displaydigits = value
- print(smu.measure.displaydigits)
Info
digits, the 6½ display digits: smu.DIGITS_6_5 5½ display digits: smu.DIGITS_5_5 4½ display digits: smu.DIGITS_4_5 3½ display digits: smu.DIGITS_3_5.
| Raises: |
|
|---|
filter
property
¶
filter: SmuMeasureFilter
Return the smu.measure.filter command tree.
Sub-properties and sub-methods
.count: Thesmu.measure.filter.countattribute..enable: Thesmu.measure.filter.enableattribute..type: Thesmu.measure.filter.typeattribute.
func
property
writable
¶
func: str
Access the smu.measure.func attribute.
Description
- This attribute selects the active measure function.
Usage
- Accessing this property will send the
print(smu.measure.func)query. - Setting this property to a value will send the
smu.measure.func = valuecommand.
TSP Syntax
- smu.measure.func = value
- print(smu.measure.func)
| Raises: |
|
|---|
limit
property
¶
limit: dict[int, SmuMeasureLimitItem]
Return the smu.measure.limit[Y] command tree.
Info
Y, the limit number: 1 or 2.
Sub-properties and sub-methods
.audible: Thesmu.measure.limit[Y].audibleattribute..autoclear: Thesmu.measure.limit[Y].autoclearattribute..clear(): Thesmu.measure.limit[Y].clear()function..enable: Thesmu.measure.limit[Y].enableattribute..fail: Thesmu.measure.limit[Y].failattribute..high: Thesmu.measure.limit[Y].highcommand tree..low: Thesmu.measure.limit[Y].lowcommand tree.
math
property
¶
math: SmuMeasureMath
Return the smu.measure.math command tree.
Sub-properties and sub-methods
.enable: Thesmu.measure.math.enableattribute..format: Thesmu.measure.math.formatattribute..mxb: Thesmu.measure.math.mxbcommand tree..percent: Thesmu.measure.math.percentattribute.
nplc
property
writable
¶
nplc: str
Access the smu.measure.nplc attribute.
Description
- This command sets the time that the input signal is measured for the selected function.
Usage
- Accessing this property will send the
print(smu.measure.nplc)query. - Setting this property to a value will send the
smu.measure.nplc = valuecommand.
TSP Syntax
- smu.measure.nplc = value
- print(smu.measure.nplc)
| Raises: |
|
|---|
offsetcompensation
property
writable
¶
offsetcompensation: str
Access the smu.measure.offsetcompensation attribute.
Description
- This attribute determines if offset compensation is used.
Usage
- Accessing this property will send the
print(smu.measure.offsetcompensation)query. - Setting this property to a value will send the
smu.measure.offsetcompensation = valuecommand.
TSP Syntax
- smu.measure.offsetcompensation = value
- print(smu.measure.offsetcompensation)
| Raises: |
|
|---|
range
property
writable
¶
range: str
Access the smu.measure.range attribute.
Description
- This attribute determines the positive full-scale measure range.
Usage
- Accessing this property will send the
print(smu.measure.range)query. - Setting this property to a value will send the
smu.measure.range = valuecommand.
TSP Syntax
- smu.measure.range = value
- print(smu.measure.range)
| Raises: |
|
|---|
rel
property
¶
rel: SmuMeasureRel
Return the smu.measure.rel command tree.
Sub-properties and sub-methods
.acquire(): Thesmu.measure.rel.acquire()function..enable: Thesmu.measure.rel.enableattribute..level: Thesmu.measure.rel.levelattribute.
sense
property
writable
¶
sense: str
Access the smu.measure.sense attribute.
Description
- This attribute selects local (2-wire) or remote (4-wire) sensing.
Usage
- Accessing this property will send the
print(smu.measure.sense)query. - Setting this property to a value will send the
smu.measure.sense = valuecommand.
TSP Syntax
- smu.measure.sense = value
- print(smu.measure.sense)
| Raises: |
|
|---|
unit
property
writable
¶
unit: str
Access the smu.measure.unit attribute.
Description
- This attribute sets the units of measurement that are displayed on the front panel of the instrument and stored in the reading buffer.
Usage
- Accessing this property will send the
print(smu.measure.unit)query. - Setting this property to a value will send the
smu.measure.unit = valuecommand.
TSP Syntax
- smu.measure.unit = value
- print(smu.measure.unit)
| Raises: |
|
|---|
userdelay
property
¶
Access the smu.measure.userdelay[N] attribute.
Description
- This attribute sets a user-defined delay that you can use in the trigger model.
Usage
- Accessing an item from this property will send the
print(smu.measure.userdelay[N])query. - Setting an item from this property to a value will send the
smu.measure.userdelay[N] = valuecommand.
TSP Syntax
- smu.measure.userdelay[N] = value
- print(smu.measure.userdelay[N])
Info
N, the user delay to which this time applies (1 to 5).
| Raises: |
|
|---|
getattribute
¶
Run the smu.measure.getattribute() function.
Description
- This function returns the setting for a function attribute.
TSP Syntax
- smu.measure.getattribute()
| Parameters: |
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
read
¶
Run the smu.measure.read() function.
Description
- This function makes measurements, places them in a reading buffer, and returns the last reading.
TSP Syntax
- smu.measure.read()
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
readwithtime
¶
Run the smu.measure.readwithtime() function.
Description
- This function initiates measurements and returns the last actual measurement and time information in UTC format without using the trigger model.
TSP Syntax
- smu.measure.readwithtime()
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
setattribute
¶
Run the smu.measure.setattribute() function.
Description
- This function allows you to set up a measure function whether or not the function is active.
TSP Syntax
- smu.measure.setattribute()
| Parameters: |
|---|
| Raises: |
|
|---|
SmuMeasureAutozero
¶
Bases: BaseTSPCmd
The smu.measure.autozero command tree.
Properties and methods
.enable: Thesmu.measure.autozero.enableattribute..once(): Thesmu.measure.autozero.once()function.
enable
property
writable
¶
enable: str
Access the smu.measure.autozero.enable 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(smu.measure.autozero.enable)query. - Setting this property to a value will send the
smu.measure.autozero.enable = valuecommand.
TSP Syntax
- smu.measure.autozero.enable = value
- print(smu.measure.autozero.enable)
| Raises: |
|
|---|
once
¶
once() -> None
Run the smu.measure.autozero.once() function.
Description
- This function causes the instrument to refresh the reference and zero measurements once.
TSP Syntax
- smu.measure.autozero.once()
| Raises: |
|
|---|
SmuMeasureConfiglist
¶
Bases: BaseTSPCmd
The smu.measure.configlist command tree.
Properties and methods
.catalog(): Thesmu.measure.configlist.catalog()function..create(): Thesmu.measure.configlist.create()function..delete(): Thesmu.measure.configlist.delete()function..query(): Thesmu.measure.configlist.query()function..recall(): Thesmu.measure.configlist.recall()function..size(): Thesmu.measure.configlist.size()function..store(): Thesmu.measure.configlist.store()function..storefunc(): Thesmu.measure.configlist.storefunc()function.
catalog
¶
catalog() -> str
Run the smu.measure.configlist.catalog() function.
Description
- This function returns the name of one measure configuration list that is stored on the instrument.
TSP Syntax
- smu.measure.configlist.catalog()
| Returns: |
|
|---|
| Raises: |
|
|---|
create
¶
create(list_name: str) -> None
Run the smu.measure.configlist.create() function.
Description
- This function creates an empty measure configuration list.
TSP Syntax
- smu.measure.configlist.create()
| Parameters: |
|
|---|
| Raises: |
|
|---|
delete
¶
Run the smu.measure.configlist.delete() function.
Description
- This function deletes a measure configuration list.
TSP Syntax
- smu.measure.configlist.delete()
| Parameters: |
|
|---|
| Raises: |
|
|---|
query
¶
Run the smu.measure.configlist.query() function.
Description
- This function returns a list of TSP commands and parameter settings that are stored in the specified configuration index.
TSP Syntax
- smu.measure.configlist.query()
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
recall
¶
recall(
list_name: str,
index: int | None = None,
source_list_name: str | None = None,
source_index: int | None = None,
) -> None
Run the smu.measure.configlist.recall() function.
Description
- This function recalls a configuration index in a measure configuration list and an optional source configuration list.
TSP Syntax
- smu.measure.configlist.recall()
| Parameters: |
|
|---|
| Raises: |
|
|---|
size
¶
Run the smu.measure.configlist.size() function.
Description
- This function returns the size (number of configuration indexes) of a measure configuration list.
TSP Syntax
- smu.measure.configlist.size()
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
store
¶
Run the smu.measure.configlist.store() function.
Description
- This function stores the active measure settings into the named configuration list.
TSP Syntax
- smu.measure.configlist.store()
| Parameters: |
|
|---|
| Raises: |
|
|---|
storefunc
¶
Run the smu.measure.configlist.storefunc() function.
Description
- This function allows you to store the settings for a measure function into a measure configuration list whether or not the function is active.
TSP Syntax
- smu.measure.configlist.storefunc()
| Parameters: |
|---|
| Raises: |
|
|---|
SmuMeasureFilter
¶
Bases: BaseTSPCmd
The smu.measure.filter command tree.
Properties and methods
.count: Thesmu.measure.filter.countattribute..enable: Thesmu.measure.filter.enableattribute..type: Thesmu.measure.filter.typeattribute.
count
property
writable
¶
count: str
Access the smu.measure.filter.count attribute.
Description
- This attribute sets the number of measurements that are averaged when filtering is enabled.
Usage
- Accessing this property will send the
print(smu.measure.filter.count)query. - Setting this property to a value will send the
smu.measure.filter.count = valuecommand.
TSP Syntax
- smu.measure.filter.count = value
- print(smu.measure.filter.count)
| Raises: |
|
|---|
enable
property
writable
¶
enable: str
Access the smu.measure.filter.enable attribute.
Description
- This attribute enables or disables the averaging filter for the selected measurement function.
Usage
- Accessing this property will send the
print(smu.measure.filter.enable)query. - Setting this property to a value will send the
smu.measure.filter.enable = valuecommand.
TSP Syntax
- smu.measure.filter.enable = value
- print(smu.measure.filter.enable)
| Raises: |
|
|---|
type
property
writable
¶
type: str
Access the smu.measure.filter.type attribute.
Description
- This attribute sets the type of averaging filter that is used for the selected measure function when the measurement filter is enabled.
Usage
- Accessing this property will send the
print(smu.measure.filter.type)query. - Setting this property to a value will send the
smu.measure.filter.type = valuecommand.
TSP Syntax
- smu.measure.filter.type = value
- print(smu.measure.filter.type)
| Raises: |
|
|---|
SmuMeasureLimitItem
¶
Bases: ValidatedDynamicNumberCmd, BaseTSPCmd
The smu.measure.limit[Y] command tree.
Info
Y, the limit number: 1 or 2.
Properties and methods
.audible: Thesmu.measure.limit[Y].audibleattribute..autoclear: Thesmu.measure.limit[Y].autoclearattribute..clear(): Thesmu.measure.limit[Y].clear()function..enable: Thesmu.measure.limit[Y].enableattribute..fail: Thesmu.measure.limit[Y].failattribute..high: Thesmu.measure.limit[Y].highcommand tree..low: Thesmu.measure.limit[Y].lowcommand tree.
audible
property
writable
¶
audible: str
Access the smu.measure.limit[Y].audible attribute.
Description
- This attribute determines if the instrument beeper sounds when a limit test passes or fails.
Usage
- Accessing this property will send the
print(smu.measure.limit[Y].audible)query. - Setting this property to a value will send the
smu.measure.limit[Y].audible = valuecommand.
TSP Syntax
- smu.measure.limit[Y].audible = value
- print(smu.measure.limit[Y].audible)
Info
Y, the limit number: 1 or 2.
| Raises: |
|
|---|
autoclear
property
writable
¶
autoclear: str
Access the smu.measure.limit[Y].autoclear attribute.
Description
- This attribute indicates if the test result for limit Y should be cleared automatically or not.
Usage
- Accessing this property will send the
print(smu.measure.limit[Y].autoclear)query. - Setting this property to a value will send the
smu.measure.limit[Y].autoclear = valuecommand.
TSP Syntax
- smu.measure.limit[Y].autoclear = value
- print(smu.measure.limit[Y].autoclear)
Info
Y, the limit number: 1 or 2.
| Raises: |
|
|---|
enable
property
writable
¶
enable: str
Access the smu.measure.limit[Y].enable attribute.
Description
- This attribute enables or disables a limit test on the measurement from the selected measure function.
Usage
- Accessing this property will send the
print(smu.measure.limit[Y].enable)query. - Setting this property to a value will send the
smu.measure.limit[Y].enable = valuecommand.
TSP Syntax
- smu.measure.limit[Y].enable = value
- print(smu.measure.limit[Y].enable)
Info
Y, the limit number: 1 or 2.
| Raises: |
|
|---|
fail
property
¶
fail: str
Access the smu.measure.limit[Y].fail attribute.
Description
- This attribute queries the results of a limit test.
Usage
- Accessing this property will send the
print(smu.measure.limit[Y].fail)query.
TSP Syntax
- print(smu.measure.limit[Y].fail)
Info
Y, the limit number: 1 or 2.
| Raises: |
|
|---|
high
property
¶
high: SmuMeasureLimitItemHigh
Return the smu.measure.limit[Y].high command tree.
Info
Y, the limit number: 1 or 2.
Sub-properties and sub-methods
.value: Thesmu.measure.limit[Y].high.valueattribute.
low
property
¶
Return the smu.measure.limit[Y].low command tree.
Info
Y, the limit number: 1 or 2.
Sub-properties and sub-methods
.value: Thesmu.measure.limit[Y].low.valueattribute.
clear
¶
clear() -> None
Run the smu.measure.limit[Y].clear() function.
Description
- This function clears the results of the limit test defined by Y for the selected measurement function.
TSP Syntax
- smu.measure.limit[Y].clear()
Info
Y, the limit number: 1 or 2.
| Raises: |
|
|---|
SmuMeasureLimitItemHigh
¶
Bases: BaseTSPCmd
The smu.measure.limit[Y].high command tree.
Info
Y, the limit number: 1 or 2.
Properties and methods
.value: Thesmu.measure.limit[Y].high.valueattribute.
value
property
writable
¶
value: str
Access the smu.measure.limit[Y].high.value attribute.
Description
- This attribute specifies the upper limit for a limit test.
Usage
- Accessing this property will send the
print(smu.measure.limit[Y].high.value)query. - Setting this property to a value will send the
smu.measure.limit[Y].high.value = valuecommand.
TSP Syntax
- smu.measure.limit[Y].high.value = value
- print(smu.measure.limit[Y].high.value)
Info
Y, the limit number: 1 or 2.
| Raises: |
|
|---|
SmuMeasureLimitItemLow
¶
Bases: BaseTSPCmd
The smu.measure.limit[Y].low command tree.
Info
Y, the limit number: 1 or 2.
Properties and methods
.value: Thesmu.measure.limit[Y].low.valueattribute.
value
property
writable
¶
value: str
Access the smu.measure.limit[Y].low.value attribute.
Description
- This attribute specifies the lower limit for a limit test.
Usage
- Accessing this property will send the
print(smu.measure.limit[Y].low.value)query. - Setting this property to a value will send the
smu.measure.limit[Y].low.value = valuecommand.
TSP Syntax
- smu.measure.limit[Y].low.value = value
- print(smu.measure.limit[Y].low.value)
Info
Y, the limit number: 1 or 2.
| Raises: |
|
|---|
SmuMeasureMath
¶
Bases: BaseTSPCmd
The smu.measure.math command tree.
Properties and methods
.enable: Thesmu.measure.math.enableattribute..format: Thesmu.measure.math.formatattribute..mxb: Thesmu.measure.math.mxbcommand tree..percent: Thesmu.measure.math.percentattribute.
enable
property
writable
¶
enable: str
Access the smu.measure.math.enable attribute.
Description
- This attribute enables or disables math operations on measurements for the selected measurement function.
Usage
- Accessing this property will send the
print(smu.measure.math.enable)query. - Setting this property to a value will send the
smu.measure.math.enable = valuecommand.
TSP Syntax
- smu.measure.math.enable = value
- print(smu.measure.math.enable)
| Raises: |
|
|---|
format
property
writable
¶
format: str
Access the smu.measure.math.format attribute.
Description
- This attribute specifies which math operation is performed on measurements when math operations are enabled.
Usage
- Accessing this property will send the
print(smu.measure.math.format)query. - Setting this property to a value will send the
smu.measure.math.format = valuecommand.
TSP Syntax
- smu.measure.math.format = value
- print(smu.measure.math.format)
| Raises: |
|
|---|
mxb
property
¶
mxb: SmuMeasureMathMxb
Return the smu.measure.math.mxb command tree.
Sub-properties and sub-methods
.bfactor: Thesmu.measure.math.mxb.bfactorattribute..mfactor: Thesmu.measure.math.mxb.mfactorattribute.
percent
property
writable
¶
percent: str
Access the smu.measure.math.percent attribute.
Description
- This attribute specifies the reference constant that is used when math operations are set to percent.
Usage
- Accessing this property will send the
print(smu.measure.math.percent)query. - Setting this property to a value will send the
smu.measure.math.percent = valuecommand.
TSP Syntax
- smu.measure.math.percent = value
- print(smu.measure.math.percent)
| Raises: |
|
|---|
SmuMeasureMathMxb
¶
Bases: BaseTSPCmd
The smu.measure.math.mxb command tree.
Properties and methods
.bfactor: Thesmu.measure.math.mxb.bfactorattribute..mfactor: Thesmu.measure.math.mxb.mfactorattribute.
bfactor
property
writable
¶
bfactor: str
Access the smu.measure.math.mxb.bfactor attribute.
Description
- This attribute specifies the offset, b, for the y = mx + b operation.
Usage
- Accessing this property will send the
print(smu.measure.math.mxb.bfactor)query. - Setting this property to a value will send the
smu.measure.math.mxb.bfactor = valuecommand.
TSP Syntax
- smu.measure.math.mxb.bfactor = value
- print(smu.measure.math.mxb.bfactor)
| Raises: |
|
|---|
mfactor
property
writable
¶
mfactor: str
Access the smu.measure.math.mxb.mfactor attribute.
Description
- This attribute specifies the scale factor, m, for the y = mx + b math operation.
Usage
- Accessing this property will send the
print(smu.measure.math.mxb.mfactor)query. - Setting this property to a value will send the
smu.measure.math.mxb.mfactor = valuecommand.
TSP Syntax
- smu.measure.math.mxb.mfactor = value
- print(smu.measure.math.mxb.mfactor)
| Raises: |
|
|---|
SmuMeasureRel
¶
Bases: BaseTSPCmd
The smu.measure.rel command tree.
Properties and methods
.acquire(): Thesmu.measure.rel.acquire()function..enable: Thesmu.measure.rel.enableattribute..level: Thesmu.measure.rel.levelattribute.
enable
property
writable
¶
enable: str
Access the smu.measure.rel.enable attribute.
Description
- This attribute enables or disables the application of a relative offset value to the measurement.
Usage
- Accessing this property will send the
print(smu.measure.rel.enable)query. - Setting this property to a value will send the
smu.measure.rel.enable = valuecommand.
TSP Syntax
- smu.measure.rel.enable = value
- print(smu.measure.rel.enable)
| Raises: |
|
|---|
level
property
writable
¶
level: str
Access the smu.measure.rel.level attribute.
Description
- This attribute contains the relative offset value.
Usage
- Accessing this property will send the
print(smu.measure.rel.level)query. - Setting this property to a value will send the
smu.measure.rel.level = valuecommand.
TSP Syntax
- smu.measure.rel.level = value
- print(smu.measure.rel.level)
| Raises: |
|
|---|
acquire
¶
acquire() -> str
Run the smu.measure.rel.acquire() function.
Description
- This function acquires a measurement and stores it as the relative offset value.
TSP Syntax
- smu.measure.rel.acquire()
| Returns: |
|
|---|
| Raises: |
|
|---|
SmuSource
¶
Bases: BaseTSPCmd
The smu.source command tree.
Properties and methods
.autodelay: Thesmu.source.autodelayattribute..autorange: Thesmu.source.autorangeattribute..configlist: Thesmu.source.configlistcommand tree..delay: Thesmu.source.delayattribute..func: Thesmu.source.funcattribute..getattribute(): Thesmu.source.getattribute()function..highc: Thesmu.source.highcattribute..level: Thesmu.source.levelattribute..offmode: Thesmu.source.offmodeattribute..output: Thesmu.source.outputattribute..protect: Thesmu.source.protectcommand tree..range: Thesmu.source.rangeattribute..readback: Thesmu.source.readbackattribute..setattribute(): Thesmu.source.setattribute()function..sweeplinear(): Thesmu.source.sweeplinear()function..sweeplinearstep(): Thesmu.source.sweeplinearstep()function..sweeplist(): Thesmu.source.sweeplist()function..sweeplog(): Thesmu.source.sweeplog()function..userdelay: Thesmu.source.userdelay[N]attribute..ilimit: Thesmu.source.ilimitcommand tree..vlimit: Thesmu.source.vlimitcommand tree.
autodelay
property
writable
¶
autodelay: str
Access the smu.source.autodelay attribute.
Description
- This attribute enables or disables the automatic delay that occurs when the source is turned on.
Usage
- Accessing this property will send the
print(smu.source.autodelay)query. - Setting this property to a value will send the
smu.source.autodelay = valuecommand.
TSP Syntax
- smu.source.autodelay = value
- print(smu.source.autodelay)
| Raises: |
|
|---|
autorange
property
writable
¶
autorange: str
Access the smu.source.autorange attribute.
Description
- This attribute determines if the range is selected manually or automatically for the selected source function or voltage source.
Usage
- Accessing this property will send the
print(smu.source.autorange)query. - Setting this property to a value will send the
smu.source.autorange = valuecommand.
TSP Syntax
- smu.source.autorange = value
- print(smu.source.autorange)
| Raises: |
|
|---|
configlist
property
¶
configlist: SmuSourceConfiglist
Return the smu.source.configlist command tree.
Sub-properties and sub-methods
.catalog(): Thesmu.source.configlist.catalog()function..create(): Thesmu.source.configlist.create()function..delete(): Thesmu.source.configlist.delete()function..query(): Thesmu.source.configlist.query()function..recall(): Thesmu.source.configlist.recall()function..size(): Thesmu.source.configlist.size()function..store(): Thesmu.source.configlist.store()function..storefunc(): Thesmu.source.configlist.storefunc()function.
delay
property
writable
¶
delay: str
Access the smu.source.delay attribute.
Description
- This attribute contains the source delay.
Usage
- Accessing this property will send the
print(smu.source.delay)query. - Setting this property to a value will send the
smu.source.delay = valuecommand.
TSP Syntax
- smu.source.delay = value
- print(smu.source.delay)
| Raises: |
|
|---|
func
property
writable
¶
func: str
Access the smu.source.func attribute.
Description
- This attribute contains the source function, which can be voltage or current.
Usage
- Accessing this property will send the
print(smu.source.func)query. - Setting this property to a value will send the
smu.source.func = valuecommand.
TSP Syntax
- smu.source.func = value
- print(smu.source.func)
| Raises: |
|
|---|
highc
property
writable
¶
highc: str
Access the smu.source.highc attribute.
Description
- This attribute enables or disables high-capacitance mode.
Usage
- Accessing this property will send the
print(smu.source.highc)query. - Setting this property to a value will send the
smu.source.highc = valuecommand.
TSP Syntax
- smu.source.highc = value
- print(smu.source.highc)
| Raises: |
|
|---|
ilimit
property
¶
ilimit: SmuSourceIlimit
Return the smu.source.ilimit command tree.
Sub-properties and sub-methods
.level: Thesmu.source.ilimit.levelattribute..tripped: Thesmu.source.ilimit.trippedattribute.
level
property
writable
¶
level: str
Access the smu.source.level attribute.
Description
- This attribute immediately selects a fixed amplitude for the selected source function.
Usage
- Accessing this property will send the
print(smu.source.level)query. - Setting this property to a value will send the
smu.source.level = valuecommand.
TSP Syntax
- smu.source.level = value
- print(smu.source.level)
| Raises: |
|
|---|
offmode
property
writable
¶
offmode: str
Access the smu.source.offmode attribute.
Description
- This attribute defines the state of the source when the output is turned off.
Usage
- Accessing this property will send the
print(smu.source.offmode)query. - Setting this property to a value will send the
smu.source.offmode = valuecommand.
TSP Syntax
- smu.source.offmode = value
- print(smu.source.offmode)
| Raises: |
|
|---|
output
property
writable
¶
output: str
Access the smu.source.output attribute.
Description
- This attribute enables or disables the source output.
Usage
- Accessing this property will send the
print(smu.source.output)query. - Setting this property to a value will send the
smu.source.output = valuecommand.
TSP Syntax
- smu.source.output = value
- print(smu.source.output)
| Raises: |
|
|---|
protect
property
¶
protect: SmuSourceProtect
Return the smu.source.protect command tree.
Sub-properties and sub-methods
.level: Thesmu.source.protect.levelattribute..tripped: Thesmu.source.protect.trippedattribute.
range
property
writable
¶
range: str
Access the smu.source.range attribute.
Description
- This attribute selects the range for the source for the selected source function.
Usage
- Accessing this property will send the
print(smu.source.range)query. - Setting this property to a value will send the
smu.source.range = valuecommand.
TSP Syntax
- smu.source.range = value
- print(smu.source.range)
| Raises: |
|
|---|
readback
property
writable
¶
readback: str
Access the smu.source.readback attribute.
Description
- This attribute determines if the instrument records the measured source value or the configured source value when making a measurement.
Usage
- Accessing this property will send the
print(smu.source.readback)query. - Setting this property to a value will send the
smu.source.readback = valuecommand.
TSP Syntax
- smu.source.readback = value
- print(smu.source.readback)
| Raises: |
|
|---|
userdelay
property
¶
Access the smu.source.userdelay[N] attribute.
Description
- This attribute sets a user-defined delay that you can use in the trigger model.
Usage
- Accessing an item from this property will send the
print(smu.source.userdelay[N])query. - Setting an item from this property to a value will send the
smu.source.userdelay[N] = valuecommand.
TSP Syntax
- smu.source.userdelay[N] = value
- print(smu.source.userdelay[N])
Info
N, the number that identifies this user delay (1 to 5).
| Raises: |
|
|---|
vlimit
property
¶
vlimit: SmuSourceVlimit
Return the smu.source.vlimit command tree.
Sub-properties and sub-methods
.level: Thesmu.source.vlimit.levelattribute..tripped: Thesmu.source.vlimit.trippedattribute.
getattribute
¶
Run the smu.source.getattribute() function.
Description
- This function returns the setting for a function attribute.
TSP Syntax
- smu.source.getattribute()
| Parameters: |
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
setattribute
¶
Run the smu.source.setattribute() function.
Description
- This function allows you to set up a source function whether or not the function is active.
TSP Syntax
- smu.source.setattribute()
| Parameters: |
|---|
| Raises: |
|
|---|
sweeplinear
¶
sweeplinear(
config_list_name: str,
start: float,
stop: float,
points: int,
s_delay: float | None = None,
count: int | None = None,
range_type: str | None = None,
fail_abort: str | None = None,
dual: str | None = None,
buffer_name: str | None = None,
) -> None
Run the smu.source.sweeplinear() function.
Description
- This function sets up a linear sweep for a fixed number of measurement points.
TSP Syntax
- smu.source.sweeplinear()
| Parameters: |
|
|---|
| Raises: |
|
|---|
sweeplinearstep
¶
sweeplinearstep(
config_list_name: str,
start: float,
stop: float,
step: str,
s_delay: float | None = None,
count: int | None = None,
range_type: str | None = None,
fail_abort: str | None = None,
dual: str | None = None,
buffer_name: str | None = None,
) -> None
Run the smu.source.sweeplinearstep() function.
Description
- This function sets up a linear source sweep configuration list and trigger model with a fixed number of steps.
TSP Syntax
- smu.source.sweeplinearstep()
| Parameters: |
|
|---|
| Raises: |
|
|---|
sweeplist
¶
sweeplist(
config_list_name: str,
index: int | None = None,
s_delay: float | None = None,
count: int | None = None,
fail_abort: str | None = None,
buffer_name: str | None = None,
) -> None
Run the smu.source.sweeplist() function.
Description
- This function sets up a sweep based on a configuration list, which allows you to customize the sweep.
TSP Syntax
- smu.source.sweeplist()
| Parameters: |
|
|---|
| Raises: |
|
|---|
sweeplog
¶
sweeplog(
config_list_name: str,
start: float,
stop: float,
points: int,
s_delay: float | None = None,
count: int | None = None,
range_type: str | None = None,
fail_abort: str | None = None,
dual: str | None = None,
buffer_name: str | None = None,
asymptote: str | None = None,
) -> None
Run the smu.source.sweeplog() function.
Description
- This function sets up a logarithmic sweep for a set number of measurement points.
TSP Syntax
- smu.source.sweeplog()
| Parameters: |
|
|---|
| Raises: |
|
|---|
SmuSourceConfiglist
¶
Bases: BaseTSPCmd
The smu.source.configlist command tree.
Properties and methods
.catalog(): Thesmu.source.configlist.catalog()function..create(): Thesmu.source.configlist.create()function..delete(): Thesmu.source.configlist.delete()function..query(): Thesmu.source.configlist.query()function..recall(): Thesmu.source.configlist.recall()function..size(): Thesmu.source.configlist.size()function..store(): Thesmu.source.configlist.store()function..storefunc(): Thesmu.source.configlist.storefunc()function.
catalog
¶
catalog() -> str
Run the smu.source.configlist.catalog() function.
Description
- This function returns the name of one source configuration list.
TSP Syntax
- smu.source.configlist.catalog()
| Returns: |
|
|---|
| Raises: |
|
|---|
create
¶
create(list_name: str) -> None
Run the smu.source.configlist.create() function.
Description
- This function creates an empty source configuration list.
TSP Syntax
- smu.source.configlist.create()
| Parameters: |
|
|---|
| Raises: |
|
|---|
delete
¶
Run the smu.source.configlist.delete() function.
Description
- This function deletes a source configuration list.
TSP Syntax
- smu.source.configlist.delete()
| Parameters: |
|
|---|
| Raises: |
|
|---|
query
¶
Run the smu.source.configlist.query() function.
Description
- This function returns a list of TSP commands and parameter settings that are stored in the specified configuration index.
TSP Syntax
- smu.source.configlist.query()
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
recall
¶
recall(
list_name: str,
index: int,
measure_list_name: str | None = None,
measure_index: float | None = None,
) -> None
Run the smu.source.configlist.recall() function.
Description
- This function recalls a specific configuration index in a specific source configuration list and an optional measure configuration list.
TSP Syntax
- smu.source.configlist.recall()
| Parameters: |
|
|---|
| Raises: |
|
|---|
size
¶
Run the smu.source.configlist.size() function.
Description
- This function returns the number of configuration indexes in a source configuration list.
TSP Syntax
- smu.source.configlist.size()
| Parameters: |
|
|---|
| Returns: |
|
|---|
| Raises: |
|
|---|
store
¶
Run the smu.source.configlist.store() function.
Description
- This function stores the active source settings into the named configuration list.
TSP Syntax
- smu.source.configlist.store()
| Parameters: |
|
|---|
| Raises: |
|
|---|
storefunc
¶
Run the smu.source.configlist.storefunc() function.
Description
- This function allows you to store the settings for a source function into a source configuration list whether or not the function is active.
TSP Syntax
- smu.source.configlist.storefunc()
| Parameters: |
|---|
| Raises: |
|
|---|
SmuSourceIlimit
¶
Bases: BaseTSPCmd
The smu.source.ilimit command tree.
Properties and methods
.level: Thesmu.source.ilimit.levelattribute..tripped: Thesmu.source.ilimit.trippedattribute.
level
property
writable
¶
level: str
Access the smu.source.ilimit.level attribute.
Description
- This attribute selects the source limit for measurements. (current)
Usage
- Accessing this property will send the
print(smu.source.ilimit.level)query. - Setting this property to a value will send the
smu.source.ilimit.level = valuecommand.
TSP Syntax
- smu.source.ilimit.level = value
- print(smu.source.ilimit.level)
| Raises: |
|
|---|
tripped
property
¶
tripped: str
Access the smu.source.ilimit.tripped attribute.
Description
- This attribute indicates if the source exceeded the limits that were set for the selected measurements. (current)
Usage
- Accessing this property will send the
print(smu.source.ilimit.tripped)query.
TSP Syntax
- print(smu.source.ilimit.tripped)
| Raises: |
|
|---|
SmuSourceProtect
¶
Bases: BaseTSPCmd
The smu.source.protect command tree.
Properties and methods
.level: Thesmu.source.protect.levelattribute..tripped: Thesmu.source.protect.trippedattribute.
level
property
writable
¶
level: str
Access the smu.source.protect.level attribute.
Description
- This attribute sets the overvoltage protection setting of the source output.
Usage
- Accessing this property will send the
print(smu.source.protect.level)query. - Setting this property to a value will send the
smu.source.protect.level = valuecommand.
TSP Syntax
- smu.source.protect.level = value
- print(smu.source.protect.level)
| Raises: |
|
|---|
tripped
property
¶
tripped: str
Access the smu.source.protect.tripped attribute.
Description
- This attribute indicates if the overvoltage source protection feature is active.
Usage
- Accessing this property will send the
print(smu.source.protect.tripped)query.
TSP Syntax
- print(smu.source.protect.tripped)
| Raises: |
|
|---|
SmuSourceVlimit
¶
Bases: BaseTSPCmd
The smu.source.vlimit command tree.
Properties and methods
.level: Thesmu.source.vlimit.levelattribute..tripped: Thesmu.source.vlimit.trippedattribute.
level
property
writable
¶
level: str
Access the smu.source.vlimit.level attribute.
Description
- This attribute selects the source limit for measurements. (voltage)
Usage
- Accessing this property will send the
print(smu.source.vlimit.level)query. - Setting this property to a value will send the
smu.source.vlimit.level = valuecommand.
TSP Syntax
- smu.source.vlimit.level = value
- print(smu.source.vlimit.level)
| Raises: |
|
|---|
tripped
property
¶
tripped: str
Access the smu.source.vlimit.tripped attribute.
Description
- This attribute indicates if the source exceeded the limits that were set for the selected measurements. (voltage)
Usage
- Accessing this property will send the
print(smu.source.vlimit.tripped)query.
TSP Syntax
- print(smu.source.vlimit.tripped)
| Raises: |
|
|---|