smu ¶

The smu commands module.

These commands are used in the following models: MSMU60_2

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

Please report an issue if one is found.

Attributes and Functions

- smu[X].abort()
- smu[X].configlist.create()
- smu[X].configlist.delete()
- smu[X].configlist.query()
- smu[X].configlist.recall()
- smu[X].configlist.size()
- smu[X].configlist.store()
- smu[X].configlist.table()
- smu[X].contact.calibratehi()
- smu[X].contact.calibratelo()
- smu[X].contact.check()
- smu[X].contact.getcalhi()
- smu[X].contact.r()
- smu[X].contact.speed
- smu[X].contact.threshold
- smu[X].defbuffer1
- smu[X].defbuffer2
- smu[X].guard.v()
- smu[X].makebuffer()
- smu[X].measure.aperture
- smu[X].measure.autodelay
- smu[X].measure.autorangei
- smu[X].measure.autorangev
- smu[X].measure.count
- smu[X].measure.delay
- smu[X].measure.i()
- smu[X].measure.interval
- smu[X].measure.lowrangei
- smu[X].measure.lowrangev
- smu[X].measure.nplc
- smu[X].measure.overlappedi()
- smu[X].measure.overlappediv()
- smu[X].measure.overlappedp()
- smu[X].measure.overlappedr()
- smu[X].measure.overlappedv()
- smu[X].measure.p()
- smu[X].measure.r()
- smu[X].measure.rangei
- smu[X].measure.rangev
- smu[X].measure.rel.enablei
- smu[X].measure.rel.enablep
- smu[X].measure.rel.enabler
- smu[X].measure.rel.enablev
- smu[X].measure.rel.leveli
- smu[X].measure.rel.levelp
- smu[X].measure.rel.levelr
- smu[X].measure.rel.levelv
- smu[X].measure.tempcomp
- smu[X].measure.v()
- smu[X].overlapped
- smu[X].reset()
- smu[X].sense
- smu[X].source.autodelay
- smu[X].source.autorangei
- smu[X].source.autorangev
- smu[X].source.constantcurrent
- smu[X].source.delay
- smu[X].source.func
- smu[X].source.leveli
- smu[X].source.levelv
- smu[X].source.limiti
- smu[X].source.limitni
- smu[X].source.limitnv
- smu[X].source.limitpi
- smu[X].source.limitpv
- smu[X].source.limitv
- smu[X].source.lowrangei
- smu[X].source.lowrangev
- smu[X].source.offfunc
- smu[X].source.offlimiti
- smu[X].source.offlimitni
- smu[X].source.offlimitnv
- smu[X].source.offlimitpi
- smu[X].source.offlimitpv
- smu[X].source.offlimitv
- smu[X].source.offmode
- smu[X].source.output
- smu[X].source.rangei
- smu[X].source.rangev
- smu[X].trigger.measure.i()
- smu[X].trigger.measure.iv()
- smu[X].trigger.measure.p()
- smu[X].trigger.measure.r()
- smu[X].trigger.measure.v()
- smu[X].trigger.source.lineari()
- smu[X].trigger.source.linearv()
- smu[X].trigger.source.listi()
- smu[X].trigger.source.listv()
- smu[X].trigger.source.logi()
- smu[X].trigger.source.logv()
- smu[X].waitcomplete()

SmuItem ¶

Bases: ValidatedDynamicNumberCmd, BaseTSPCmd

The smu[X] command tree.

Info

X, the module channel number.

Properties and methods

.abort(): The smu[X].abort() function.
.configlist: The smu[X].configlist command tree.
.contact: The smu[X].contact command tree.
.defbuffer1: The smu[X].defbuffer1 attribute.
.defbuffer2: The smu[X].defbuffer2 attribute.
.guard: The smu[X].guard command tree.
.makebuffer(): The smu[X].makebuffer() function.
.measure: The smu[X].measure command tree.
.overlapped: The smu[X].overlapped attribute.
.reset(): The smu[X].reset() function.
.sense: The smu[X].sense attribute.
.source: The smu[X].source command tree.
.trigger: The smu[X].trigger command tree.
.waitcomplete(): The smu[X].waitcomplete() function.

configlist `property` ¶

configlist: SmuItemConfiglist

Return the smu[X].configlist command tree.

Info

X, the module channel number.

Sub-properties and sub-methods

.create(): The smu[X].configlist.create() function.
.delete(): The smu[X].configlist.delete() function.
.query(): The smu[X].configlist.query() function.
.recall(): The smu[X].configlist.recall() function.
.size(): The smu[X].configlist.size() function.
.store(): The smu[X].configlist.store() function.
.table(): The smu[X].configlist.table() function.

contact `property` ¶

contact: SmuItemContact

Return the smu[X].contact command tree.

Info

X, the channel (1 or 2).

Sub-properties and sub-methods

.calibratehi(): The smu[X].contact.calibratehi() function.
.calibratelo(): The smu[X].contact.calibratelo() function.
.check(): The smu[X].contact.check() function.
.getcalhi(): The smu[X].contact.getcalhi() function.
.r(): The smu[X].contact.r() function.
.speed: The smu[X].contact.speed attribute.
.threshold: The smu[X].contact.threshold attribute.

defbuffer1 `cached` `property` ¶

defbuffer1: Buffervar

Access the smu[X].defbuffer1 attribute.

Description

This attribute contains the default dedicated reading buffers. (1 = default buffer1)

Usage

Accessing this property will send the print(smu[X].defbuffer1) query.

TSP Syntax

- print(smu[X].defbuffer1)

Returns:	`Buffervar` – The default buffer object.

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

defbuffer2 `cached` `property` ¶

defbuffer2: Buffervar

Access the smu[X].defbuffer2 attribute.

Description

This attribute contains the default dedicated reading buffers. (2 = default buffer2)

Usage

Accessing this property will send the print(smu[X].defbuffer2) query.

TSP Syntax

- print(smu[X].defbuffer2)

Returns:	`Buffervar` – The default buffer object.

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

guard `property` ¶

guard: SmuItemGuard

Return the smu[X].guard command tree.

Info

X, the module channel number.

Sub-properties and sub-methods

.v(): The smu[X].guard.v() function.

measure `property` ¶

measure: SmuItemMeasure

Return the smu[X].measure command tree.

Sub-properties and sub-methods

