microscope.lights.cobolt.CoboltLaser Class Reference

Inheritance diagram for microscope.lights.cobolt.CoboltLaser:

Public Member Functions
	__init__ (self, com=None, baud=115200, timeout=0.1, **kwargs)
	send (self, command)
	clearFault (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

Protected Member Functions
None	_do_shutdown (self)
	_do_enable (self)
float	_get_power_mw (self)
None	_set_power_mw (self, float 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)
int	_write (self, bytes command)
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"gmlp?"))
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

Cobolt lasers.

The cobolt lasers are diode pumped lasers and only supports
`TriggerMode.SOFTWARE` (this is probably not completely true, some
cobolt lasers are probably not diode pumped and those should be
able to support other trigger modes, but we only got access to the
04 series).

Definition at line 32 of file cobolt.py.

Constructor & Destructor Documentation

__init__()

microscope.lights.cobolt.CoboltLaser.__init__	(		self,
			com = None,
			baud = 115200,
			timeout = 0.1,
		**	kwargs )

Reimplemented from microscope.abc.SerialDeviceMixin.

Definition at line 47 of file cobolt.py.

    def __init__(self, com=None, baud=115200, timeout=0.1, **kwargs):
        super().__init__(**kwargs)
        self.connection = serial.Serial(
            port=com,
            baudrate=baud,
            timeout=timeout,
            stopbits=serial.STOPBITS_ONE,
            bytesize=serial.EIGHTBITS,
            parity=serial.PARITY_NONE,
        )
        # Start a logger.
        response = self.send(b"sn?")
        _logger.info("Cobolt laser serial number: [%s]", response.decode())
        # We need to ensure that autostart is disabled so that we can switch emission
        # on/off remotely.
        response = self.send(b"@cobas 0")
        _logger.info("Response to @cobas 0 [%s]", response.decode())
 
        self._max_power_mw = float(self.send(b"gmlp?"))
 
        self.initialize()
 

Member Function Documentation

_do_enable()

microscope.lights.cobolt.CoboltLaser._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 119 of file cobolt.py.

    def _do_enable(self):
        _logger.info("Turning laser ON.")
        # Turn on emission.
        response = self.send(b"l1")
        _logger.info("l1: [%s]", response.decode())
 
        if not self.get_is_on():
            # Something went wrong.
            _logger.error("Failed to turn on. Current status:\r\n")
            _logger.error(self.get_status())
            return False
        return True
 

_do_get_power()

float microscope.lights.cobolt.CoboltLaser._do_get_power ( self )

protected

Internal function that actually returns the light source power.

Reimplemented from microscope.abc.LightSource.

Definition at line 167 of file cobolt.py.

    def _do_get_power(self) -> float:
        return self._get_power_mw() / self._max_power_mw

_do_set_power()

None microscope.lights.cobolt.CoboltLaser._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 164 of file cobolt.py.

    def _do_set_power(self, power: float) -> None:
        self._set_power_mw(power * self._max_power_mw)
 

_do_shutdown()

None microscope.lights.cobolt.CoboltLaser._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 102 of file cobolt.py.

    def _do_shutdown(self) -> None:
        # Disable laser.
        self.disable()
        self.send(b"@cob0")
        self.connection.flushInput()
 

_get_power_mw()

float microscope.lights.cobolt.CoboltLaser._get_power_mw ( self )

protected

Definition at line 145 of file cobolt.py.

    def _get_power_mw(self) -> float:
        if not self.get_is_on():
            return 0.0
        success = False
        # Sometimes the controller returns b'1' rather than the power.
        while not success:
            response = self.send(b"pa?")
            if response != b"1":
                success = True
        return 1000 * float(response)
 

_set_power_mw()

None microscope.lights.cobolt.CoboltLaser._set_power_mw ( self, float mW )

protected

Definition at line 157 of file cobolt.py.

    def _set_power_mw(self, mW: float) -> None:
        # There is no minimum power in cobolt lasers.  Any
        # non-negative number is accepted.
        W_str = "%.4f" % (mW / 1000.0)
        _logger.info("Setting laser power to %s W.", W_str)
        return self.send(b"@cobasp " + W_str.encode())
 

clearFault()

microscope.lights.cobolt.CoboltLaser.clearFault

(

self

)

Definition at line 83 of file cobolt.py.

    def clearFault(self):
        self.send(b"cf")
        return self.get_status()
 

disable()

microscope.lights.cobolt.CoboltLaser.disable

(

self

)

Disable the device for a short period for inactivity.

Reimplemented from microscope.abc.Device.

Definition at line 134 of file cobolt.py.

    def disable(self):
        _logger.info("Turning laser OFF.")
        return self.send(b"l0").decode()
 

get_is_on()

microscope.lights.cobolt.CoboltLaser.get_is_on

(

self

)

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

Reimplemented from microscope.abc.LightSource.

Definition at line 140 of file cobolt.py.

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

get_status()

microscope.lights.cobolt.CoboltLaser.get_status

(

self

)

Query and return the light source status.

Reimplemented from microscope.abc.LightSource.

Definition at line 88 of file cobolt.py.

    def get_status(self):
        result = []
        for cmd, stat in [
            (b"l?", "Emission on?"),
            (b"p?", "Target power:"),
            (b"pa?", "Measured power:"),
            (b"f?", "Fault?"),
            (b"hrs?", "Head operating hours:"),
        ]:
            response = self.send(cmd)
            result.append(stat + " " + response.decode())
        return result
 

initialize()

microscope.lights.cobolt.CoboltLaser.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 110 of file cobolt.py.

    def initialize(self):
        self.connection.flushInput()
        # We don't want 'direct control' mode.
        self.send(b"@cobasdr 0")
        # Force laser into autostart mode.
        self.send(b"@cob1")
 

send()

microscope.lights.cobolt.CoboltLaser.send	(		self,
			command )

Send command and retrieve response.

Definition at line 69 of file cobolt.py.

    def send(self, command):
        """Send command and retrieve response."""
        success = False
        while not success:
            self._write(command)
            response = self._readline()
            # Catch zero-length responses to queries and retry.
            if not command.endswith(b"?"):
                success = True
            elif len(response) > 0:
                success = True
        return response
 

Member Data Documentation

_max_power_mw

microscope.lights.cobolt.CoboltLaser._max_power_mw = float(self.send(b"gmlp?"))

protected

Definition at line 65 of file cobolt.py.

connection

microscope.lights.cobolt.CoboltLaser.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 49 of file cobolt.py.

---

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

• BioImager/PythonMicroscope/microscope/lights/cobolt.py