The specs_iqe11 module

Autogenerated API documentation for specs_iqe11

Self contained module to run a SPECS sputter gun including fall-back text gui

class PyExpLabSys.drivers.specs_iqe11.CursesTui(sputtergun)

Bases: threading.Thread

Defines a fallback text-gui for the sputter gun.

__init__(sputtergun)

This constructor should always be called with keyword arguments. Arguments are:

group should be None; reserved for future extension when a ThreadGroup class is implemented.

target is the callable object to be invoked by the run() method. Defaults to None, meaning nothing is called.

name is the thread name. By default, a unique name is constructed of the form “Thread-N” where N is a small decimal number.

args is the argument tuple for the target invocation. Defaults to ().

kwargs is a dictionary of keyword arguments for the target invocation. Defaults to {}.

If a subclass overrides the constructor, it must make sure to invoke the base class constructor (Thread.__init__()) before doing anything else to the thread.

run()

Method representing the thread’s activity.

You may override this method in a subclass. The standard run() method invokes the callable object passed to the object’s constructor as the target argument, if any, with sequential and keyword arguments taken from the args and kwargs arguments, respectively.

stop()

Cleanup the terminal

class PyExpLabSys.drivers.specs_iqe11.Puiqe11(simulate=False)

Bases: threading.Thread

Driver for ion sputter guns from SPECS

__init__(simulate=False)

Initialize module

Establish serial connection and create status variable to expose the status for the instrument for the various gui’s

comm(command)

Communication with the instrument

Implements the synatx need to send commands to instrument including handling carrige returns and extra lines of ‘OK’ and other pecularities of the instrument.

Parameters:command (str) – The command to send Returns:The reply to the command striped for protocol technicalities Return type:str

read_sputter_current()

Read the sputter current. Unit mA :return: The sputter current :rtype: float

read_filament_voltage()

Read the filament voltage. Unit V :return: The filament voltage :rtype: float

read_filament_current()

Read the filament current. Unit A :return: The filament current :rtype: float

read_emission_current()

Read the emission current. Unit mA :return: The emission current :rtype: float

read_acceleration_voltage()

Read the acceleration voltage. Unit V :return: The acceleration voltage :rtype: float

read_temperature_energy_module()

Read the temperature of the electronics module This value is not extremely correct, use only as guideline. :return: The temperature :rtype: float

standby()

Set the device on standby The function is not working entirely as intended. TODO: Implement check to see if the device is alrady in standby :return: The direct reply from the device :rtype: str

operate()

Set the device in operation mode TODO: This function should only be activated from standby!!! :return: The direct reply from the device :rtype: str

remote_enable(local=False)

Enable or disable remote mode :param local: If True the device is set to local, otherwise to remote :type local: Boolean :return: The direct reply from the device :rtype: str

update_status()

Update the status of the instrument

Runs a number of status queries and updates self.status

Returns:The direct reply from the device Return type:str

run()

Method representing the thread’s activity.

You may override this method in a subclass. The standard run() method invokes the callable object passed to the object’s constructor as the target argument, if any, with sequential and keyword arguments taken from the args and kwargs arguments, respectively.