Qudi
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
edwards_vacuum_controller.EdwardsVacuumController Class Reference

This module implements communication with Edwards turbopump and vacuum PIC. More...

Inheritance diagram for edwards_vacuum_controller.EdwardsVacuumController:
Inheritance graph
[legend]
Collaboration diagram for edwards_vacuum_controller.EdwardsVacuumController:
Collaboration graph
[legend]

Public Member Functions

def on_activate (self)
 Activate module.
 
def on_deactivate (self)
 Deactivate module. More...
 
def connect_tic (self, interface)
 Connect to Instrument. More...
 
def disconnect_tic (self)
 Close connection to instrument.
 
def get_pressures (self)
 Get all pressures. More...
 
def get_turbo_status (self)
 Get state of turbo pump. More...
 
def get_turbo_speed (self)
 Get turbo pump speed.
 
def get_turbo_power (self)
 Get turbo pump power.
 
def get_backing_status (self)
 Get backing pump status.
 
def get_backing_speed (self)
 Get backing pump speed.
 
def get_backing_power (self)
 Get backing pump power.
 
def get_gauge1 (self)
 Get gauge 1 pressure.
 
def get_gauge2 (self)
 Get gauge 2 pressure.
 
def get_gauge3 (self)
 Get gauge 3 pressure.
 
def get_extra_info (self)
 Get extra information about pumping system.
 
def get_pump_speeds (self)
 Get pump speeds.
 
def get_pump_powers (self)
 Get pump powers.
 
def get_pump_states (self)
 Get pump states.
 
def set_pump_states (self, states)
 St pump states.
 
def get_system_state (self)
 Get system state.
 
def set_system_state (self, state)
 Set system state.
 
- 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

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

Static Public Attributes

dictionary PRIORITY
 
dictionary ALERT_ID
 
dictionary GAS_TYPE
 
dictionary GAUGE_TYPE
 
dictionary GAUGE_STATE
 
dictionary GAUGE_UNIT
 
dictionary PUMP_STATE
 
dictionary PUMP_TYPE
 
dictionary GENERAL_STATE
 

Detailed Description

This module implements communication with Edwards turbopump and vacuum PIC.

ATTENTION This module is not complete or functional.

Example config for copy-paste:

vacuum_control_edwards: module 'edwards_vacuum_controller.EdwardsVacuumController' interface 'ASRL1::INSTR'

Member Function Documentation

◆ connect_tic()

def edwards_vacuum_controller.EdwardsVacuumController.connect_tic (   self,
  interface 
)

Connect to Instrument.

Parameters
strinterface: visa interface identifier
Returns
bool: connection success

◆ get_pressures()

def edwards_vacuum_controller.EdwardsVacuumController.get_pressures (   self)

Get all pressures.

Returns
dict: dict of gauge names and pressures

◆ get_turbo_status()

def edwards_vacuum_controller.EdwardsVacuumController.get_turbo_status (   self)

Get state of turbo pump.

Returns
dict: stae of turbo pump

◆ on_deactivate()

def edwards_vacuum_controller.EdwardsVacuumController.on_deactivate (   self)

Deactivate module.

Parameters
objecte: fysom state transition information

Member Data Documentation

◆ GAS_TYPE

dictionary edwards_vacuum_controller.EdwardsVacuumController.GAS_TYPE
static
Initial value:
= {
0: 'Nitrogen',
1: 'Helium',
2: 'Argon',
3: 'Carbon Dioxide',
4: 'Neon',
5: 'Krypton',
6: 'Voltage'
}

◆ GAUGE_STATE

dictionary edwards_vacuum_controller.EdwardsVacuumController.GAUGE_STATE
static
Initial value:
= {
0: 'Gauge Not connected',
1: 'Gauge Connected',
2: 'New Gauge Id',
3: 'Gauge Change',
4: 'Gauge In Alert',
5: 'Off',
6: 'Striking',
7: 'Initialising',
8: 'Calibrating',
9: 'Zeroing',
10: 'Degassing',
11: 'On',
12: 'Inhibited'
}

◆ GAUGE_TYPE

dictionary edwards_vacuum_controller.EdwardsVacuumController.GAUGE_TYPE
static
Initial value:
= {
0 : 'Unknown Device',
1 : 'No Device',
2 : 'EXP_CM',
3 : 'EXP_STD',
4 : 'CMAN_S',
5 : 'CMAN_D',
6 : 'TURBO',
7 : 'APGM',
8 : 'APGL',
9 : 'APGXM',
10: 'APGXH',
11: 'APGXL',
12: 'ATCA',
13: 'ATCD',
14: 'ATCM',
15: 'WRG',
16: 'AIMC',
17: 'AIMN',
18: 'AIMS',
19: 'AIMX',
20: 'AIGC_I2R',
21: 'AIGC_2FIL',
22: 'ION_EB',
23: 'AIGXS',
24: 'USER',
25: 'ASG'
}

◆ GAUGE_UNIT

dictionary edwards_vacuum_controller.EdwardsVacuumController.GAUGE_UNIT
static
Initial value:
= {
66: 'Voltage',
59: 'Pressure',
81: 'Percent'
}

◆ GENERAL_STATE

dictionary edwards_vacuum_controller.EdwardsVacuumController.GENERAL_STATE
static
Initial value:
= {
0: 'Off',
1: 'Off, turning on',
2: 'On, turning off to shutdown',
3: 'On, turning off normal',
4: 'On'
}

◆ PRIORITY

dictionary edwards_vacuum_controller.EdwardsVacuumController.PRIORITY
static
Initial value:
= {
0: 'OK',
1: 'Warning',
2: 'Alarm',
3: 'Alarm'
}

◆ PUMP_STATE

dictionary edwards_vacuum_controller.EdwardsVacuumController.PUMP_STATE
static
Initial value:
= {
0: 'Stopped',
1: 'Starting Delay',
2: 'Stopping Short Delay',
3: 'Stopping Normal Delay',
4: 'Running',
5: 'Accelerating',
6: 'Fault Braking',
7: 'Braking'
}

◆ PUMP_TYPE

dictionary edwards_vacuum_controller.EdwardsVacuumController.PUMP_TYPE
static
Initial value:
= {
0: 'No pump',
1: 'EXDC pump',
3: 'EXT75DX pump',
4: 'Ext255DX',
8: 'Mains backing pump',
9: 'Serial pump (temporary)',
10: 'nEXT-485',
11: 'nExt-232',
99: 'not yet identified'
}

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