.i(): The smu[X].measure.i() function.
.p(): The smu[X].measure.p() function.
.r(): The smu[X].measure.r() function.
.v(): The smu[X].measure.v() function.
.aperture: The smu[X].measure.aperture attribute.
.autodelay: The smu[X].measure.autodelay attribute.
.autorangei: The smu[X].measure.autorangei attribute.
.autorangev: The smu[X].measure.autorangev attribute.
.count: The smu[X].measure.count attribute.
.delay: The smu[X].measure.delay attribute.
.interval: The smu[X].measure.interval attribute.
.lowrangei: The smu[X].measure.lowrangei attribute.
.lowrangev: The smu[X].measure.lowrangev attribute.
.nplc: The smu[X].measure.nplc attribute.
.overlappedi(): The smu[X].measure.overlappedi() function.
.overlappediv(): The smu[X].measure.overlappediv() function.
.overlappedp(): The smu[X].measure.overlappedp() function.
.overlappedr(): The smu[X].measure.overlappedr() function.
.overlappedv(): The smu[X].measure.overlappedv() function.
.rangei: The smu[X].measure.rangei attribute.
.rangev: The smu[X].measure.rangev attribute.
.rel: The smu[X].measure.rel command tree.
.tempcomp: The smu[X].measure.tempcomp attribute.

overlapped `property` `writable` ¶

overlapped: str

Access the smu[X].overlapped attribute.

Description

This attribute contains the state of the overlapped mode.

Usage

Accessing this property will send the print(smu[X].overlapped) query.
Setting this property to a value will send the smu[X].overlapped = value command.

TSP Syntax

- smu[X].overlapped = value
- print(smu[X].overlapped)

Info

X, the module channel number.

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

sense `property` `writable` ¶

sense: str

Access the smu[X].sense attribute.

Description

This attribute contains the state of the sense mode.

Usage

Accessing this property will send the print(smu[X].sense) query.
Setting this property to a value will send the smu[X].sense = value command.

TSP Syntax

- smu[X].sense = value
- print(smu[X].sense)

Info

X, the module channel number.

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

source `property` ¶

source: SmuItemSource

Return the smu[X].source command tree.

Info

X, the module channel number.

Sub-properties and sub-methods

.autodelay: The smu[X].source.autodelay attribute.
.autorangei: The smu[X].source.autorangei attribute.
.autorangev: The smu[X].source.autorangev attribute.
.constantcurrent: The smu[X].source.constantcurrent attribute.
.delay: The smu[X].source.delay attribute.
.func: The smu[X].source.func attribute.
.leveli: The smu[X].source.leveli attribute.
.levelv: The smu[X].source.levelv attribute.
.limiti: The smu[X].source.limiti attribute.
.limitv: The smu[X].source.limitv attribute.
.limitni: The smu[X].source.limitni attribute.
.limitnv: The smu[X].source.limitnv attribute.
.limitpi: The smu[X].source.limitpi attribute.
.limitpv: The smu[X].source.limitpv attribute.
.lowrangei: The smu[X].source.lowrangei attribute.
.lowrangev: The smu[X].source.lowrangev attribute.
.offfunc: The smu[X].source.offfunc attribute.
.offlimiti: The smu[X].source.offlimiti attribute.
.offlimitv: The smu[X].source.offlimitv attribute.
.offlimitni: The smu[X].source.offlimitni attribute.
.offlimitnv: The smu[X].source.offlimitnv attribute.
.offlimitpi: The smu[X].source.offlimitpi attribute.
.offlimitpv: The smu[X].source.offlimitpv attribute.
.offmode: The smu[X].source.offmode attribute.
.output: The smu[X].source.output attribute.
.rangei: The smu[X].source.rangei attribute.
.rangev: The smu[X].source.rangev attribute.

trigger `property` ¶

trigger: SmuItemTrigger

Return the smu[X].trigger command tree.

Sub-properties and sub-methods

.measure: The smu[X].trigger.measure command tree.
.source: The smu[X].trigger.source command tree.

abort ¶

abort() -> None

Run the smu[X].abort() function.

Description

This function terminates all overlapped operations on the specified channel.

TSP Syntax

- smu[X].abort()

Info

X, the module channel number.

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

makebuffer ¶

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

Run the smu[X].makebuffer() function.

Description

This function creates a reading buffer.

TSP Syntax

- smu[X].makebuffer()

Parameters:	`buffer_size` (`str`) – The size of the reading buffer. `buffer_name` (`optional`, default: `None` ) – The name of the buffer variable to create. If not provided, an auto-generated variable will be used.

Returns:	`Buffervar` – The created buffer object.

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

reset ¶

reset() -> None

Run the smu[X].reset() function.

Description

This function turns off the output and resets the commands that begin with smu [X]. to their default settings.

TSP Syntax

- smu[X].reset()

Info

X, the module channel number.

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

waitcomplete ¶

waitcomplete() -> None

Run the smu[X].waitcomplete() function.

Description

This function waits for all previously started overlapped commands to complete on the specified channel of a module.

TSP Syntax

- smu[X].waitcomplete()

Info

X, the module channel number.

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

SmuItemConfiglist ¶

Bases: BaseTSPCmd

The smu[X].configlist command tree.

Info

X, the module channel number.

Properties and methods

.create(): The smu[X].configlist.create() function.
.delete(): The smu[X].configlist.delete() function.
.query(): The smu[X].configlist.query() function.
.recall(): The smu[X].configlist.recall() function.
.size(): The smu[X].configlist.size() function.
.store(): The smu[X].configlist.store() function.
.table(): The smu[X].configlist.table() function.

create ¶

create(config_list_name: str) -> None

Run the smu[X].configlist.create() function.

Description

This function creates an empty configuration list.

TSP Syntax

- smu[X].configlist.create()

Parameters:	`config_list_name` (`str`) – A string that represents the name of a configuration list.

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

delete ¶

delete(config_list_name: str, index: int | None = None) -> None

Run the smu[X].configlist.delete() function.

Description

This function deletes a configuration list.

TSP Syntax

- smu[X].configlist.delete()

Parameters:	`config_list_name` (`str`) – A string that represents the name of a configuration list. `index` (`optional`, default: `None` ) – A number starting from 1 that defines a specific configuration index in the configuration list.

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

query ¶

query(config_list_name: str, index: int, field_separator: str | None = None) -> str

Run the smu[X].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[X].configlist.query()

Parameters:	`config_list_name` (`str`) – A string that represents the name of a measure configuration list. `index` (`int`) – A number starting from 1 that defines a specific configuration index in the configuration list. `field_separator` (`optional`, default: `None` ) – String that represents the separator for the data; use one of the following.

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

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

recall ¶

recall(config_list_name: str, index: int) -> None

Run the smu[X].configlist.recall() function.

Description

This function recalls a configuration index in a configuration list.

TSP Syntax

- smu[X].configlist.recall()

Parameters:	`config_list_name` (`str`) – A string that represents the name of a configuration list. `index` (`int`) – A number starting from 1 that defines a specific configuration index in the measure configuration list.

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

size ¶

size(config_list_name: str) -> str

Run the smu[X].configlist.size() function.

Description

This function returns the size (number of configuration indexes) of a configuration list.

TSP Syntax

- smu[X].configlist.size()

Parameters:	`config_list_name` (`str`) – A string that represents the name of a configuration list.

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

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

store ¶

store(config_list_name: str, index: int | None = None) -> None

Run the smu[X].configlist.store() function.

