microscope.testsuite.mock_devices.OmicronDeepstarLaserMock Class Reference

Inheritance diagram for microscope.testsuite.mock_devices.OmicronDeepstarLaserMock:

Classes
class	Mode
class	State

Public Member Functions
def	__init__ (self, *args, **kwargs)
def	light (self)
def	write (self, data)
def	handle (self, command)
Public Member Functions inherited from microscope.testsuite.mock_devices.SerialMock
def	__init__ (self, *args, **kwargs)
def	open (self)
def	close (self)
def	handle (self, command)
def	write (self, data)
def	read (self, size=1)
def	readline (self, size=-1)
def	reset_input_buffer (self)
def	reset_output_buffer (self)

Public Attributes
	power
	state
	mode
	internal_peak_power
	analog2digital
	bias_modulation
	digital_modulation
Public Attributes inherited from microscope.testsuite.mock_devices.SerialMock
	in_buffer
	out_buffer
	out_pending_bytes
	out_parsed_bytes
	in_read_bytes

Static Public Attributes
string	eol = b"\r\n"
int	baudrate = 9600
	parity = serial.PARITY_NONE
	bytesize = serial.EIGHTBITS
	stopbits = serial.STOPBITS_ONE
bool	rtscts = False
bool	dsrdtr = False
float	default_power = 50.0
float	min_power = 0.0
float	max_power = 200.0
	command2mode
dictionary	mode2answer

Detailed Description

Modelled after a TA Deepstar 488nm.

Definition at line 474 of file mock_devices.py.

Constructor & Destructor Documentation

__init__()

def microscope.testsuite.mock_devices.OmicronDeepstarLaserMock.__init__	(		self,
		*	args,
		**	kwargs
	)

Reimplemented from microscope.testsuite.mock_devices.SerialMock.

Definition at line 516 of file mock_devices.py.

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
 
        self.power = self.default_power
 
        self.state = self.State.S1  # default dependent on 'ASx' command
        self.mode = self.Mode.blackout
 
        self.internal_peak_power = False
        self.analog2digital = False
        self.bias_modulation = False
        self.digital_modulation = False
 

Member Function Documentation

handle()

def microscope.testsuite.mock_devices.OmicronDeepstarLaserMock.handle	(		self,
			command
	)

Reimplemented from microscope.testsuite.mock_devices.SerialMock.

