Skip to content

Smu#

Device class for a Source Measurement Unit


property is_output_on#

Queries the output state.

Returns#

Type Description
bool True if output is on otherwise False .

Example#

outputState = smu.is_output_on

property max_current_in_max_voltage_range#

The largest programmable current in the largest voltage range.

Returns#

Type Description
float The largest programmable current in amperes.

Example#

current = smu.max_current_in_max_voltage_range

property max_voltage#

The largest programmable voltage.

Returns#

Type Description
float The largest programmable voltage in volts.

Example#

voltage = smu.max_voltage

property name#

The name assigned to the device (channel) in the device manager.

Returns#

Type Description
str The name assigned to the device (channel) in the device manager.

method check_voltage_and_current(voltage: float, current: float, pulse_mode: bool)#

Checks if the current and voltage settings are valid. Raises an error if the settings are not valid.

Parameters#

Name Description
voltage The voltage settings in volts to be checked.
current The current settings in amperes to be checked.
pulse_mode Set this parameter to True if the settings shall be checked for pulse mode.

Example#

smu.check_voltage_and_current(5.0, 10E-3, False)

method get_current_bias()#

Queries the programmed current bias.

Returns#

Type Description
float Programmed current bias in amperes.

Example#

current = smu.get_current_bias()

method get_max_current(voltage_range: float)#

Queries the largest current for a specific voltage range.

Parameters#

Name Description
voltage_range The voltage range for which the current is to be queried.

Returns#

Type Description
float The largest current for the specific voltage range.

Example#

current = smu.get_max_current(20.0)

method get_voltage_bias()#

Queries the programmed voltage bias.

Returns#

Type Description
float Programmed voltage bias in volts.

Example#

voltage = smu.get_voltage_bias()

method measure_current()#

Measures the output current.

Returns#

Type Description
float Measured current in amperes.

Example#

current = smu.measure_current()

method measure_iv()#

Measures the output current and voltage simultaneously.

Returns#

Type Description
float Measured current in amperes.
float Measured voltage in volts.

Example#

current, voltage = smu.measure_iv()

method measure_voltage()#

Measures the output voltage.

Returns#

Type Description
float Measured voltage in volts.

Example#

voltage = smu.measure_voltage()

method output_off()#

Turn SMU output off.

Example#

smu.output_off()

method output_on()#

Turn SMU output on.

Example#

smu.output_on()

method remote_sense(is_enabled: bool)#

Set sensing to local or remote.

Parameters#

Name Description
is_enabled True means remote sense (4 wire), False means local sense (2 wire)

Example#

smu.remote_sense(True)

method reset()#

Resets all electrical settings to their default settings.

Example#

smu.reset()

method reset_output()#

Turns off the output and resets all electrical settings to their default settings.

Example#

smu.reset_output()

method set_current(current: float, voltage_compliance: float)#

Set output mode to current and sense range to auto.

Parameters#

Name Description
current The new output current in amperes.
voltage_compliance The new voltage limit in volts.

Example#

smu.set_current(10E-3, 5.0)

method set_current_fixed_sense_range(current: float, voltage_compliance: float)#

Set output mode to current with fixed sense range.

Parameters#

Name Description
current Output current in amperes
voltage_compliance Voltage limit in volts

Example#

smu.set_current_fixed_sense_range(10E-3, 5.0)

method set_voltage(voltage: float, current_compliance: float)#

Set output mode to voltage and sense range to auto.

Parameters#

Name Description
voltage The new output voltage in volts.
current_compliance The new current limit in amperes.

Example#

smu.set_voltage(5.0, 10E-3)

method set_voltage_fixed_sense_range(voltage: float, current_compliance: float)#

Set output mode to voltage with fixed sense range.

Parameters#

Name Description
voltage The new output voltage in volts.
current_compliance The new current limit in amperes.

Example#

smu.set_voltage_fixed_sense_range(5.0, 10E-3)