Implements the Coherent OBIS laser. More...
Inheritance diagram for coherent_obis_laser.OBISLaser:
Collaboration diagram for coherent_obis_laser.OBISLaser:
Public Member Functions | |
| def | on_activate (self) |
| Activate module. | |
| def | on_deactivate (self) |
| Deactivate module. | |
| def | connect_laser (self) |
| 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_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_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_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 | |
| obis | |
| Public Attributes inherited from core.module.BaseMixin | |
| module_state | |
| connectors | |
Static Public Attributes | |
| string | eol = '\r' |
Detailed Description
Implements the Coherent OBIS laser.
Example config for copy-paste:
obis_laser: module 'laser.coherent_obis_laser.OBISLaser' com_port 'COM3'
Member Function Documentation
◆ connect_laser()
| def coherent_obis_laser.OBISLaser.connect_laser | ( | self | ) |
Connect to Instrument.
- Returns
- bool: connection success
◆ get_control_mode()
| def coherent_obis_laser.OBISLaser.get_control_mode | ( | self | ) |
Get current laser control mode.
- Returns
- ControlMode: current laser control mode
◆ get_current()
| def coherent_obis_laser.OBISLaser.get_current | ( | self | ) |
Cet current laser current.
- Returns
- float: current laser current in amps
◆ get_current_range()
| def coherent_obis_laser.OBISLaser.get_current_range | ( | self | ) |
Get range for laser current.
- Returns
- tuple(flaot, float): range for laser current
◆ get_current_setpoint()
| def coherent_obis_laser.OBISLaser.get_current_setpoint | ( | self | ) |
Current laser current setpoint.
- Returns
- float: laser current setpoint
◆ get_current_unit()
| def coherent_obis_laser.OBISLaser.get_current_unit | ( | self | ) |
Get unit for laser current.
- Returns
- str: unit for laser curret
◆ get_extra_info()
| def coherent_obis_laser.OBISLaser.get_extra_info | ( | self | ) |
Extra information from laser.
- Returns
- str: multiple lines of text with information about laser
◆ get_laser_state()
| def coherent_obis_laser.OBISLaser.get_laser_state | ( | self | ) |
Get laser operation state.
- Returns
- LaserState: laser state
◆ get_power()
| def coherent_obis_laser.OBISLaser.get_power | ( | self | ) |
Get laser power.
- Returns
- float: laser power in watts
◆ get_power_range()
| def coherent_obis_laser.OBISLaser.get_power_range | ( | self | ) |
Get laser power range.
- Returns
- tuple(float, float): laser power range
◆ get_power_setpoint()
| def coherent_obis_laser.OBISLaser.get_power_setpoint | ( | self | ) |
Get the laser power setpoint.
- Returns
- float: laser power setpoint in watts
◆ get_shutter_state()
| def coherent_obis_laser.OBISLaser.get_shutter_state | ( | self | ) |
Get laser shutter state.
- Returns
- ShutterState: laser shutter state
◆ get_temperature_setpoints()
| def coherent_obis_laser.OBISLaser.get_temperature_setpoints | ( | self | ) |
Get temperature setpints.
- Returns
- dict: dict of temperature name and setpoint value
◆ get_temperatures()
| def coherent_obis_laser.OBISLaser.get_temperatures | ( | self | ) |
Get all available temperatures.
- Returns
- dict: dict of temperature names and value
◆ off()
| def coherent_obis_laser.OBISLaser.off | ( | self | ) |
Turn laser off.
- Returns
- LaserState: actual laser state
◆ on()
| def coherent_obis_laser.OBISLaser.on | ( | self | ) |
Turn laser on.
- Returns
- LaserState: actual laser state
◆ set_control_mode()
| def coherent_obis_laser.OBISLaser.set_control_mode | ( | self, | |
| mode | |||
| ) |
Set laser control mode.
- Parameters
-
ControlMode mode: desired control mode
- Returns
- ControlMode: actual control mode
◆ set_current()
| def coherent_obis_laser.OBISLaser.set_current | ( | self, | |
| current_percent | |||
| ) |
Set laser current setpoint.
- Parameters
-
float current_percent: laser current setpoint
◆ set_laser_state()
| def coherent_obis_laser.OBISLaser.set_laser_state | ( | self, | |
| status | |||
| ) |
Set desited laser state.
- Parameters
-
LaserState status: desired laser state
- Returns
- LaserState: actual laser state
◆ set_power()
| def coherent_obis_laser.OBISLaser.set_power | ( | self, | |
| power | |||
| ) |
Set laser power.
- Parameters
-
float power: desired laser power in watts
◆ set_shutter_state()
| def coherent_obis_laser.OBISLaser.set_shutter_state | ( | self, | |
| state | |||
| ) |
Set the desired laser shutter state.
- Parameters
-
ShutterState state: desired laser shutter state
- Returns
- ShutterState: actual laser shutter state
◆ set_temperatures()
| def coherent_obis_laser.OBISLaser.set_temperatures | ( | self, | |
| temps | |||
| ) |
Set temperature for lasers with adjustable temperature for tuning.
- Returns
- dict: dict with new temperature setpoints
The documentation for this class was generated from the following file:
- hardware/laser/coherent_obis_laser.py