Definition at line 548 of file mock_devices.py.

    def handle(self, command):
        if len(command) != 16 and (
            len(command) != 7 and self.state != self.State.S2
        ):
            # Such a thing will make the laser go into S0 state which
            # will also turns it off..  We don't model this because
            # we don't know well how the reset (RST command) works.
            raise RuntimeError("invalid Omicron Deepstar command")
        elif command[-2:] != b"\r\n":
            # Even if a command is correct, the last two characters
            # need to be \r\n.
            raise RuntimeError("command does not end in '\\r\\n'")
 
        command = command[:-2].rstrip(b" ")
        answer = None
 
        if command == b"S?":
            answer = self.state.name.encode()
        elif command == b"STAT0":
            # Model-code of the connected lasersystem:
            answer = (
                b"MC"
                + b" 488"  # wavelength
                + b" "  # empty for single diode system (D for double)
                + b" %3d" % (self.max_power)  # in mw
                + b" TA   "
            )  # controller version / operating mode
        elif command == b"STAT1":
            answer = (
                b"SL"
                + b" 6AB"  # actual bias (hexadecimal)
                + b" 600"  # modulated bias-level (hexadecimal)
                + b" 868"  # mod-level internal set for drive max. current
                + b" T249"  # diode temperature (in celcius * 10)
                + b" V117"
            )  # control voltage (in volts * 10)
        elif command == b"STAT2":
            answer = (
                b"R111"  # firmware release
                + b" N02"  # No used laserpen
                + b" SNP131056"  # S/No of laserhead
                + b" SNC131056"  # S/No of controller
                + b" WH 04667"  # working hours
                + b" SLS B9C 500"
            )  # start values for the diode parameters
        elif command == b"STAT3":
            # Stored option code flags.
            answer = (
                b"OC "
                + b"AS1"  # autostart option
                + b"TH0"  # TTL-logic-high
                + b"AP0"  # auto power correction
                + b"FK0"  # fiber coupling single mode
                + b"AC0"  # analog modulation for CW-lasers
                + b"AM0"  # analog modulation for modulated lasers
                + b"SU0"  # subtractive analog modulation for modulated lasers
                + b"CO0"  # collimator optic
                + b"FO0"  # focusing optic
                + b"MO0"  # highspeed monitoring
                + b"US0"  # USB interface
                + b"LA1"  # RS232 interface
                + b"FA0"
            )  # fiber coupling single mode
 
        # Changing mode
        elif command in self.command2mode.keys():
            if self.state == self.State.S2:
                self.mode = self.command2mode[command]
                answer = b">"
            else:
                answer = b"UK"
 
        # Current mode (undocumented)
        elif command == b"L?":
            if self.state == self.State.S2:
                answer = self.mode2answer[self.mode]
            else:
                answer = b"UK"
 
        # Laser on
        elif command == b"LON":
            if self.state == self.State.S1:
                self.state = self.State.S2
                answer = b"LONOK"
            elif self.mode == self.Mode.S2:
                answer = b"UK"
            else:  # in S0 state
                # This is undocumented and it's probably a bug on
                # their firmware.  Should probably be returning UK.
                answer = b"INT"
 
        # Laser off
        elif command == b"LF":
            if self.state == self.State.S2:
                self.state = self.State.S1
                answer = b"LOFFOK"
            else:
                answer = b"UK"
 
        # Peak Power
        elif command.startswith(b"PP"):
            # peak power values are a 3 byte char hexadecimal number,
            # scale to the range of possible power:
            #     000[hex] =    0[dec] =   0% =   0 mW
            #     FFF[hex] = 4095[dec] = 100% = 200 mW
            if command == b"PP?":
                level = self.power / self.max_power
                answer = b"PP%03X" % round(float(0xFFF) * level)
            elif len(command) == 5:
                level = int(command[2:], 16) / float(0xFFF)
                self.power = level * self.max_power
                answer = command
            else:
                raise RuntimeError("invalid command '%'" % command)
 
        # Power level
        elif command == b"P?":
            # TODO: get a laser that supports this command to test.
            # This is only based on the documentation.
            #
            # Actual laser power is a 4 byte char heaxadecimal
            # number.  Range for actual laser power is:
            #     0x0000 =    0 [dec] =   0% =   0 mW
            #     0x0CCC = 3276 [dec] = 100% = 200 mW
            #     0x0FFF = 4095 [dec] = 120% = 240 mW
            level = self.power / self.max_power
            answer = b"P%04X" % round(float(0xCCC) * level)
 
        # Internal peak power
        elif command == b"IPO":
            self.internal_peak_power = True
            answer = command
        elif command == b"IPF":
            self.internal_peak_power = False
            answer = command
        elif command == b"IP?":
            answer = b"IPO" if self.internal_peak_power else b"IPF"
 
        # Analogue modulation path or signal linked to the digital
        # modulation path.
        elif command == b"A2DO":
            self.analog2digital = True
            answer = b"A2D ON"
        elif command == b"A2DF":
            self.analog2digital = False
            answer = b"A2D OFF"
        elif command == b"A2D?":
            answer = b"A2D ON" if self.analog2digital else b"A2D OFF"
 
        # Bias and Digital modulation
        elif command == b"MF":
            self.bias_modulation = False
            self.digital_modulation = False
            answer = command
        elif command == b"MO1":
            self.bias_modulation = True
            self.digital_modulation = False
            answer = command
        elif command == b"MO2":
            self.bias_modulation = False
            self.digital_modulation = True
            answer = command
        elif command == b"MO3":
            self.bias_modulation = True
            self.digital_modulation = True
            answer = command
 
        else:
            raise NotImplementedError(
                "no handling for command '%s'" % command.decode("utf-8")
            )
 
        self.in_buffer.write(answer + self.eol)

Referenced by microscope.cameras._SDK3Cam.SDK3Camera.__init__(), microscope.cameras.pvcam.PVCamera.abort(), microscope.cameras.andorsdk3.AndorSDK3.get_id(), microscope.cameras.andorsdk3.AndorSDK3.initialize(), microscope.cameras.pvcam.PVCamera.initialize(), microscope.cameras.andorsdk3.AndorSDK3.invalidate_buffers(), microscope.cameras.pvcam.PVCamera.set_trigger(), and microscope.cameras.pvcam.PVCamera.soft_trigger().

light()

