simple_laser_interface.SimpleLaserInterface Class Reference

Inheritance diagram for simple_laser_interface.SimpleLaserInterface:

Collaboration diagram for simple_laser_interface.SimpleLaserInterface:

Public Member Functions
def	get_power_range (self)
	Return laser power. More...
def	get_power (self)
	Return laser power. More...
def	set_power (self, power)
	Set laer power ins watts. More...
def	get_power_setpoint (self)
	Return laser power setpoint. More...
def	get_current_unit (self)
	Return laser current unit. More...
def	get_current (self)
	Return laser current. More...
def	get_current_range (self)
	Return laser current range. More...
def	get_current_setpoint (self)
	Return laser current. More...
def	set_current (self, current)
	Set laser current. More...
def	allowed_control_modes (self)
	Get available control mode of laser. More...
def	get_control_mode (self)
	Get control mode of laser. More...
def	set_control_mode (self, control_mode)
	Set laser control mode. More...
def	on (self)
	Turn on laser. More...
def	off (self)
	Turn ooff 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 shutter state. More...
def	set_shutter_state (self, state)
	Set shutter state. More...
def	get_temperatures (self)
	Get all available temperatures from laser. More...
def	get_temperature_setpoints (self)
	Get all available temperature setpoints from laser. More...
def	set_temperatures (self, temps)
	Set laser temperatures. More...
def	get_extra_info (self)
	Show dianostic information about lasers. More...
Public Member Functions inherited from core.module.ModuleMeta
def	__new__ (cls, name, bases, attrs)
	Collect declared Connectors, ConfigOptions and StatusVars into dictionaries. More...

Member Function Documentation

allowed_control_modes()

def simple_laser_interface.SimpleLaserInterface.allowed_control_modes

(

self

)

Get available control mode of laser.

Returns

list: list with enum control modes

get_control_mode()

def simple_laser_interface.SimpleLaserInterface.get_control_mode

(

self

)

Get control mode of laser.

Returns

enum ControlMode: control mode

get_current()

def simple_laser_interface.SimpleLaserInterface.get_current

(

self

)

Return laser current.

Returns

float: actual laser current as ampere or percentage of maximum current

get_current_range()

def simple_laser_interface.SimpleLaserInterface.get_current_range

(

self

)

Return laser current range.

Returns

tuple(c1, c2): Laser current range in current units

get_current_setpoint()

def simple_laser_interface.SimpleLaserInterface.get_current_setpoint

(

self

)

Return laser current.

Returns

float: Laser current setpoint in amperes

get_current_unit()

def simple_laser_interface.SimpleLaserInterface.get_current_unit

(

self

)

Return laser current unit.

Returns

str: unit

get_extra_info()

def simple_laser_interface.SimpleLaserInterface.get_extra_info

(

self

)

Show dianostic information about lasers.

Returns

str: diagnostic info as a string

get_laser_state()

def simple_laser_interface.SimpleLaserInterface.get_laser_state

(

self

)

Get laser state.

Returns

enum LaserState: laser state

get_power()

def simple_laser_interface.SimpleLaserInterface.get_power

(

self

)

Return laser power.

Returns

float: Actual laser power in watts

get_power_range()

def simple_laser_interface.SimpleLaserInterface.get_power_range

(

self

)

Return laser power.

Returns

tuple(p1, p2): Laser power range in watts

get_power_setpoint()

def simple_laser_interface.SimpleLaserInterface.get_power_setpoint

(

self

)

Return laser power setpoint.

Returns

float: Laser power setpoint in watts

get_shutter_state()

def simple_laser_interface.SimpleLaserInterface.get_shutter_state

(

self

)

Get shutter state.

Has a state for no shutter present.

Returns

enum ShutterState: actual shutter state

get_temperature_setpoints()

def simple_laser_interface.SimpleLaserInterface.get_temperature_setpoints

(

self

)

Get all available temperature setpoints from laser.

Returns

dict: dict of name, value for temperature setpoints

get_temperatures()

def simple_laser_interface.SimpleLaserInterface.get_temperatures

(

self

)

Get all available temperatures from laser.

Returns

dict: dict of name, value for temperatures

off()

def simple_laser_interface.SimpleLaserInterface.off

(

self

)

Turn ooff laser.

Does not close shutter if one is present.

Returns

enum LaserState: actual laser state

on()

def simple_laser_interface.SimpleLaserInterface.on

(

self

)

Turn on laser.

Does not open shutter if one is present.

Returns

enum LaserState: actual laser state

set_control_mode()

def simple_laser_interface.SimpleLaserInterface.set_control_mode	(		self,
			control_mode
	)

Set laser control mode.

Parameters

enum	control_mode: desired control mode

Returns

enum ControlMode: actual control mode

set_current()

def simple_laser_interface.SimpleLaserInterface.set_current	(		self,
			current
	)

Set laser current.

Parameters

float

current: Laser current setpoint in amperes

Returns

float: Laser current setpoint in amperes

set_laser_state()

def simple_laser_interface.SimpleLaserInterface.set_laser_state	(		self,
			state
	)

Set laser state.

Parameters

enum	state: desired laser state

Returns

enum LaserState: actual laser state

set_power()

def simple_laser_interface.SimpleLaserInterface.set_power	(		self,
			power
	)

Set laer power ins watts.

Parameters

float

power: laser power setpoint in watts

Returns

float: laser power setpoint in watts

set_shutter_state()

def simple_laser_interface.SimpleLaserInterface.set_shutter_state	(		self,
			state
	)

Set shutter state.

Parameters

enum	state: desired shutter state

Returns

enum ShutterState: actual shutter state

set_temperatures()

def simple_laser_interface.SimpleLaserInterface.set_temperatures	(		self,
			temps
	)

Set laser temperatures.

Parameters

temps

dict of name, value to be set

Returns

dict: dict of name, value of temperatures that were set

---

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

• interface/simple_laser_interface.py