simple_laser_dummy.SimpleLaserDummy Class Reference

Lazor dummy. More...

Inheritance diagram for simple_laser_dummy.SimpleLaserDummy:

Collaboration diagram for simple_laser_dummy.SimpleLaserDummy:

Public Member Functions
def	__init__ (self, kwargs)
def	on_activate (self)
	Activate module.
def	on_deactivate (self)
	Deactivate module.
def	get_power_range (self)
	Return optical power range. More...
def	get_power (self)
	Return laser power. More...
def	get_power_setpoint (self)
	Return optical power setpoint. More...
def	set_power (self, power)
	Set power setpoint. More...
def	get_current_unit (self)
	Get unit for laser current. More...
def	get_current_range (self)
	Get laser current range. More...
def	get_current (self)
	Get current laser current. More...
def	get_current_setpoint (self)
	Get laser curent setpoint. More...
def	set_current (self, current)
	Set laser current setpoint. More...
def	allowed_control_modes (self)
	Get supported control modes. More...
def	get_control_mode (self)
	Get the currently active control mode. More...
def	set_control_mode (self, control_mode)
	Set the active control mode. More...
def	on (self)
	Turn on laser. More...
def	off (self)
	Turn off laser. More...
def	get_laser_state (self)
	Get laser state. More...
def	set_laser_state (self, state)
	Set laser state. More...
def	get_shutter_state (self)
	Get laser shutter state. More...
def	set_shutter_state (self, state)
	Set laser shutter state. More...
def	get_temperatures (self)
	Get all available temperatures. More...
def	set_temperatures (self, temps)
	Set temperatures for lasers with tunable temperatures. More...
def	get_temperature_setpoints (self)
	Get temperature setpoints. More...
def	get_extra_info (self)
	Multiple lines of dignostic information. 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
	lstate
	shutter
	mode
	current_setpoint
	power_setpoint
Public Attributes inherited from core.module.BaseMixin
	module_state
	connectors

Detailed Description

Lazor dummy.

Example config for copy-paste:

laser_dummy: module 'laser.simple_laser_dummy.SimpleLaserDummy'

Constructor & Destructor Documentation

__init__()

def simple_laser_dummy.SimpleLaserDummy.__init__	(		self,
			kwargs
	)

Member Function Documentation

allowed_control_modes()

def simple_laser_dummy.SimpleLaserDummy.allowed_control_modes

(

self

)

Get supported control modes.

Returns

list(): list of supported ControlMode

get_control_mode()

def simple_laser_dummy.SimpleLaserDummy.get_control_mode

(

self

)

Get the currently active control mode.

Returns

ControlMode: active control mode

get_current()

def simple_laser_dummy.SimpleLaserDummy.get_current

(

self

)

Get current laser current.

Returns

float: laser current in current curent units

get_current_range()

def simple_laser_dummy.SimpleLaserDummy.get_current_range

(

self

)

Get laser current range.

Returns

(float, float): laser current range

get_current_setpoint()

def simple_laser_dummy.SimpleLaserDummy.get_current_setpoint

(

self

)

Get laser curent setpoint.

Returns

float: laser current setpoint

get_current_unit()

def simple_laser_dummy.SimpleLaserDummy.get_current_unit

(

self

)

Get unit for laser current.

Returns

str: unit

get_extra_info()

def simple_laser_dummy.SimpleLaserDummy.get_extra_info

(

self

)

Multiple lines of dignostic information.

Returns

str: much laser, very useful

get_laser_state()

def simple_laser_dummy.SimpleLaserDummy.get_laser_state

(

self

)

Get laser state.

Returns

LaserState: actual laser state

get_power()

def simple_laser_dummy.SimpleLaserDummy.get_power

(

self

)

Return laser power.

Returns

float: Laser power in watts

get_power_range()

def simple_laser_dummy.SimpleLaserDummy.get_power_range

(

self

)

Return optical power range.

Returns

(float, float): power range

get_power_setpoint()

def simple_laser_dummy.SimpleLaserDummy.get_power_setpoint

(

self

)

Return optical power setpoint.

Returns

float: power setpoint in watts

get_shutter_state()

def simple_laser_dummy.SimpleLaserDummy.get_shutter_state

(

self

)

Get laser shutter state.

Returns

ShutterState: actual laser shutter state

get_temperature_setpoints()

def simple_laser_dummy.SimpleLaserDummy.get_temperature_setpoints

(

self

)

Get temperature setpoints.

Returns

dict: temperature setpoints for temperature tunable lasers

get_temperatures()

def simple_laser_dummy.SimpleLaserDummy.get_temperatures

(

self

)

Get all available temperatures.

Returns

dict: dict of temperature namce and value in degrees Celsius

off()

def simple_laser_dummy.SimpleLaserDummy.off

(

self

)

Turn off laser.

Returns

LaserState: actual laser state

on()

def simple_laser_dummy.SimpleLaserDummy.on

(

self

)

Turn on laser.

Returns

LaserState: actual laser state

set_control_mode()

def simple_laser_dummy.SimpleLaserDummy.set_control_mode	(		self,
			control_mode
	)

Set the active control mode.

Parameters

ControlMode

control_mode: desired control mode

Returns

ControlMode: actual active ControlMode

set_current()

def simple_laser_dummy.SimpleLaserDummy.set_current	(		self,
			current
	)

Set laser current setpoint.

float current: desired laser current setpoint

Returns

float: actual laser current setpoint

set_laser_state()

def simple_laser_dummy.SimpleLaserDummy.set_laser_state	(		self,
			state
	)

Set laser state.

Parameters

LaserState

state: desired laser state

Returns

LaserState: actual laser state

set_power()

def simple_laser_dummy.SimpleLaserDummy.set_power	(		self,
			power
	)

Set power setpoint.

Parameters

float

power: power setpoint

Returns

float: actual new power setpoint

set_shutter_state()

def simple_laser_dummy.SimpleLaserDummy.set_shutter_state	(		self,
			state
	)

Set laser shutter state.

Parameters

ShutterState

state: desired laser shutter state

Returns

ShutterState: actual laser shutter state

set_temperatures()

def simple_laser_dummy.SimpleLaserDummy.set_temperatures	(		self,
			temps
	)

Set temperatures for lasers with tunable temperatures.

Returns

{}: empty dict, dummy not a tunable laser

---

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

• hardware/laser/simple_laser_dummy.py