Inheritance diagram for microscope.lights.cobolt.CoboltLaser:

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

def	send (self, command)

def	clearFault (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

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

def 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

◆ clearFault()

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

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

References microscope.lights.cobolt.CoboltLaser.send(), and microscope.lights.sapphire.SapphireLaser.send().

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

◆ get_is_on()

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

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

References microscope.abc.SerialDeviceMixin.connection, microscope.filterwheels.thorlabs.ThorlabsFilterWheel.connection, microscope.lights.cobolt.CoboltLaser.connection, microscope.lights.deepstar.DeepstarLaser.connection, microscope.lights.obis.ObisLaser.connection, microscope.lights.sapphire.SapphireLaser.connection, microscope.abc.Device.disable(), microscope.abc.DataDevice.disable(), microscope.controllers.coolled._CoolLEDChannel.disable(), microscope.controllers.lumencor._SpectraIIILightChannel.disable(), microscope.lights.cobolt.CoboltLaser.disable(), microscope.lights.sapphire.SapphireLaser.disable(), microscope.lights.toptica.TopticaiBeam.disable(), 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.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")
 

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

◆ send()

def 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
 

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.cobolt.CoboltLaser.connection

Definition at line 49 of file cobolt.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().

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

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

Public Member Functions

Public Attributes

Additional Inherited Members