Qudi
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
laserquantum_laser.LaserQuantumLaser Class Reference

Qudi module to communicate with the Edwards turbopump and vacuum equipment. More...

Inheritance diagram for laserquantum_laser.LaserQuantumLaser:
Inheritance graph
[legend]
Collaboration diagram for laserquantum_laser.LaserQuantumLaser:
Collaboration graph
[legend]

Public Member Functions

def on_activate (self)
 Activate module.
 
def on_deactivate (self)
 Deactivate module.
 
def connect_laser (self, interface)
 Connect to Instrument. More...
 
def disconnect_laser (self)
 Close the connection to the instrument.
 
def allowed_control_modes (self)
 Control modes for this laser.
 
def get_control_mode (self)
 Get current laser control mode. More...
 
def set_control_mode (self, mode)
 Set laser control mode. More...
 
def get_power (self)
 Get laser power. More...
 
def get_power_setpoint (self)
 Get the laser power setpoint. More...
 
def get_power_range (self)
 Get laser power range. More...
 
def set_power (self, power)
 Set laser power. More...
 
def get_current_unit (self)
 Get unit for laser current. More...
 
def get_current_range (self)
 Get range for laser current. More...
 
def get_current (self)
 Cet current laser current. More...
 
def get_current_setpoint (self)
 Current laser current setpoint. More...
 
def set_current (self, current_percent)
 Set laser current setpoint. More...
 
def get_shutter_state (self)
 Get laser shutter state. More...
 
def set_shutter_state (self, state)
 Set the desired laser shutter state. More...
 
def get_psu_temperature (self)
 Get power supply temperature. More...
 
def get_laser_temperature (self)
 Get laser head temperature. More...
 
def get_temperatures (self)
 Get all available temperatures. More...
 
def set_temperatures (self, temps)
 Set temperature for lasers with adjustable temperature for tuning. More...
 
def get_temperature_setpoints (self)
 Get temperature setpints. More...
 
def get_lcd (self)
 Get the text displayed on the PSU display. More...
 
def get_laser_state (self)
 Get laser operation state. More...
 
def set_laser_state (self, status)
 Set desited laser state. More...
 
def on (self)
 Turn laser on. More...
 
def off (self)
 Turn laser off. More...
 
def get_firmware_version (self)
 Ask the laser for ID. More...
 
def dump (self)
 Return LaserQuantum information dump. More...
 
def timers (self)
 Return information about component runtimes. More...
 
def get_extra_info (self)
 Extra information from laser. More...
 
- Public Member Functions inherited from core.module.BaseMixin
def __init__ (self, manager, name, config=None, callbacks=None, kwargs)
 Initialise Base class object and set up its state machine. More...
 
def log (self)
 Returns a logger object.
 
def is_module_threaded (self)
 Returns whether the module shall be started in a thread.
 
def on_activate (self)
 Method called when module is activated. More...
 
def on_deactivate (self)
 Method called when module is deactivated. More...
 
def getStatusVariables (self)
 Return a dict of variable names and their content representing the module state for saving. More...
 
def setStatusVariables (self, variableDict)
 Give a module a dict of variable names and their content representing the module state. More...
 
def getConfiguration (self)
 Return the configration dictionary for this module. More...
 
def get_connector (self, connector_name)
 Return module connected to the given named connector. More...
 
- Public Member Functions inherited from core.module.ModuleMeta
def __new__ (cls, name, bases, attrs)
 Collect declared Connectors, ConfigOptions and StatusVars into dictionaries. More...
 

Public Attributes

 psu
 
 rm
 
 inst
 
- Public Attributes inherited from core.module.BaseMixin
 module_state
 
 connectors
 

Static Public Attributes

 serial_interface = ConfigOption('interface', 'ASRL1::INSTR', missing='warn')
 
 maxpower = ConfigOption('maxpower', 0.250, missing='warn')
 
 psu_type = ConfigOption('psu', 'SMD6000', missing='warn')
 

Detailed Description

Qudi module to communicate with the Edwards turbopump and vacuum equipment.

Example config for copy-paste:

laserquantum_laser: module 'laser.laserquantum_laser.LaserQuantumLaser' interface 'ASRL1::INSTR' maxpower 0.250 # in Watt psu 'SMD6000'

Member Function Documentation

◆ connect_laser()

def laserquantum_laser.LaserQuantumLaser.connect_laser (   self,
  interface 
)

Connect to Instrument.

Parameters
strinterface: visa interface identifier
Returns
bool: connection success

◆ dump()

def laserquantum_laser.LaserQuantumLaser.dump (   self)

Return LaserQuantum information dump.

Returns
str: diagnostic information dump from laser

◆ get_control_mode()

def laserquantum_laser.LaserQuantumLaser.get_control_mode (   self)