Description

This function stores the active settings into the named configuration list.

TSP Syntax

- smu[X].configlist.store()

Parameters:	`config_list_name` (`str`) – A string that represents the name of a configuration list. `index` (`optional`, default: `None` ) – A number starting from 1 that defines a specific configuration index in the configuration list. This parameter is optional.

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

table ¶

table() -> str

Run the smu[X].configlist.table() function.

Description

This function returns the name of one measure configuration lists that is stored on the instrument.

TSP Syntax

- smu[X].configlist.table()

Info

X, the module channel number.

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

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

SmuItemContact ¶

Bases: BaseTSPCmd

The smu[X].contact command tree.

Info

X, the channel (1 or 2).

Properties and methods

.calibratehi(): The smu[X].contact.calibratehi() function.
.calibratelo(): The smu[X].contact.calibratelo() function.
.check(): The smu[X].contact.check() function.
.getcalhi(): The smu[X].contact.getcalhi() function.
.r(): The smu[X].contact.r() function.
.speed: The smu[X].contact.speed attribute.
.threshold: The smu[X].contact.threshold attribute.

speed `property` `writable` ¶

speed: str

Access the smu[X].contact.speed attribute.

Description

This attribute sets the contact check measurement speed.

Usage

Accessing this property will send the print(smu[X].contact.speed) query.
Setting this property to a value will send the smu[X].contact.speed = value command.

TSP Syntax

- smu[X].contact.speed = value
- print(smu[X].contact.speed)

Info

X, the module channel number.

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

threshold `property` `writable` ¶

threshold: str

Access the smu[X].contact.threshold attribute.

Description

This attribute sets the contact check pass or fail threshold.

Usage

Accessing this property will send the print(smu[X].contact.threshold) query.
Setting this property to a value will send the smu[X].contact.threshold = value command.

TSP Syntax

- smu[X].contact.threshold = value
- print(smu[X].contact.threshold)

Info

X, the module channel number.

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

calibratehi ¶

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

Run the smu[X].contact.calibratehi() function.

Description

This function adjusts the high/sense high contact check measurement.

TSP Syntax

- smu[X].contact.calibratehi()

Parameters:	`cp1_measured` (`str`) – The value measured for point 1. `cp1_reference` (`str`) – The reference measurement for point 1 as measured externally. `cp2_measured` (`str`) – The value measured for point 2. `cp2_reference` (`str`) – The reference measurement for point 2 as measured externally.

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

calibratelo ¶

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

Run the smu[X].contact.calibratelo() function.

Description

This function adjusts the low/sense low contact check measurement.

TSP Syntax

- smu[X].contact.calibratelo()

Parameters:	`cp1_measured` (`str`) – The value measured for point 1. `cp1_reference` (`str`) – The reference measurement for point 1 as measured externally. `cp2_measured` (`str`) – The value measured for point 2. `cp2_reference` (`str`) – The reference measurement for point 2 as measured externally.

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

check ¶

check() -> str

Run the smu[X].contact.check() function.

Description

This function performs a contact check measurement and compares the result to the user-specified contact check threshold setting.

TSP Syntax

- smu[X].contact.check()

Info

X, the module channel number.

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

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

getcalhi ¶

getcalhi(range_: str) -> str

Run the smu[X].contact.getcalhi() function.

Description

This function returns the calibration constants used during the contact check hi measurement calculation.

TSP Syntax

- smu[X].contact.getcalhi()

Parameters:	`range_` (`str`) – Specifies the range to retrieve.

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

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

r ¶

r() -> str

Run the smu[X].contact.r() function.

Description

This function performs a contact check measurement and returns the measured contact resistances.

TSP Syntax

- smu[X].contact.r()

Info

X, the module channel number.

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

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

SmuItemGuard ¶

Bases: BaseTSPCmd

The smu[X].guard command tree.

Info

X, the module channel number.

Properties and methods

.v(): The smu[X].guard.v() function.

v ¶

v() -> str

Run the smu[X].guard.v() function.

Description

This function makes a guard voltage measurement.

TSP Syntax

- smu[X].guard.v()

Info

X, the module channel number.

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

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

SmuItemMeasure ¶

Bases: BaseTSPCmd

The smu[X].measure command tree.

Properties and methods

.i(): The smu[X].measure.i() function.
.p(): The smu[X].measure.p() function.
.r(): The smu[X].measure.r() function.
.v(): The smu[X].measure.v() function.
.aperture: The smu[X].measure.aperture attribute.
.autodelay: The smu[X].measure.autodelay attribute.
.autorangei: The smu[X].measure.autorangei attribute.
.autorangev: The smu[X].measure.autorangev attribute.
.count: The smu[X].measure.count attribute.
.delay: The smu[X].measure.delay attribute.
.interval: The smu[X].measure.interval attribute.
.lowrangei: The smu[X].measure.lowrangei attribute.
.lowrangev: The smu[X].measure.lowrangev attribute.
.nplc: The smu[X].measure.nplc attribute.
.overlappedi(): The smu[X].measure.overlappedi() function.
.overlappediv(): The smu[X].measure.overlappediv() function.
.overlappedp(): The smu[X].measure.overlappedp() function.
.overlappedr(): The smu[X].measure.overlappedr() function.
.overlappedv(): The smu[X].measure.overlappedv() function.
.rangei: The smu[X].measure.rangei attribute.
.rangev: The smu[X].measure.rangev attribute.
.rel: The smu[X].measure.rel command tree.
.tempcomp: The smu[X].measure.tempcomp attribute.

aperture `property` `writable` ¶

aperture: str

Access the smu[X].measure.aperture attribute.

Description

This attribute configures the measurement aperture for a channel in seconds.

Usage

Accessing this property will send the print(smu[X].measure.aperture) query.
Setting this property to a value will send the smu[X].measure.aperture = value command.

TSP Syntax

- smu[X].measure.aperture = value
- print(smu[X].measure.aperture)

Info

X, the module channel number.

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

autodelay `property` `writable` ¶

autodelay: str

Access the smu[X].measure.autodelay attribute.

Description

This attribute enables or disables the automatic measurement delay.

Usage

Accessing this property will send the print(smu[X].measure.autodelay) query.
Setting this property to a value will send the smu[X].measure.autodelay = value command.

TSP Syntax

- smu[X].measure.autodelay = value
- print(smu[X].measure.autodelay)

Info

X, the module channel number.

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

autorangei `property` `writable` ¶

autorangei: str

Access the smu[X].measure.autorangei attribute.

Description

This attribute contains the state of the measure autorange control (on or off). (i = current in amperes)

Usage

Accessing this property will send the print(smu[X].measure.autorangei) query.
Setting this property to a value will send the smu[X].measure.autorangei = value command.

TSP Syntax

- smu[X].measure.autorangei = value
- print(smu[X].measure.autorangei)

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

autorangev `property` `writable` ¶