def microscope.testsuite.mock_devices.OmicronDeepstarLaserMock.light

(

self

)

Definition at line 530 of file mock_devices.py.

    def light(self):
        if (
            self.state != self.State.S2
            or self.mode == self.mode.blackout
            or not self.internal_peak_power
            or (self.analog2digital and not self.digital_modulation)
        ):
            return False
        return True
 

write()

def microscope.testsuite.mock_devices.OmicronDeepstarLaserMock.write	(		self,
			data
	)

Reimplemented from microscope.testsuite.mock_devices.SerialMock.

Definition at line 540 of file mock_devices.py.

    def write(self, data):
        # This connection does not wait for an eol to parse the
        # command.  It only looks at 16 or 7 bit (depending on
        # state).  Sending a message one character at a time will not
        # work so just send the whole data to be handled.
        self.handle(data)
        return len(data)
 

Member Data Documentation

analog2digital

microscope.testsuite.mock_devices.OmicronDeepstarLaserMock.analog2digital

Definition at line 525 of file mock_devices.py.

baudrate

int microscope.testsuite.mock_devices.OmicronDeepstarLaserMock.baudrate = 9600

static

Definition at line 479 of file mock_devices.py.

bias_modulation

microscope.testsuite.mock_devices.OmicronDeepstarLaserMock.bias_modulation

Definition at line 526 of file mock_devices.py.

bytesize

microscope.testsuite.mock_devices.OmicronDeepstarLaserMock.bytesize = serial.EIGHTBITS

static

Definition at line 481 of file mock_devices.py.

command2mode

microscope.testsuite.mock_devices.OmicronDeepstarLaserMock.command2mode

static

Definition at line 502 of file mock_devices.py.

default_power

float microscope.testsuite.mock_devices.OmicronDeepstarLaserMock.default_power = 50.0

static

Definition at line 487 of file mock_devices.py.

digital_modulation

microscope.testsuite.mock_devices.OmicronDeepstarLaserMock.digital_modulation

Definition at line 527 of file mock_devices.py.

dsrdtr

bool microscope.testsuite.mock_devices.OmicronDeepstarLaserMock.dsrdtr = False

static

Definition at line 484 of file mock_devices.py.

eol

string microscope.testsuite.mock_devices.OmicronDeepstarLaserMock.eol = b"\r\n"

static

Definition at line 477 of file mock_devices.py.

Referenced by microscope.filterwheels.thorlabs.ThorlabsFilterWheel.__init__().

internal_peak_power

microscope.testsuite.mock_devices.OmicronDeepstarLaserMock.internal_peak_power

Definition at line 524 of file mock_devices.py.

max_power

float microscope.testsuite.mock_devices.OmicronDeepstarLaserMock.max_power = 200.0

static

Definition at line 489 of file mock_devices.py.

min_power

float microscope.testsuite.mock_devices.OmicronDeepstarLaserMock.min_power = 0.0

static

Definition at line 488 of file mock_devices.py.

mode

microscope.testsuite.mock_devices.OmicronDeepstarLaserMock.mode

Definition at line 522 of file mock_devices.py.

mode2answer

dictionary microscope.testsuite.mock_devices.OmicronDeepstarLaserMock.mode2answer

static

Initial value:

=  {
        Mode.blackout: b"L0",  # always L0, even if BLK was used
        Mode.bias: b"LB",
        Mode.modulated: b"L1",
        Mode.deepstar: b"L2",
    }

Definition at line 509 of file mock_devices.py.

parity

microscope.testsuite.mock_devices.OmicronDeepstarLaserMock.parity = serial.PARITY_NONE

static

Definition at line 480 of file mock_devices.py.

power

microscope.testsuite.mock_devices.OmicronDeepstarLaserMock.power

Definition at line 519 of file mock_devices.py.

rtscts

bool microscope.testsuite.mock_devices.OmicronDeepstarLaserMock.rtscts = False

static

Definition at line 483 of file mock_devices.py.

state

microscope.testsuite.mock_devices.OmicronDeepstarLaserMock.state

Definition at line 521 of file mock_devices.py.

stopbits

microscope.testsuite.mock_devices.OmicronDeepstarLaserMock.stopbits = serial.STOPBITS_ONE

static

Definition at line 482 of file mock_devices.py.

---

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

• F:/repos/BioImager/BioImager/PythonMicroscope/microscope/testsuite/mock_devices.py