Inheritance diagram for microscope.lights.sapphire.SapphireLaser:

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

	send (self, command)

	clearFault (self)

	flush_buffer (self)

	get_status (self)

	initialize (self)

	disable (self)

	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
None	trigger (self)

Public Member Functions inherited from microscope.abc.SerialDeviceMixin
Public Member Functions inherited from microscope.abc.LightSource
float	power (self)

None	power (self, float power)

float	get_set_power (self)

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

bool	get_is_enabled (self)

None	enable (self)

None	shutdown (self)

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

	get_setting (self, str name)

	get_all_settings (self)

None	set_setting (self, str name, value)

	describe_setting (self, str name)

	describe_settings (self)

	update_settings (self, incoming, bool init=False)

Public Attributes
	connection

Public Attributes inherited from microscope.abc.SerialDeviceMixin
	connection = None

Public Attributes inherited from microscope.abc.Device
bool	enabled = False

Static Public Attributes
dict	laser_status

Protected Member Functions
	_write (self, command)

None	_do_shutdown (self)

	_do_enable (self)

	_get_power_mw (self)

	_set_power_mw (self, mW)

None	_do_set_power (self, float power)

float	_do_get_power (self)

Protected Member Functions inherited from microscope._utils.OnlyTriggersBulbOnSoftwareMixin
None	_do_trigger (self)

Protected Member Functions inherited from microscope.abc.TriggerTargetMixin
Protected Member Functions inherited from microscope.abc.SerialDeviceMixin
bytes	_readline (self)

Protected Member Functions inherited from microscope.abc.LightSource
Protected Member Functions inherited from microscope.abc.Device
	_do_disable (self)

Protected Attributes
	_max_power_mw = float(self.send(b"?maxlp"))

	_min_power = float(self.send(b"?minlp")) / self._max_power_mw

Protected Attributes inherited from microscope.abc.SerialDeviceMixin
	_comms_lock = threading.RLock()

Protected Attributes inherited from microscope.abc.LightSource
float	_set_point = 0.0

Protected Attributes inherited from microscope.abc.Device
dict	_settings = {}

Additional Inherited Members
Static Public Member Functions inherited from microscope.abc.SerialDeviceMixin
	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()

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

◆ _do_enable()

microscope.lights.sapphire.SapphireLaser._do_enable ( self )

protected

Do any device specific work on enable.

Subclasses should override this method, rather than modify
`enable`.

Reimplemented from microscope.abc.Device.

Definition at line 153 of file sapphire.py.

    def _do_enable(self):
        _logger.info("Turning laser ON.")
        # Turn on emission.
        response = self.send(b"l=1")
        _logger.info("l=1: [%s]", response.decode())
 
        # Enabling laser might take more than 500ms (default timeout)
        prevTimeout = self.connection.timeout
        self.connection.timeout = max(1, prevTimeout)
        isON = self.get_is_on()
        self.connection.timeout = prevTimeout
 
        if not isON:
            # Something went wrong.
            _logger.error("Failed to turn on. Current status:\r\n")
            _logger.error(self.get_status())
        return isON
 

◆ _do_get_power()

float microscope.lights.sapphire.SapphireLaser._do_get_power ( self )

protected

Internal function that actually returns the light source power.

Reimplemented from microscope.abc.LightSource.

Definition at line 201 of file sapphire.py.

201 def _do_get_power(self) -> float:

202 return self._get_power_mw() / self._max_power_mw

◆ _do_set_power()

None microscope.lights.sapphire.SapphireLaser._do_set_power	(		self,
		float	power )

protected

Internal function that actually sets the light source power.

This function will be called by the `power` attribute setter
after clipping the argument to the [0, 1] interval.

Reimplemented from microscope.abc.LightSource.

Definition at line 194 of file sapphire.py.

    def _do_set_power(self, power: float) -> None:
        # power is already clipped to the [0 1] range but we need to
        # clip it again since the min power we actually can do is 0.2
        # and we get an error from the laser if we set it to lower.
        power = max(self._min_power, power)
        self._set_power_mw(power * self._max_power_mw)
 

◆ _do_shutdown()

None microscope.lights.sapphire.SapphireLaser._do_shutdown ( self )

protected

Private method - actual shutdown of the device.

Users should be calling :meth:`shutdown` and not this method.
Concrete implementations should implement this method instead
of `shutdown`.

Reimplemented from microscope.abc.Device.

Definition at line 141 of file sapphire.py.

    def _do_shutdown(self) -> None:
        # Disable laser.
        self._write(b"l=0")
        self.flush_buffer()
 

◆ _get_power_mw()

microscope.lights.sapphire.SapphireLaser._get_power_mw ( self )

protected

Definition at line 183 of file sapphire.py.

    def _get_power_mw(self):
        return float(self.send(b"?p"))
 

◆ _set_power_mw()

microscope.lights.sapphire.SapphireLaser._set_power_mw	(		self,
			mW )

protected

Definition at line 187 of file sapphire.py.

    def _set_power_mw(self, mW):
        mW_str = "%.3f" % mW
        _logger.info("Setting laser power to %s mW.", mW_str)
        # using send instead of _write, because
        # if laser is not on, warning is returned
        return self.send(b"p=%s" % mW_str.encode())
 

◆ _write()

microscope.lights.sapphire.SapphireLaser._write	(		self,
			command )

protected

Send a command to the device.

This is not a simple passthrough to ``serial.Serial.write``,
it will append ``b'\\r\\n'`` to command.  Override this method
if a device requires a specific format.

Reimplemented from microscope.abc.SerialDeviceMixin.

Definition at line 85 of file sapphire.py.

    def _write(self, command):
        count = super()._write(command)
        # This device always writes backs something.  If echo is on,
        # it's the whole command, otherwise just an empty line.  Read
        # it and throw it away.
        self._readline()
        return count
 

◆ clearFault()

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()

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")
 

◆ flush_buffer()

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()
 

◆ get_is_on()

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"
 

◆ get_status()

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
 

◆ initialize()

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()
 

◆ send()

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()
 

Member Data Documentation

◆ _max_power_mw

microscope.lights.sapphire.SapphireLaser._max_power_mw = float(self.send(b"?maxlp"))

protected

Definition at line 80 of file sapphire.py.

◆ _min_power

microscope.lights.sapphire.SapphireLaser._min_power = float(self.send(b"?minlp")) / self._max_power_mw

protected

Definition at line 81 of file sapphire.py.

◆ connection

microscope.lights.sapphire.SapphireLaser.connection

Initial value:

=  serial.Serial(
            port=com,
            baudrate=baud,
            timeout=timeout,
            stopbits=serial.STOPBITS_ONE,
            bytesize=serial.EIGHTBITS,
            parity=serial.PARITY_NONE,
        )

Definition at line 60 of file sapphire.py.

◆ laser_status

dict 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.

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

BioImager/PythonMicroscope/microscope/lights/sapphire.py

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _do_enable()

◆ _do_get_power()

◆ _do_set_power()

◆ _do_shutdown()

◆ _get_power_mw()

◆ _set_power_mw()

◆ _write()

◆ clearFault()

◆ disable()

◆ flush_buffer()

◆ get_is_on()

◆ get_status()

◆ initialize()

◆ send()

Member Data Documentation

◆ _max_power_mw

◆ _min_power

◆ connection

◆ laser_status

◆ init()