autorangev: str

Access the smu[X].measure.autorangev attribute.

Description

This attribute contains the state of the measure autorange control (on or off). (v = voltage in volts)

Usage

Accessing this property will send the print(smu[X].measure.autorangev) query.
Setting this property to a value will send the smu[X].measure.autorangev = value command.

TSP Syntax

- smu[X].measure.autorangev = value
- print(smu[X].measure.autorangev)

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

count `property` `writable` ¶

count: str

Access the smu[X].measure.count attribute.

Description

This attribute sets the number of measurements performed when a measurement is requested.

Usage

Accessing this property will send the print(smu[X].measure.count) query.
Setting this property to a value will send the smu[X].measure.count = value command.

TSP Syntax

- smu[X].measure.count = value
- print(smu[X].measure.count)

Info

X, the module channel number.

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

delay `property` `writable` ¶

delay: str

Access the smu[X].measure.delay attribute.

Description

This attribute controls the measurement delay.

Usage

Accessing this property will send the print(smu[X].measure.delay) query.
Setting this property to a value will send the smu[X].measure.delay = value command.

TSP Syntax

- smu[X].measure.delay = value
- print(smu[X].measure.delay)

Info

X, the module channel number.

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

interval `property` `writable` ¶

interval: str

Access the smu[X].measure.interval attribute.

Description

This attribute sets the interval between multiple measurements.

Usage

Accessing this property will send the print(smu[X].measure.interval) query.
Setting this property to a value will send the smu[X].measure.interval = value command.

TSP Syntax

- smu[X].measure.interval = value
- print(smu[X].measure.interval)

Info

X, the module channel number.

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

lowrangei `property` `writable` ¶

lowrangei: str

Access the smu[X].measure.lowrangei attribute.

Description

This attribute sets the lowest measurement range to be used when the instrument is autoranging. (i = current in amperes)

Usage

Accessing this property will send the print(smu[X].measure.lowrangei) query.
Setting this property to a value will send the smu[X].measure.lowrangei = value command.

TSP Syntax

- smu[X].measure.lowrangei = value
- print(smu[X].measure.lowrangei)

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

lowrangev `property` `writable` ¶

lowrangev: str

Access the smu[X].measure.lowrangev attribute.

Description

This attribute sets the lowest measurement range to be used when the instrument is autoranging. (v = voltage in volts)

Usage

Accessing this property will send the print(smu[X].measure.lowrangev) query.
Setting this property to a value will send the smu[X].measure.lowrangev = value command.

TSP Syntax

- smu[X].measure.lowrangev = value
- print(smu[X].measure.lowrangev)

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

nplc `property` `writable` ¶

nplc: str

Access the smu[X].measure.nplc attribute.

Description

This command sets the time that the input signal is measured in number of power line cycles.

Usage

Accessing this property will send the print(smu[X].measure.nplc) query.
Setting this property to a value will send the smu[X].measure.nplc = value command.

TSP Syntax

- smu[X].measure.nplc = value
- print(smu[X].measure.nplc)

Info

X, the module channel number.

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

rangei `property` ¶

rangei: str

Access the smu[X].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(smu[X].measure.rangei) query.

TSP Syntax

- print(smu[X].measure.rangei)

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

rangev `property` ¶

rangev: str

Access the smu[X].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(smu[X].measure.rangev) query.

TSP Syntax

- print(smu[X].measure.rangev)

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

rel `property` ¶

rel: SmuItemMeasureRel

Return the smu[X].measure.rel command tree.

Sub-properties and sub-methods

.enablei: The smu[X].measure.rel.enablei attribute.
.enablep: The smu[X].measure.rel.enablep attribute.
.enabler: The smu[X].measure.rel.enabler attribute.
.enablev: The smu[X].measure.rel.enablev attribute.
.leveli: The smu[X].measure.rel.leveli attribute.
.levelp: The smu[X].measure.rel.levelp attribute.
.levelr: The smu[X].measure.rel.levelr attribute.
.levelv: The smu[X].measure.rel.levelv attribute.

tempcomp `property` `writable` ¶

tempcomp: str

Access the smu[X].measure.tempcomp attribute.

Description

This attribute turns temperature compensation on or off for the current measurements.

Usage

Accessing this property will send the print(smu[X].measure.tempcomp) query.
Setting this property to a value will send the smu[X].measure.tempcomp = value command.

TSP Syntax

- smu[X].measure.tempcomp = value
- print(smu[X].measure.tempcomp)

Info

X, the module channel number.

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

i ¶

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

Run the smu[X].measure.i() function.

Description

This function makes one or more measurements. (i = current in amperes)

TSP Syntax

- smu[X].measure.i()

Parameters:	`reading_buffer` (`optional`, default: `None` ) – Reading buffer where the readings are stored; can be a dynamically allocated user-defined buffer or a dedicated reading buffer.

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

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

overlappedi ¶

overlappedi(rbuffer: str) -> None

Run the smu[X].measure.overlappedi() function.

Description

This function starts an asynchronous (background) measurement. (i = current in amperes)

TSP Syntax

- smu[X].measure.overlappedi()

Parameters:	`rbuffer` (`str`) – A reading buffer object where readings are stored.

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

overlappediv ¶

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

Run the smu[X].measure.overlappediv() function.

Description

This function starts an asynchronous (background) measurement. (i = current in amperes, v = voltage in volts)

TSP Syntax

- smu[X].measure.overlappediv()

Parameters:	`ibuffer` (`str`) – A reading buffer object where current readings are stored. `vbuffer` (`str`) – A reading buffer object where voltage readings are stored.

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

overlappedp ¶

overlappedp(rbuffer: str) -> None

Run the smu[X].measure.overlappedp() function.

Description

This function starts an asynchronous (background) measurement. (p = power in watts)

TSP Syntax

- smu[X].measure.overlappedp()

Parameters:	`rbuffer` (`str`) – A reading buffer object where readings are stored.

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

overlappedr ¶

overlappedr(rbuffer: str) -> None

Run the smu[X].measure.overlappedr() function.

Description

This function starts an asynchronous (background) measurement. (r = resistance in ohms)

TSP Syntax

- smu[X].measure.overlappedr()

Parameters:	`rbuffer` (`str`) – A reading buffer object where readings are stored.

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

overlappedv ¶

overlappedv(rbuffer: str) -> None

Run the smu[X].measure.overlappedv() function.

Description

This function starts an asynchronous (background) measurement. (v = voltage in volts)

TSP Syntax

- smu[X].measure.overlappedv()

Parameters:	`rbuffer` (`str`) – A reading buffer object where readings are stored.

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

p ¶

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

Run the smu[X].measure.p() function.

Description

This function makes one or more measurements. (p = power in watts)

TSP Syntax

- smu[X].measure.p()

Parameters:	`reading_buffer` (`optional`, default: `None` ) – Reading buffer where the readings are stored; can be a dynamically allocated user-defined buffer or a dedicated reading buffer.

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

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