Get current laser control mode.

Returns
ControlMode: current laser control mode

◆ get_current()

def laserquantum_laser.LaserQuantumLaser.get_current (   self)

Cet current laser current.

Returns
float: current laser current

◆ get_current_range()

def laserquantum_laser.LaserQuantumLaser.get_current_range (   self)

Get range for laser current.

Returns
tuple(flaot, float): range for laser current

◆ get_current_setpoint()

def laserquantum_laser.LaserQuantumLaser.get_current_setpoint (   self)

Current laser current setpoint.

Returns
float: laser current setpoint

◆ get_current_unit()

def laserquantum_laser.LaserQuantumLaser.get_current_unit (   self)

Get unit for laser current.

Returns
str: unit for laser current

◆ get_extra_info()

def laserquantum_laser.LaserQuantumLaser.get_extra_info (   self)

Extra information from laser.

Returns
str: multiple lines of text with information about laser

For LaserQuantum devices, this is the firmware version, dump and timers information

◆ get_firmware_version()

def laserquantum_laser.LaserQuantumLaser.get_firmware_version (   self)

Ask the laser for ID.

Returns
str: what the laser tells you about itself

◆ get_laser_state()

def laserquantum_laser.LaserQuantumLaser.get_laser_state (   self)

Get laser operation state.

Returns
LaserState: laser state

◆ get_laser_temperature()

def laserquantum_laser.LaserQuantumLaser.get_laser_temperature (   self)

Get laser head temperature.

Returns
float: laser head temperature

◆ get_lcd()

def laserquantum_laser.LaserQuantumLaser.get_lcd (   self)

Get the text displayed on the PSU display.

Returns
str: text on power supply display

◆ get_power()

def laserquantum_laser.LaserQuantumLaser.get_power (   self)

Get laser power.

Returns
float: laser power in watts

◆ get_power_range()

def laserquantum_laser.LaserQuantumLaser.get_power_range (   self)

Get laser power range.

Returns
tuple(float, float): laser power range

◆ get_power_setpoint()

def laserquantum_laser.LaserQuantumLaser.get_power_setpoint (   self)

Get the laser power setpoint.

Returns
float: laser power setpoint in watts

◆ get_psu_temperature()

def laserquantum_laser.LaserQuantumLaser.get_psu_temperature (   self)

Get power supply temperature.

Returns
float: power supply temperature

◆ get_shutter_state()

def laserquantum_laser.LaserQuantumLaser.get_shutter_state (   self)

Get laser shutter state.

Returns
ShutterState: laser shutter state

◆ get_temperature_setpoints()

def laserquantum_laser.LaserQuantumLaser.get_temperature_setpoints (   self)

Get temperature setpints.

Returns
dict: dict of temperature name and setpoint value

◆ get_temperatures()

def laserquantum_laser.LaserQuantumLaser.get_temperatures (   self)

Get all available temperatures.

Returns
dict: dict of temperature names and value

◆ off()

def laserquantum_laser.LaserQuantumLaser.off (   self)

Turn laser off.

Returns
LaserState: actual laser state

◆ on()

def laserquantum_laser.LaserQuantumLaser.on (   self)

Turn laser on.

Returns
LaserState: actual laser state

◆ set_control_mode()

def laserquantum_laser.LaserQuantumLaser.set_control_mode (   self,
  mode 
)

Set laser control mode.

Parameters
ControlModemode: desired control mode
Returns
ControlMode: actual control mode

◆ set_current()

def laserquantum_laser.LaserQuantumLaser.set_current (   self,
  current_percent 
)

Set laser current setpoint.

Parameters
floatcurrent_percent: laser current setpoint

◆ set_laser_state()

def laserquantum_laser.LaserQuantumLaser.set_laser_state (   self,
  status 
)

Set desited laser state.

Parameters
LaserStatestatus: desired laser state
Returns
LaserState: actual laser state

◆ set_power()

def laserquantum_laser.LaserQuantumLaser.set_power (   self,
  power 
)

Set laser power.

Parameters
floatpower: desired laser power in watts

◆ set_shutter_state()

def laserquantum_laser.LaserQuantumLaser.set_shutter_state (   self,
  state 
)

Set the desired laser shutter state.

Parameters
ShutterStatestate: desired laser shutter state
Returns
ShutterState: actual laser shutter state

◆ set_temperatures()

def laserquantum_laser.LaserQuantumLaser.set_temperatures (   self,
  temps 
)

Set temperature for lasers with adjustable temperature for tuning.

Returns
dict: dict with new temperature setpoints

◆ timers()

def laserquantum_laser.LaserQuantumLaser.timers (   self)

Return information about component runtimes.

Returns
str: runtimes of components

The documentation for this class was generated from the following file: