ekpy.control.instruments.srs830 package

Submodules

ekpy.control.instruments.srs830.core module

ekpy.control.instruments.srs830.core.auto_gain(lockin)

Autogain.

Parameters

lockin (pyvisa.resources.gpib.GPIBInstrument) – SRS830

ekpy.control.instruments.srs830.core.get_R_theta(lockin)

Get R and Theta. (Measure).

Parameters

lockin (pyvisa.resources.gpib.GPIBInstrument) – SRS830

Returns

R, Theta

Return type

(tuple)

ekpy.control.instruments.srs830.core.get_X_Y(lockin)

Get X and Y (Measure)

Parameters

lockin (pyvisa.resources.gpib.GPIBInstrument) – SRS830

Returns

X, Y

Return type

(tuple)

ekpy.control.instruments.srs830.core.get_nearest_time_constant(time)

Return the time constant closest to given time (by rounding up)

ekpy.control.instruments.srs830.core.get_reference_source(lockin)

Get the reference source. Return either internal (1) or external (0).

Parameters

lockin (pyvisa.resources.gpib.GPIBInstrument) – SRS830

Returns

1 for internal, 0 for external.

Return type

(int)

ekpy.control.instruments.srs830.core.get_sensitivity(lockin)

Get sensitivity.

Parameters

lockin (pyvisa.resources.gpib.GPIBInstrument) – SRS 830

Returns

Sensitivity.

Return type

(str)

ekpy.control.instruments.srs830.core.get_time_constant(lockin)

Get the current time constant.

Parameters

lockin (pyvisa.resources.gpib.GPIBInstrument) – SRS830

Returns

Time constant.

Return type

(str)

ekpy.control.instruments.srs830.core.get_time_constant_float(time_constant)

Get float of time constant.

Parameters

time_constant (str) – Time constant.

Returns

Time constant float.

Return type

(float)

ekpy.control.instruments.srs830.core.get_time_constant_from_frequency(frequency, multiplier=3)

Estimate a good time constant from the frequency. (multiplier/frequency).

Parameters

  • frequency (str) – Frequency

  • multipler (int or float) – Multiplier for time constant.

ekpy.control.instruments.srs830.core.initialize_lockin(lockin, trigger, harmonic, time_constant, frequency=None, amplitude=None)

Initialize lockin.

Parameters

  • lockin (pyvisa.resources.gpib.GPIBInstrument) – SRS830

  • trigger (str) – Trigger source. ‘internal’ or ‘external’.

  • harmonic (int) – Harmonic

  • time_constant (str) – Time constant.

  • frequency (str) – If internal triggering, must supply frequency and amplitude.

  • amplitude (str) – Units of Volts. If internal triggering, must supply frequency and amplitude.

ekpy.control.instruments.srs830.core.set_external_reference_slope(lockin, slope: str)

Set the external reference slope.

Parameters

  • lockin (pyvisa.resources.gpib.GPIBInstrument) – SRS830

  • slope (str) – External reference slope. Options are [‘SINE’, ‘RISING’, ‘FALLING’]

ekpy.control.instruments.srs830.core.set_harmonic(lockin, harmonic_number=1)

Set detection harmonic.

Parameters

  • lockin (pyvisa.resources.gpib.GPIBInstrument) – SRS830

  • harmonic_number (int) – Specify harmonic.

ekpy.control.instruments.srs830.core.set_internal_amplitude(lockin, amplitude)

Set the internal amplitude output of the lockin.

Parameters

  • lockin (pyvisa.resources.gpib.GPIBInstrument) – SRS 830

  • amplitude (str or float) – Amplitude. Allowed suffix are ‘mv’ or ‘v’ if using str. Limits on srs830 are .004<v<5

ekpy.control.instruments.srs830.core.set_internal_frequency(lockin, frequency)

Set the internal frequency output of the lockin.

Parameters

  • lockin (pyvisa.resources.gpib.GPIBInstrument) – SRS830

  • frequency (str or float) – Frequency. allowed suffix are khz or hz if using str. limits on srs830 are .001<f<10200