r ¶

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

Run the smu[X].measure.r() function.

Description

This function makes one or more measurements. (r = resistance in ohms)

TSP Syntax

- smu[X].measure.r()

Parameters:	`reading_buffer` (`optional`, default: `None` ) – Reading buffer where the readings are stored; can be a dynamically allocated user-defined buffer or a dedicated reading buffer.

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

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

v ¶

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

Run the smu[X].measure.v() function.

Description

This function makes one or more measurements. (v = voltage in volts)

TSP Syntax

- smu[X].measure.v()

Parameters:	`reading_buffer` (`optional`, default: `None` ) – Reading buffer where the readings are stored; can be a dynamically allocated user-defined buffer or a dedicated reading buffer.

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

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

SmuItemMeasureRel ¶

Bases: BaseTSPCmd

The smu[X].measure.rel command tree.

Properties and methods

.enablei: The smu[X].measure.rel.enablei attribute.
.enablep: The smu[X].measure.rel.enablep attribute.
.enabler: The smu[X].measure.rel.enabler attribute.
.enablev: The smu[X].measure.rel.enablev attribute.
.leveli: The smu[X].measure.rel.leveli attribute.
.levelp: The smu[X].measure.rel.levelp attribute.
.levelr: The smu[X].measure.rel.levelr attribute.
.levelv: The smu[X].measure.rel.levelv attribute.

enablei `property` `writable` ¶

enablei: str

Access the smu[X].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(smu[X].measure.rel.enablei) query.
Setting this property to a value will send the smu[X].measure.rel.enablei = value command.

TSP Syntax

- smu[X].measure.rel.enablei = value
- print(smu[X].measure.rel.enablei)

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

enablep `property` `writable` ¶

enablep: str

Access the smu[X].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(smu[X].measure.rel.enablep) query.
Setting this property to a value will send the smu[X].measure.rel.enablep = value command.

TSP Syntax

- smu[X].measure.rel.enablep = value
- print(smu[X].measure.rel.enablep)

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

enabler `property` `writable` ¶

enabler: str

Access the smu[X].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(smu[X].measure.rel.enabler) query.
Setting this property to a value will send the smu[X].measure.rel.enabler = value command.

TSP Syntax

- smu[X].measure.rel.enabler = value
- print(smu[X].measure.rel.enabler)

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

enablev `property` `writable` ¶

enablev: str

Access the smu[X].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(smu[X].measure.rel.enablev) query.
Setting this property to a value will send the smu[X].measure.rel.enablev = value command.

TSP Syntax

- smu[X].measure.rel.enablev = value
- print(smu[X].measure.rel.enablev)

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

leveli `property` `writable` ¶

leveli: str

Access the smu[X].measure.rel.leveli attribute.

Description

This attribute specifies the offset value for relative measurements. (i = current in amperes)

Usage

Accessing this property will send the print(smu[X].measure.rel.leveli) query.
Setting this property to a value will send the smu[X].measure.rel.leveli = value command.

TSP Syntax

- smu[X].measure.rel.leveli = value
- print(smu[X].measure.rel.leveli)

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

levelp `property` `writable` ¶

levelp: str

Access the smu[X].measure.rel.levelp attribute.

Description

This attribute specifies the offset value for relative measurements. (p = power in watts)

Usage

Accessing this property will send the print(smu[X].measure.rel.levelp) query.
Setting this property to a value will send the smu[X].measure.rel.levelp = value command.

TSP Syntax

- smu[X].measure.rel.levelp = value
- print(smu[X].measure.rel.levelp)

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

levelr `property` `writable` ¶

levelr: str

Access the smu[X].measure.rel.levelr attribute.

Description

This attribute specifies the offset value for relative measurements. (r = resistance in ohms)

Usage

Accessing this property will send the print(smu[X].measure.rel.levelr) query.
Setting this property to a value will send the smu[X].measure.rel.levelr = value command.

TSP Syntax

- smu[X].measure.rel.levelr = value
- print(smu[X].measure.rel.levelr)

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

levelv `property` `writable` ¶

levelv: str

Access the smu[X].measure.rel.levelv attribute.

Description

This attribute specifies the offset value for relative measurements. (v = voltage in volts)

Usage

Accessing this property will send the print(smu[X].measure.rel.levelv) query.
Setting this property to a value will send the smu[X].measure.rel.levelv = value command.

TSP Syntax

- smu[X].measure.rel.levelv = value
- print(smu[X].measure.rel.levelv)

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

SmuItemSource ¶

Bases: BaseTSPCmd

The smu[X].source command tree.

Info

X, the module channel number.

Properties and methods

.autodelay: The smu[X].source.autodelay attribute.
.autorangei: The smu[X].source.autorangei attribute.
.autorangev: The smu[X].source.autorangev attribute.
.constantcurrent: The smu[X].source.constantcurrent attribute.
.delay: The smu[X].source.delay attribute.
.func: The smu[X].source.func attribute.
.leveli: The smu[X].source.leveli attribute.
.levelv: The smu[X].source.levelv attribute.
.limiti: The smu[X].source.limiti attribute.
.limitv: The smu[X].source.limitv attribute.
.limitni: The smu[X].source.limitni attribute.
.limitnv: The smu[X].source.limitnv attribute.
.limitpi: The smu[X].source.limitpi attribute.
.limitpv: The smu[X].source.limitpv attribute.
.lowrangei: The smu[X].source.lowrangei attribute.
.lowrangev: The smu[X].source.lowrangev attribute.
.offfunc: The smu[X].source.offfunc attribute.
.offlimiti: The smu[X].source.offlimiti attribute.
.offlimitv: The smu[X].source.offlimitv attribute.
.offlimitni: The smu[X].source.offlimitni attribute.
.offlimitnv: The smu[X].source.offlimitnv attribute.
.offlimitpi: The smu[X].source.offlimitpi attribute.
.offlimitpv: The smu[X].source.offlimitpv attribute.
.offmode: The smu[X].source.offmode attribute.
.output: The smu[X].source.output attribute.
.rangei: The smu[X].source.rangei attribute.
.rangev: The smu[X].source.rangev attribute.

autodelay `property` `writable` ¶

autodelay: str

Access the smu[X].source.autodelay attribute.

Description

This attribute enables or disables the automatic delay that occurs when the source is changed.

Usage

Accessing this property will send the print(smu[X].source.autodelay) query.
Setting this property to a value will send the smu[X].source.autodelay = value command.

TSP Syntax

- smu[X].source.autodelay = value
- print(smu[X].source.autodelay)

Info

X, the module channel number.

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

autorangei `property` `writable` ¶

autorangei: str

Access the smu[X].source.autorangei attribute.

Description

This attribute contains the state of the source autorange control (on or off). (i = current in amperes)

Usage

Accessing this property will send the print(smu[X].source.autorangei) query.
Setting this property to a value will send the smu[X].source.autorangei = value command.

TSP Syntax

- smu[X].source.autorangei = value
- print(smu[X].source.autorangei)

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

autorangev `property` `writable` ¶

autorangev: str

Access the smu[X].source.autorangev attribute.

Description

This attribute contains the state of the source autorange control (on or off). (v = voltage in volts)

Usage

Accessing this property will send the print(smu[X].source.autorangev) query.
Setting this property to a value will send the smu[X].source.autorangev = value command.

TSP Syntax

- smu[X].source.autorangev = value
- print(smu[X].source.autorangev)

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

constantcurrent `property` ¶

constantcurrent: str

Access the smu[X].source.constantcurrent attribute.

Description

This attribute indicates when the source is within the current limit.

Usage

Accessing this property will send the print(smu[X].source.constantcurrent) query.

TSP Syntax

- print(smu[X].source.constantcurrent)

Info

X, the module channel number.

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

delay `property` `writable` ¶

delay: str

Access the smu[X].source.delay attribute.

Description

This attribute contains the delay that occurs when the source is changed.

Usage

Accessing this property will send the print(smu[X].source.delay) query.
Setting this property to a value will send the smu[X].source.delay = value command.

TSP Syntax

- smu[X].source.delay = value
- print(smu[X].source.delay)

Info

X, the module channel number.

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

func `property` `writable` ¶

func: str

Access the smu[X].source.func attribute.

Description

This attribute configures the source function as either voltage source or current source.

Usage

Accessing this property will send the print(smu[X].source.func) query.
Setting this property to a value will send the smu[X].source.func = value command.

TSP Syntax

- smu[X].source.func = value
- print(smu[X].source.func)

Info

X, the module channel number.

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

leveli `property` `writable` ¶

leveli: str

Access the smu[X].source.leveli attribute.

Description

This attribute configures the source level setting. (i = current in amperes)

Usage

Accessing this property will send the print(smu[X].source.leveli) query.
Setting this property to a value will send the smu[X].source.leveli = value command.

TSP Syntax

- smu[X].source.leveli = value
- print(smu[X].source.leveli)

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

levelv `property` `writable` ¶

levelv: str

Access the smu[X].source.levelv attribute.

Description

This attribute configures the source level setting. (v = voltage in volts)

Usage

Accessing this property will send the print(smu[X].source.levelv) query.
Setting this property to a value will send the smu[X].source.levelv = value command.

TSP Syntax

- smu[X].source.levelv = value
- print(smu[X].source.levelv)

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

limiti `property` `writable` ¶

limiti: str

Access the smu[X].source.limiti attribute.

Description

This attribute symmetrically configures both the positive and the negative source limit settings. (i = current in amperes)

Usage

Accessing this property will send the print(smu[X].source.limiti) query.
Setting this property to a value will send the smu[X].source.limiti = value command.

TSP Syntax

- smu[X].source.limiti = value
- print(smu[X].source.limiti)

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

limitni `property` `writable` ¶

limitni: str

Access the smu[X].source.limitni attribute.

Description

This attribute configures the negative source limit. (i = current in amperes)

Usage

Accessing this property will send the print(smu[X].source.limitni) query.
Setting this property to a value will send the smu[X].source.limitni = value command.

TSP Syntax

- smu[X].source.limitni = value
- print(smu[X].source.limitni)

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

limitnv `property` `writable` ¶

limitnv: str

Access the smu[X].source.limitnv attribute.

Description

This attribute configures the negative source limit. (v = voltage in volts)

Usage

Accessing this property will send the print(smu[X].source.limitnv) query.
Setting this property to a value will send the smu[X].source.limitnv = value command.

TSP Syntax

- smu[X].source.limitnv = value
- print(smu[X].source.limitnv)

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

limitpi `property` `writable` ¶

limitpi: str

Access the smu[X].source.limitpi attribute.

Description

This attribute configures the positive source limit. (i = current in amperes)

Usage

Accessing this property will send the print(smu[X].source.limitpi) query.
Setting this property to a value will send the smu[X].source.limitpi = value command.

TSP Syntax

- smu[X].source.limitpi = value
- print(smu[X].source.limitpi)

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

limitpv `property` `writable` ¶

limitpv: str

Access the smu[X].source.limitpv attribute.

Description

This attribute configures the positive source limit. (v = voltage in volts)

Usage

Accessing this property will send the print(smu[X].source.limitpv) query.
Setting this property to a value will send the smu[X].source.limitpv = value command.

TSP Syntax

- smu[X].source.limitpv = value
- print(smu[X].source.limitpv)

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

limitv `property` `writable` ¶

limitv: str

Access the smu[X].source.limitv attribute.

Description

This attribute symmetrically configures both the positive and the negative source limit settings. (v = voltage in volts)

Usage

Accessing this property will send the print(smu[X].source.limitv) query.
Setting this property to a value will send the smu[X].source.limitv = value command.

TSP Syntax

- smu[X].source.limitv = value
- print(smu[X].source.limitv)

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

lowrangei `property` `writable` ¶

lowrangei: str

Access the smu[X].source.lowrangei attribute.

Description

This attribute sets the lowest source range that will be used during autoranging. (i = current in amperes)

Usage

Accessing this property will send the print(smu[X].source.lowrangei) query.
Setting this property to a value will send the smu[X].source.lowrangei = value command.

TSP Syntax

- smu[X].source.lowrangei = value
- print(smu[X].source.lowrangei)

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

lowrangev `property` `writable` ¶

lowrangev: str

Access the smu[X].source.lowrangev attribute.

Description

This attribute sets the lowest source range that will be used during autoranging. (v = voltage in volts)

Usage

Accessing this property will send the print(smu[X].source.lowrangev) query.
Setting this property to a value will send the smu[X].source.lowrangev = value command.

TSP Syntax

- smu[X].source.lowrangev = value
- print(smu[X].source.lowrangev)

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

offfunc `property` `writable` ¶

offfunc: str

Access the smu[X].source.offfunc attribute.

Description

This attribute sets the source function 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(smu[X].source.offfunc) query.
Setting this property to a value will send the smu[X].source.offfunc = value command.

TSP Syntax

- smu[X].source.offfunc = value
- print(smu[X].source.offfunc)

Info

X, the module channel number.

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

offlimiti `property` `writable` ¶

offlimiti: str

Access the smu[X].source.offlimiti attribute.

Description

This attribute configures both the positive and negative source off limit settings symmetrically. (i = current in amperes)

Usage

Accessing this property will send the print(smu[X].source.offlimiti) query.
Setting this property to a value will send the smu[X].source.offlimiti = value command.

TSP Syntax

- smu[X].source.offlimiti = value
- print(smu[X].source.offlimiti)

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

offlimitni `property` `writable` ¶

offlimitni: str

Access the smu[X].source.offlimitni attribute.

Description

