Inheritance diagram for microscope.lights.sapphire.SapphireLaser:

Public Member Functions
def	__init__ (self, com=None, baud=19200, timeout=0.5, **kwargs)

def	send (self, command)

def	clearFault (self)

def	flush_buffer (self)

def	get_status (self)

def	initialize (self)

def	disable (self)

def	get_is_on (self)

Public Member Functions inherited from microscope._utils.OnlyTriggersBulbOnSoftwareMixin
microscope.TriggerType	trigger_type (self)

microscope.TriggerMode	trigger_mode (self)

None	set_trigger (self, microscope.TriggerType ttype, microscope.TriggerMode tmode)

Public Member Functions inherited from microscope.abc.TriggerTargetMixin
microscope.TriggerMode	trigger_mode (self)

microscope.TriggerType	trigger_type (self)

None	set_trigger (self, microscope.TriggerType ttype, microscope.TriggerMode tmode)

None	trigger (self)

def	__init__ (self, **kwargs)

Public Member Functions inherited from microscope.abc.LightSource
def	__init__ (self, **kwargs)

typing.List[str]	get_status (self)

bool	get_is_on (self)

float	power (self)

None	power (self, float power)

float	get_set_power (self)

Public Member Functions inherited from microscope.abc.Device
None	__init__ (self)

None	__del__ (self)

bool	get_is_enabled (self)

None	disable (self)

None	enable (self)

None	initialize (self)

None	shutdown (self)

None	add_setting (self, name, dtype, get_func, set_func, values, typing.Optional[typing.Callable[[], bool]] readonly=None)

def	get_setting (self, str name)

def	get_all_settings (self)

None	set_setting (self, str name, value)

def	describe_setting (self, str name)

def	describe_settings (self)

def	update_settings (self, incoming, bool init=False)

Public Attributes
	connection

Public Attributes inherited from microscope.abc.SerialDeviceMixin
	connection

Public Attributes inherited from microscope.abc.Device
	enabled

Static Public Attributes
dictionary	laser_status

Additional Inherited Members
Static Public Member Functions inherited from microscope.abc.SerialDeviceMixin
def	lock_comms (func)

Detailed Description

Coherent Sapphire laser.

The Sapphire is a diode-pumped solid-state laser and only supports
`TriggerMode.SOFTWARE`.

Definition at line 34 of file sapphire.py.

Constructor & Destructor Documentation

◆ init()

def microscope.lights.sapphire.SapphireLaser.__init__	(		self,
			com = `None`,
			baud = `19200`,
			timeout = `0.5`,
		**	kwargs
	)

Reimplemented from microscope.abc.SerialDeviceMixin.

Definition at line 55 of file sapphire.py.

    def __init__(self, com=None, baud=19200, timeout=0.5, **kwargs):
        # laser controller must run at 19200 baud, 8+1 bits,
        # no parity or flow control
        # timeout is recomended to be over 0.5
        super().__init__(**kwargs)
        self.connection = serial.Serial(
            port=com,
            baudrate=baud,
            timeout=timeout,
            stopbits=serial.STOPBITS_ONE,
            bytesize=serial.EIGHTBITS,
            parity=serial.PARITY_NONE,
        )
        # Turning off command prompt
        self.send(b">=0")
 
        # The sapphire laser turns on as soon as the key is switched
        # on.  So turn radiation off before we start.
        self.send(b"L=0")
 
        # Head ID value is a float point value,
        # but only the integer part is significant
        headID = int(float(self.send(b"?hid")))
        _logger.info("Sapphire laser serial number: [%s]", headID)
 
        self._max_power_mw = float(self.send(b"?maxlp"))
        self._min_power = float(self.send(b"?minlp")) / self._max_power_mw
 
        self.initialize()
 

Member Function Documentation

◆ clearFault()

def microscope.lights.sapphire.SapphireLaser.clearFault ( self )

Definition at line 99 of file sapphire.py.

    def clearFault(self):
        self.flush_buffer()
        return self.get_status()
 

◆ disable()

def microscope.lights.sapphire.SapphireLaser.disable ( self )

Disable the device for a short period for inactivity.

Reimplemented from microscope.abc.Device.

Definition at line 173 of file sapphire.py.

    def disable(self):
        _logger.info("Turning laser OFF.")
        return self._write(b"l=0")
 

References microscope.abc.SerialDeviceMixin._write(), microscope.lights.deepstar.DeepstarLaser._write(), microscope.lights.obis.ObisLaser._write(), and microscope.lights.sapphire.SapphireLaser._write().

Referenced by microscope.abc.DataDevice.__init__(), microscope.lights.cobolt.CoboltLaser.get_status(), microscope.lights.deepstar.DeepstarLaser.get_status(), microscope.lights.obis.ObisLaser.get_status(), and microscope.abc.Device.shutdown().

◆ flush_buffer()

def microscope.lights.sapphire.SapphireLaser.flush_buffer ( self )

Definition at line 103 of file sapphire.py.

    def flush_buffer(self):
        line = b" "
        while len(line) > 0:
            line = self._readline()
 

Referenced by microscope.lights.sapphire.SapphireLaser.get_status(), microscope.lights.sapphire.SapphireLaser.initialize(), and microscope.lights.sapphire.SapphireLaser.send().