ekpy.control.instruments.srs830.core.set_lockin_sensitivity(lockin, sensitivity='default', sleep_time=10)

Set the sensitivity on the lockin. ‘default’ will auto-gain the lockin.

Parameters

  • lockin (pyvisa.resources.gpib.GPIBInstrument) – SRS830

  • sensitivity (str) – Sensitivity.

  • sleep_time (int or float) – Amount of time to sleep before amd after setting the sensitivity.

ekpy.control.instruments.srs830.core.set_low_pass_filter_slope(lockin, slope: str)

Set the low pass filter slope. Allowed slopes are ‘6dB/oct’, ‘12dB/oct’, ‘18dB/oct’, ‘24dB/oct’

Parameters

  • lockin (pyvisa.resources.gpib.GPIBInstrument) – SRS830

  • slope (str) – Slope

ekpy.control.instruments.srs830.core.set_phase(lockin, phase=None)

Set the phase of the lockin.

Parameters

  • lockin (pyvisa.resources.gpib.GPIBInstrument) – SRS830

  • phase (str) – Phase.

ekpy.control.instruments.srs830.core.set_reference_source(lockin, source)

Set the reference source to interal or external.

Parameters

  • lockin (pyvisa.resources.gpib.GPIBInstrument) – SRS830

  • source (int or str) – 1, ‘internal’ or 0, ‘external’

Examples

` >>> set_reference_source(lockin, 1), set_reference_source(lockin, 'internal') `

ekpy.control.instruments.srs830.core.set_sensitivity(lockin, sensitivity)

Set sensitivity of lockin.

Parameters

  • lockin (pyvisa.resources.gpib.GPIBInstrument) – SRS 830

  • sensitivity ('str') – Sensitivity. Allowed are ‘2nv/fa’,’5nv/fa’,’10nv/fa’,’20nv/fa’,’50nv/fa’,’100nv/fa’:,’200nv/fa’,’500nv/fa’,’1uv/pa’,’2uv/pa’,’5uv/pa’,’10uv/pa’:,’20uv/pa’,’50uv/pa’,’100uv/pa’,’200uv/pa’,’500uv/pa’,’1mv/na’,’2mv/na’,’5mv/na’,’10mv/na’,’20mv/na’,’50mv/na’,’100mv/na’,’200mv/na’,’500mv/na’,’1v/ua’

ekpy.control.instruments.srs830.core.set_signal_input_configuration(lockin, config: str)

Set the signal input configuration.

Parameters

  • lockin (pyvisa.resources.gpib.GPIBInstrument) – SRS830

  • config (str) – Input configuration. Options are [‘A’, ‘A-B’, ‘I(1M)’, ‘I(100M)’]

ekpy.control.instruments.srs830.core.set_signal_input_coupling(lockin, coupling: str)

Set the signal input coupling.

Parameters

  • lockin (pyvisa.resources.gpib.GPIBInstrument) – SRS830

  • coupling (str) – Input coupling. Options are [‘AC’, ‘DC’]

ekpy.control.instruments.srs830.core.set_signal_input_shield_grounding(lockin, grounding: str)

Set the signal input shield grounding.

Parameters

  • lockin (pyvisa.resources.gpib.GPIBInstrument) – SRS830

  • grounding (str) – Input shield grounding. Options are [‘FLOAT’, ‘GROUND’]

ekpy.control.instruments.srs830.core.set_time_constant(lockin, time_constant)

Set time constant.

Parameters

  • lockin (pyvisa.resources.gpib.GPIBInstrument) – SRS830

  • time_constant (str) – Time constant. allowed time_constant: [‘10us’, ‘30us’, ‘100us’, ‘300us’, ‘1ms’, ‘3ms’, ‘10ms’, ‘30ms’, ‘100ms’, ‘300ms’, ‘1s’, ‘3s’, ’10s’, ’30s’, ‘100s’, ‘300s’, ‘1ks’, ‘3ks’, ‘10ks’, ‘30ks’]

Module contents