This attribute configures the negative source off limit setting. (i = current in amperes)

Usage

Accessing this property will send the print(smu[X].source.offlimitni) query.
Setting this property to a value will send the smu[X].source.offlimitni = value command.

TSP Syntax

- smu[X].source.offlimitni = value
- print(smu[X].source.offlimitni)

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

offlimitnv `property` `writable` ¶

offlimitnv: str

Access the smu[X].source.offlimitnv attribute.

Description

This attribute configures the negative source off limit setting. (v = voltage in volts)

Usage

Accessing this property will send the print(smu[X].source.offlimitnv) query.
Setting this property to a value will send the smu[X].source.offlimitnv = value command.

TSP Syntax

- smu[X].source.offlimitnv = value
- print(smu[X].source.offlimitnv)

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

offlimitpi `property` `writable` ¶

offlimitpi: str

Access the smu[X].source.offlimitpi attribute.

Description

This attribute configures the positive source off limit setting. (i = current in amperes)

Usage

Accessing this property will send the print(smu[X].source.offlimitpi) query.
Setting this property to a value will send the smu[X].source.offlimitpi = value command.

TSP Syntax

- smu[X].source.offlimitpi = value
- print(smu[X].source.offlimitpi)

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

offlimitpv `property` `writable` ¶

offlimitpv: str

Access the smu[X].source.offlimitpv attribute.

Description

This attribute configures the positive source off limit setting. (v = voltage in volts)

Usage

Accessing this property will send the print(smu[X].source.offlimitpv) query.
Setting this property to a value will send the smu[X].source.offlimitpv = value command.

TSP Syntax

- smu[X].source.offlimitpv = value
- print(smu[X].source.offlimitpv)

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

offlimitv `property` `writable` ¶

offlimitv: str

Access the smu[X].source.offlimitv attribute.

Description

This attribute configures both the positive and negative source off limit settings symmetrically. (v = voltage in volts)

Usage

Accessing this property will send the print(smu[X].source.offlimitv) query.
Setting this property to a value will send the smu[X].source.offlimitv = value command.

TSP Syntax

- smu[X].source.offlimitv = value
- print(smu[X].source.offlimitv)

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

offmode `property` `writable` ¶

offmode: str

Access the smu[X].source.offmode attribute.

Description

This attribute sets the source output-off mode.

Usage

Accessing this property will send the print(smu[X].source.offmode) query.
Setting this property to a value will send the smu[X].source.offmode = value command.

TSP Syntax

- smu[X].source.offmode = value
- print(smu[X].source.offmode)

Info

X, the module channel number.

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

output `property` `writable` ¶

output: str

Access the smu[X].source.output attribute.

Description

This attribute enables or disables the source output.

Usage

Accessing this property will send the print(smu[X].source.output) query.
Setting this property to a value will send the smu[X].source.output = value command.

TSP Syntax

- smu[X].source.output = value
- print(smu[X].source.output)

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

rangei `property` `writable` ¶

rangei: str

Access the smu[X].source.rangei attribute.

Description

This attribute configures the source range setting to be fixed for function Y. (i = current in amperes)

Usage

Accessing this property will send the print(smu[X].source.rangei) query.
Setting this property to a value will send the smu[X].source.rangei = value command.

TSP Syntax

- smu[X].source.rangei = value
- print(smu[X].source.rangei)

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

rangev `property` `writable` ¶

rangev: str

Access the smu[X].source.rangev attribute.

Description

This attribute configures the source range setting to be fixed for function Y. (v = voltage in volts)

Usage

Accessing this property will send the print(smu[X].source.rangev) query.
Setting this property to a value will send the smu[X].source.rangev = value command.

TSP Syntax

- smu[X].source.rangev = value
- print(smu[X].source.rangev)

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

SmuItemTrigger ¶

Bases: BaseTSPCmd

The smu[X].trigger command tree.

Properties and methods

.measure: The smu[X].trigger.measure command tree.
.source: The smu[X].trigger.source command tree.

measure `property` ¶

measure: SmuItemTriggerMeasure

Return the smu[X].trigger.measure command tree.

Sub-properties and sub-methods

.i(): The smu[X].trigger.measure.i() function.
.iv(): The smu[X].trigger.measure.iv() function.
.p(): The smu[X].trigger.measure.p() function.
.r(): The smu[X].trigger.measure.r() function.
.v(): The smu[X].trigger.measure.v() function.

source `property` ¶

source: SmuItemTriggerSource

Return the smu[X].trigger.source command tree.

Sub-properties and sub-methods

.lineari(): The smu[X].trigger.source.lineari() function.
.linearv(): The smu[X].trigger.source.linearv() function.
.listi(): The smu[X].trigger.source.listi() function.
.listv(): The smu[X].trigger.source.listv() function.
.logi(): The smu[X].trigger.source.logi() function.
.logv(): The smu[X].trigger.source.logv() function.

SmuItemTriggerMeasure ¶

Bases: BaseTSPCmd

The smu[X].trigger.measure command tree.

Properties and methods

.i(): The smu[X].trigger.measure.i() function.
.iv(): The smu[X].trigger.measure.iv() function.
.p(): The smu[X].trigger.measure.p() function.
.r(): The smu[X].trigger.measure.r() function.
.v(): The smu[X].trigger.measure.v() function.

i ¶

i(reading_buffer: str) -> None

Run the smu[X].trigger.measure.i() function.

Description

This function configures the reading buffer and measure type for the trigger model. (i = current in amperes)

TSP Syntax

- smu[X].trigger.measure.i()

Parameters:	`reading_buffer` (`str`) – Buffer to store the measurement result.

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

iv ¶

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

Run the smu[X].trigger.measure.iv() function.

Description

This function configures the reading buffer and measure type for the trigger model. (i = current in amperes, v = voltage in volts)

TSP Syntax

- smu[X].trigger.measure.iv()

Parameters:	`ibuffer` (`str`) – Buffer to store current readings. `vbuffer` (`str`) – Buffer to store voltage readings.

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

p ¶

p(reading_buffer: str) -> None

Run the smu[X].trigger.measure.p() function.

Description

This function configures the reading buffer and measure type for the trigger model. (p = power in watts)

TSP Syntax

- smu[X].trigger.measure.p()

Parameters:	`reading_buffer` (`str`) – Buffer to store the measurement result.

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

r ¶

r(reading_buffer: str) -> None

Run the smu[X].trigger.measure.r() function.

Description

This function configures the reading buffer and measure type for the trigger model. (r = resistance in ohms)

TSP Syntax

- smu[X].trigger.measure.r()

Parameters:	`reading_buffer` (`str`) – Buffer to store the measurement result.

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

v ¶

v(reading_buffer: str) -> None

Run the smu[X].trigger.measure.v() function.

Description

This function configures the reading buffer and measure type for the trigger model. (v = voltage in volts)

TSP Syntax

- smu[X].trigger.measure.v()

