rminstr.instruments.LS340

Classes

TemperatureController

LS340 as a temperature controller.

Package Contents

class rminstr.instruments.LS340.TemperatureController(visa_address: str, resource_manager: pyvisa.ResourceManager = None, log_path: str = None)

Bases: rminstr.instruments.communications.Instrument, rminstr.instruments.measurement_functionalities.ABC_TemperatureController

LS340 as a temperature controller.

Initialize the temperature controller class instance.

Parameters:

visa_addressstr

Visa address of instrument.

resource_managervisa.ResourceManager, optional

Pyvisa resource manager for opening visa resources. The default is None.

log_pathstr, optional

If provided, will log at the specified path. The default is None.

Returns:

None.

default_setup_settings

initial_setup(**kwargs)

Initiliaze the temperature controllers’s local settings to a safe state.

This funciton should only be run if the instrument is not currently in a safe state, otherwise settings will be overwritten.

Returns:

None.

setup(loop: int = None, loop_enabled: bool = None, loop_on_powerup: bool = None, loop_input: str = None, heater_range: int = None, mode: int = None, setpoint: float = None, setpoint_units: int = None, sensor_input: str = None, sensor_type: int = None, sensor_units: int = None, sensor_coefficient: int = None, sensor_excitation: int = None, sensor_range: int = None, P: float = None, I: float = None, D: float = None, **kwargs)

Change temperature controller settings.

Parameters:

loopint, optional

Which loop (1 or 2) to set the loop parameters for and use. The default is None.

loop_enabledbool, optional

Whether or not to enable the loop after setting. The default is None.

loop_on_powerupbool, optional

Whether or not to enable the loop after powerup. The default is None.

loop_inputstr, optional

Which sensor input (A or B) to use for the specified loop. The default is None.

heater_rangeint, optional

Specifies the heater range (max wattage). The values it sets depend on other parameters, refer to the manual (6.12.1) The default is None.

modeint, optional

Specifies the loop mode. Refer to the manual for more details. The default is None.

Values mapping is as follows: 1 = Manual PID 2 = Zone 3 = Open Loop 4 = AutoTune PID 5 = AutoTune PI 6 = AutoTune P

setpointfloat = None

The temperature setpoint. The default is None.

setpoint_unitsint = None

The units for the temperature setpoint. The default is None.

Values mapping is as follows: 1 = Kelvin 2 = Celsius 3 = Sensor units

sensor_inputstr, optional

Which input (A or B) to use for setting the sensor parameters. The default is None.

sensor_typeint, optional

The type of sensor to use. This will autopopulate certain sensor parameters if it is not zero, The default is None.

Values mapping is as follows: 0 - Special 1 - Silicon Diode 2 - GaAlAs Diode 3 - Platinum 100 (250 Ohm) 4 - Platinum 100 (500 Ohm) 5 - Platinum 1000 6 - Rhodium Iron 7 - Carbon-Glass 8 - Cernox 9 - RuOx 10 - Germanium 11 - Capacitor 12 - Thermocouple

sensor_unitsint, optional

Will be autoset if type is not zero. Valid entires are volts (1) or ohms (2) The default is None.

sensor_coefficientint, optional

Will be autoset if type is not zero. Specifies the coefficient of the sensor. Valid entires are negative (1) or positive (2). The default is None.

sensor_excitationint, optional

Will be autoset if type is not zero. Specifies the excitation of the sensor (see manual 5.1.4). The default is None.

Values mapping is as follows: 0 - Off 1 - 30 nA 2 - 100 nA 3 - 300 nA 4 - 1 μA 5 - 3 μA 6 - 10 μA 7 - 30 μA 8 - 100 μA 9 - 300 μA 10 - 1 mA 11 - 10 mV 12 - 1 mV

sensor_rangeint, optional

Will be autoset if type is not zero. Specifies the range of the sensor (see manual 5.1.4). The default is None.

Values mapping is as follows: 1 - 1 mV 4 - 10 mV 7 - 100 mV 10 - 1 V 13 - 7.5 V 2 - 2.5 mV 5 - 25 mV 8 - 250 mV 11 - 2.5 V 3 - 5 mV 6 - 50 mV 9 - 500 mV 12 - 5 V

Pfloat, optional

P constant to use in manual PID mode. The default is None.

Ifloat, optional

I constant to use in manual PID mode. The default is None.

Dfloat, optional

D constant to use in manual PID mode. The default is None.

Returns:

None.

get_errors()

Get any errors present on the instrument as a string.

Returns:

str

Error string if one is there.

raise_errors()

If the LS340 is in an error state, raise the errors as python errors.

Returns:

None.

Raises:

InstrumentError

Instrument error if the instrument has errors or is in an error state.