photons.equipment.keithley_6430 module

Keithley 6430 sub-femtoAmp SourceMeter.

class photons.equipment.keithley_6430.Keithley6430(record, **kwargs)[source]

Bases: DMM

Keithley 6430 sub-femtoAmp SourceMeter.

Parameters:

record (EquipmentRecord) – The equipment record.
**kwargs – Keyword arguments. Can be specified as attributes of an XML element in a configuration file (with the tag of the element equal to the alias of record).

MODES: dict[str, str] = {'FIX': 'FIXED', 'FIXED': 'FIXED', 'LIST': 'LIST', 'SWE': 'SWEEP', 'SWEEP': 'SWEEP'}

TRIGGERS: dict[str, str] = {'BST': 'BSTEST', 'BSTEST': 'BSTEST', 'BUS': 'BUS', 'IMM': 'IMMEDIATE', 'IMMEDIATE': 'IMMEDIATE', 'MAN': 'MANUAL', 'MANUAL': 'MANUAL', 'NST': 'NSTEST', 'NSTEST': 'NSTEST', 'PST': 'PSTEST', 'PSTEST': 'PSTEST', 'TIM': 'TIMER', 'TIMER': 'TIMER', 'TLIN': 'TLINK', 'TLINK': 'TLINK'}

source_settings_changed: SignalInstance

check_errors()[source]

Query the error queue of the SourceMeter.

If there is an error then raise an exception.

Return type:: None

configure(*, function='current', range=1.05e-06, nsamples=10, nplc=10, auto_zero=True, trigger='bus', edge=None, ntriggers=1, delay=0.0, cmpl=0.000105, enable=True)[source]

Configure the Sense subsystem.

Parameters:

function (str) – The function to measure. Can be any key in DMM.FUNCTIONS (case insensitive).
range (float | str) – The range to use for the measurement. Can be any key in DMM.RANGES.
nsamples (int) – The number of samples to acquire after a trigger event.
nplc (int) – The number of power-line cycles.
auto_zero (bool | int | str) – The auto-zero mode. Can be any key in DMM.AUTO.
trigger (str) – The trigger mode. Can be any key in Keithley6430.TRIGGERS (case insensitive).
edge (None) – Not supported and must be None (the edge to trigger on).
ntriggers (int) – The number of triggers that are accepted by the SourceMeter before returning to the wait-for-trigger state.
delay (float) – The trigger delay in seconds (auto delay is not supported).
cmpl (float) – The protection (compliance) value.
enable (bool) – Whether to enable the output.

Return type:

dict[str, ...]

Returns:

The result of settings() after applying the configuration.

configure_source(*, function='current', range=1e-06, nsamples=10, auto_zero=True, trigger='bus', delay=0.0, mode='fixed', cmpl=0.01, cmpl_range=0.21)[source]

Configure the Source subsystem.

Parameters:

function (str) – The output source. Can be any key in DMM.FUNCTIONS (case insensitive).
range (float) – The range to use for the output level.
nsamples (int) – The number of samples to acquire after a trigger event.
auto_zero (bool | int | str) – The auto-zero mode. Can be any key in DMM.AUTO.
trigger (str) – The trigger mode. Can be any key in Keithley6430.TRIGGERS (case insensitive).
delay (float) – The trigger delay in seconds.
mode (str) – The output mode. Can be any key in Keithley6430.MODES (case insensitive).
cmpl (float) – The protection (compliance) value.
cmpl_range (float) – The range to use for the protection (compliance).

Return type:

dict[str, ...]

Returns:

The result of settings_source() after applying the configuration.

disable_output()[source]

Turn the output off.

Return type:: None

enable_output()[source]

Turn the output on.

Return type:: None

get_output_level()[source]

Returns the output level.

Return type:: float

is_output_enabled()[source]

Returns whether the source output is on or off.

Return type:: bool

is_output_stable(tol=0.001)[source]

Whether the output level has stabilized.

You must call set_output_level() once before calling this method, otherwise the level comparison is meaningless.

Parameters:: tol (float) – The fractional tolerance for the output to be considered stable.
Return type:: bool

set_output_level(level, *, wait=False, tol=0.001, timeout=60)[source]

Set the level of the Source output.

Parameters:

level (float) – The value to set the output to.
wait (bool) – Whether to wait for the output level to stabilize before returning.
tol (float) – The fractional tolerance for the level to be considered stable.
timeout (float) – The maximum number of seconds to wait.

Return type:

None

settings()[source]

Return type:: dict[str, ...]

Returns the configuration settings of the Sense subsystem.

{
  'auto_range': str,
  'auto_zero': str,
  'cmpl': float,
  'function': str,
  'nplc': float,
  'nsamples': 1,
  'range': float,
  'trigger_count': int,
  'trigger_delay': float,
  'trigger_delay_auto': False,
  'trigger_edge': 'N/A',
  'trigger_mode': str
}

settings_source()[source]

Return type:: dict[str, ...]

Returns the configuration settings of the Source subsystem.

{
  'auto_zero': str,
  'cmpl': float,
  'cmpl_range': float,
  'function': str,
  'mode': str,
  'nsamples': int,
  'range': float,
  'trigger_delay': float,
  'trigger_mode': str
}

disconnect_equipment()[source]

Turn the output off and disconnect.

Return type:: None