Parameters:	`reading_buffer` (`str`) – Buffer to store the measurement result.

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

SmuItemTriggerSource ¶

Bases: BaseTSPCmd

The smu[X].trigger.source command tree.

Properties and methods

.lineari(): The smu[X].trigger.source.lineari() function.
.linearv(): The smu[X].trigger.source.linearv() function.
.listi(): The smu[X].trigger.source.listi() function.
.listv(): The smu[X].trigger.source.listv() function.
.logi(): The smu[X].trigger.source.logi() function.
.logv(): The smu[X].trigger.source.logv() function.

lineari ¶

lineari(start: str, end: str, points: str) -> None

Run the smu[X].trigger.source.lineari() function.

Description

This function configures the linear sweep for the trigger model. (i = current in amperes)

TSP Syntax

- smu[X].trigger.source.lineari()

Parameters:	`start` (`str`) – Start source level. `end` (`str`) – End source level. `points` (`str`) – Number of points used to calculate the step size.

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

linearv ¶

linearv(start: str, end: str, points: str) -> None

Run the smu[X].trigger.source.linearv() function.

Description

This function configures the linear sweep for the trigger model. (v = voltage in volts)

TSP Syntax

- smu[X].trigger.source.linearv()

Parameters:	`start` (`str`) – Start source level. `end` (`str`) – End source level. `points` (`str`) – Number of points used to calculate the step size.

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

listi ¶

listi(source_levels: str) -> None

Run the smu[X].trigger.source.listi() function.

Description

This function configures the list sweep for the trigger model. (i = current in amperes)

TSP Syntax

- smu[X].trigger.source.listi()

Parameters:	`source_levels` (`str`) – List of source levels; see Details.

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

listv ¶

listv(source_levels: str) -> None

Run the smu[X].trigger.source.listv() function.

Description

This function configures the list sweep for the trigger model. (v = voltage in volts)

TSP Syntax

- smu[X].trigger.source.listv()

Parameters:	`source_levels` (`str`) – List of source levels; see Details.

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

logi ¶

logi(start: str, end: str, points: str, asymptote: str) -> None

Run the smu[X].trigger.source.logi() function.

Description

This function configures a logarithmic sweep for the trigger model. (i = current in amperes)

TSP Syntax

- smu[X].trigger.source.logi()

Parameters:	`start` (`str`) – Start source level. `end` (`str`) – End source level. `points` (`str`) – Number of points used to calculate the step size. `asymptote` (`str`) – The asymptotic offset value (optional).

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

logv ¶

logv(start: str, end: str, points: str, asymptote: str) -> None

Run the smu[X].trigger.source.logv() function.

Description

This function configures a logarithmic sweep for the trigger model. (v = voltage in volts)

TSP Syntax

- smu[X].trigger.source.logv()

Parameters:	`start` (`str`) – Start source level. `end` (`str`) – End source level. `points` (`str`) – Number of points used to calculate the step size. `asymptote` (`str`) – The asymptotic offset value (optional).

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

smu ¶

SmuItem ¶

configlist property ¶

contact property ¶

defbuffer1 cached property ¶

defbuffer2 cached property ¶

guard property ¶

measure property ¶

overlapped property writable ¶

sense property writable ¶

source property ¶

trigger property ¶

abort ¶

makebuffer ¶

reset ¶

waitcomplete ¶

SmuItemConfiglist ¶

create ¶

delete ¶

query ¶

recall ¶

size ¶

store ¶

table ¶

SmuItemContact ¶

speed property writable ¶

threshold property writable ¶

calibratehi ¶

calibratelo ¶

check ¶

getcalhi ¶

r ¶

SmuItemGuard ¶

v ¶

SmuItemMeasure ¶

aperture property writable ¶

autodelay property writable ¶

autorangei property writable ¶

autorangev property writable ¶

count property writable ¶

delay property writable ¶

interval property writable ¶

lowrangei property writable ¶

lowrangev property writable ¶

nplc property writable ¶

rangei property ¶

rangev property ¶

rel property ¶

tempcomp property writable ¶

i ¶

overlappedi ¶

overlappediv ¶

overlappedp ¶

overlappedr ¶

overlappedv ¶

p ¶

r ¶

v ¶

SmuItemMeasureRel ¶

enablei property writable ¶

enablep property writable ¶

enabler property writable ¶

enablev property writable ¶

leveli property writable ¶

levelp property writable ¶

levelr property writable ¶

levelv property writable ¶

SmuItemSource ¶

autodelay property writable ¶

autorangei property writable ¶

autorangev property writable ¶

constantcurrent property ¶

delay property writable ¶

func property writable ¶

leveli property writable ¶

levelv property writable ¶

limiti property writable ¶

limitni property writable ¶

limitnv property writable ¶

limitpi property writable ¶

configlist `property` ¶

contact `property` ¶

defbuffer1 `cached` `property` ¶

defbuffer2 `cached` `property` ¶

guard `property` ¶

measure `property` ¶

overlapped `property` `writable` ¶

sense `property` `writable` ¶

source `property` ¶

trigger `property` ¶

speed `property` `writable` ¶

threshold `property` `writable` ¶

aperture `property` `writable` ¶

autodelay `property` `writable` ¶

autorangei `property` `writable` ¶

autorangev `property` `writable` ¶

count `property` `writable` ¶

delay `property` `writable` ¶

interval `property` `writable` ¶

lowrangei `property` `writable` ¶

lowrangev `property` `writable` ¶

nplc `property` `writable` ¶

rangei `property` ¶

rangev `property` ¶

rel `property` ¶

tempcomp `property` `writable` ¶

enablei `property` `writable` ¶

enablep `property` `writable` ¶

enabler `property` `writable` ¶

enablev `property` `writable` ¶

leveli `property` `writable` ¶

levelp `property` `writable` ¶

levelr `property` `writable` ¶

levelv `property` `writable` ¶

autodelay `property` `writable` ¶

autorangei `property` `writable` ¶

autorangev `property` `writable` ¶

constantcurrent `property` ¶

delay `property` `writable` ¶

func `property` `writable` ¶

leveli `property` `writable` ¶

levelv `property` `writable` ¶

limiti `property` `writable` ¶

limitni `property` `writable` ¶

limitnv `property` `writable` ¶

limitpi `property` `writable` ¶

limitpv `property` `writable` ¶

limitv `property` `writable` ¶

lowrangei `property` `writable` ¶

lowrangev `property` `writable` ¶

offfunc `property` `writable` ¶

offlimiti `property` `writable` ¶

offlimitni `property` `writable` ¶

offlimitnv `property` `writable` ¶

offlimitpi `property` `writable` ¶

offlimitpv `property` `writable` ¶

offlimitv `property` `writable` ¶

offmode `property` `writable` ¶

output `property` `writable` ¶

rangei `property` `writable` ¶

rangev `property` `writable` ¶

measure `property` ¶

source `property` ¶