◆ get_is_on()

def microscope.lights.sapphire.SapphireLaser.get_is_on ( self )

Return True if the light source is currently able to produce light.

Reimplemented from microscope.abc.LightSource.

Definition at line 179 of file sapphire.py.

    def get_is_on(self):
        return self.send(b"?l") == b"1"
 

Referenced by microscope.lights.cobolt.CoboltLaser.get_is_on(), microscope.lights.deepstar.DeepstarLaser.get_is_on(), microscope.lights.obis.ObisLaser.get_is_on(), microscope.lights.deepstar.DeepstarLaser.get_status(), microscope.lights.obis.ObisLaser.get_status(), microscope.lights.cobolt.CoboltLaser.initialize(), microscope.lights.obis.ObisLaser.initialize(), and microscope.lights.sapphire.SapphireLaser.initialize().

◆ get_status()

def microscope.lights.sapphire.SapphireLaser.get_status ( self )

Query and return the light source status.

Reimplemented from microscope.abc.LightSource.

Definition at line 109 of file sapphire.py.

    def get_status(self):
        result = []
 
        status_code = self.send(b"?sta")
        result.append(
            (
                "Laser status: "
                + self.laser_status.get(status_code, "Undefined")
            )
        )
 
        for cmd, stat in [
            (b"?l", "Ligh Emission on?"),
            (b"?t", "TEC Servo on?"),
            (b"?k", "Key Switch on?"),
            (b"?sp", "Target power:"),
            (b"?p", "Measured power:"),
            (b"?hh", "Head operating hours:"),
        ]:
            result.append(stat + " " + self.send(cmd).decode())
 
        self._write(b"?fl")
        faults = self._readline()
        response = self._readline()
        while response:
            faults += b" " + response
            response = self._readline()
 
        result.append(faults.decode())
        return result
 

References microscope.abc.SerialDeviceMixin._readline(), microscope.filterwheels.thorlabs.ThorlabsFilterWheel._readline(), microscope.lights.obis.ObisLaser._readline(), microscope.abc.SerialDeviceMixin._write(), microscope.lights.deepstar.DeepstarLaser._write(), microscope.lights.obis.ObisLaser._write(), microscope.lights.sapphire.SapphireLaser._write(), microscope.lights.sapphire.SapphireLaser.flush_buffer(), microscope.lights.sapphire.SapphireLaser.laser_status, microscope.lights.cobolt.CoboltLaser.send(), and microscope.lights.sapphire.SapphireLaser.send().

Referenced by microscope.lights.obis.ObisLaser.get_status(), microscope.lights.cobolt.CoboltLaser.initialize(), microscope.lights.obis.ObisLaser.initialize(), microscope.lights.sapphire.SapphireLaser.initialize(), microscope.lights.cobolt.CoboltLaser.send(), and microscope.lights.sapphire.SapphireLaser.send().

◆ initialize()

def microscope.lights.sapphire.SapphireLaser.initialize ( self )

Initialize the device.

If devices have this method (not required, and many don't),
then they should call it as part of the initialisation, i.e.,
they should call it on their `__init__` method.

Reimplemented from microscope.abc.Device.

Definition at line 148 of file sapphire.py.

    def initialize(self):
        self.flush_buffer()
 

Referenced by microscope.cameras.picam.PiCamera.__init__(), microscope.cameras.ximea.XimeaCamera.__init__(), and microscope.cameras.picam.PiCamera.initialize().

◆ send()

def microscope.lights.sapphire.SapphireLaser.send	(	self,
		command
	)

Send command and retrieve response.

Definition at line 93 of file sapphire.py.

    def send(self, command):
        """Send command and retrieve response."""
        self._write(command)
        return self._readline()
 

Referenced by microscope.lights.cobolt.CoboltLaser.disable(), microscope.lights.cobolt.CoboltLaser.get_is_on(), microscope.lights.sapphire.SapphireLaser.get_is_on(), microscope.lights.cobolt.CoboltLaser.get_status(), microscope.lights.sapphire.SapphireLaser.get_status(), microscope.lights.cobolt.CoboltLaser.initialize(), microscope.lights.sapphire.SapphireLaser.initialize(), and microscope.lights.cobolt.CoboltLaser.send().

Member Data Documentation

◆ connection

microscope.lights.sapphire.SapphireLaser.connection

Definition at line 60 of file sapphire.py.

Referenced by microscope.filterwheels.thorlabs.ThorlabsFilterWheel.__init__(), microscope.lights.cobolt.CoboltLaser.get_status(), microscope.lights.cobolt.CoboltLaser.initialize(), microscope.lights.sapphire.SapphireLaser.initialize(), and microscope.abc.SerialDeviceMixin.lock_comms().

◆ laser_status

dictionary microscope.lights.sapphire.SapphireLaser.laser_status

static

Initial value:

=  {
        b"1": "Start up",
        b"2": "Warmup",
        b"3": "Standby",
        b"4": "Laser on",
        b"5": "Laser ready",
        b"6": "Error",
    }

Definition at line 46 of file sapphire.py.

Referenced by microscope.lights.sapphire.SapphireLaser.get_status().

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

F:/repos/BioImager/BioImager/PythonMicroscope/microscope/lights/sapphire.py

Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members