Inheritance diagram for microscope.lights.deepstar.DeepstarLaser:

Public Member Functions
	__init__ (self, com, baud=9600, timeout=2.0, **kwargs)

	get_status (self)

	get_is_on (self)

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

Public Member Functions inherited from microscope.abc.Device
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)

	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

str	_has_apc = b"P"

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

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

Protected Member Functions
	_write (self, command)

	_do_enable (self)

None	_do_shutdown (self)

	_do_disable (self)

None	_do_set_power (self, float power)

float	_do_get_power (self)

None	_do_trigger (self)

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.TriggerTargetMixin
Protected Member Functions inherited from microscope.abc.Device

Protected Attributes
bool	_has_apc = True

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

Omicron DeepStar laser.

Omicron LDM lasers can be bought with and without the LDM.APC
power monitoring option (light pick-off).  If this option is not
available, the `power` attribute will return the set power value
instead of the actual power value.

Definition at line 32 of file deepstar.py.

Constructor & Destructor Documentation

◆ init()

microscope.lights.deepstar.DeepstarLaser.__init__	(		self,
			com,
			baud = 9600,
			timeout = 2.0,
		**	kwargs )

Reimplemented from microscope.abc.SerialDeviceMixin.

Definition at line 44 of file deepstar.py.

    def __init__(self, com, baud=9600, timeout=2.0, **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,
        )
        # If the laser is currently on, then we need to use 7-byte mode; otherwise we need to
        # use 16-byte mode.
        self._write(b"S?")
        response = self._readline()
        _logger.info("Current laser state: [%s]", response.decode())
 
        self._write(b"STAT3")
        option_codes = self._readline()
        if not option_codes.startswith(b"OC "):
            raise microscope.DeviceError(
                "Failed to get option codes '%s'" % option_codes.decode()
            )
        if option_codes[9:12] == b"AP1":
            self._has_apc = True
        else:
            _logger.warning(
                "Laser is missing APC option.  Will return set"
                " power instead of actual power"
            )
            self._has_apc = False
 

Member Function Documentation

◆ _do_disable()

microscope.lights.deepstar.DeepstarLaser._do_disable ( self )

protected

Do any device-specific work on disable.

Subclasses should override this method rather than modify
`disable`.

Reimplemented from microscope.abc.Device.

Definition at line 128 of file deepstar.py.

    def _do_disable(self):
        _logger.info("Turning laser OFF.")
        self._write(b"LF")
        return self._readline().decode()
 

◆ _do_enable()

microscope.lights.deepstar.DeepstarLaser._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 96 of file deepstar.py.

    def _do_enable(self):
        _logger.info("Turning laser ON.")
        # Turn on deepstar mode with internal voltage ref
        # Enable internal peak power
        # Set MF turns off internal digital and bias modulation
        # Disable analog modulation to digital modulation
        for cmd, msg in [
            (b"LON", "Enable response: [%s]"),
            (b"L2", "L2 response: [%s]"),
            (b"IPO", "Enable-internal peak power response: [%s]"),
            (b"MF", "MF response [%s]"),
            (b"A2DF", "A2DF response [%s]"),
        ]:
            self._write(cmd)
            response = self._readline()
            _logger.debug(msg, response.decode())
 
        if not self.get_is_on():
            # Something went wrong.
            self._write(b"S?")
            response = self._readline()
            _logger.error(
                "Failed to turn on. Current status: [%s]", response.decode()
            )
            return False
        return True
 

◆ _do_get_power()

float microscope.lights.deepstar.DeepstarLaser._do_get_power ( self )

protected

Internal function that actually returns the light source power.

Reimplemented from microscope.abc.LightSource.

Definition at line 153 of file deepstar.py.

    def _do_get_power(self) -> float:
        if not self.get_is_on():
            return 0.0
        if self._has_apc:
            query = b"P"
            scale = 0xCCC
        else:
            query = b"PP"
            scale = 0xFFF
 
        self._write(query + b"?")
        answer = self._readline()
        if not answer.startswith(query):
            raise microscope.DeviceError(
                "failed to read power from '%s'" % answer.decode()
            )
 
        level = int(answer[len(query) :], 16)
        return float(level) / float(scale)
 

◆ _do_set_power()

None microscope.lights.deepstar.DeepstarLaser._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 143 of file deepstar.py.

    def _do_set_power(self, power: float) -> None:
        _logger.debug("level=%d", power)
        power_int = int(power * 0xFFF)
        _logger.debug("power=%d", power_int)
        strPower = "PP%03X" % power_int
        _logger.debug("power level=%s", strPower)
        self._write(strPower.encode())
        response = self._readline()
        _logger.debug("Power response [%s]", response.decode())
 

◆ _do_shutdown()

None microscope.lights.deepstar.DeepstarLaser._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 123 of file deepstar.py.

    def _do_shutdown(self) -> None:
        self.disable()
 

◆ _do_trigger()

None microscope.lights.deepstar.DeepstarLaser._do_trigger ( self )

protected

Actual trigger of the device.

Classes implementing this interface should implement this
method instead of `trigger`.

Reimplemented from microscope.abc.TriggerTargetMixin.

Definition at line 193 of file deepstar.py.

    def _do_trigger(self) -> None:
        raise microscope.IncompatibleStateError(
            "trigger does not make sense in trigger mode bulb, only enable"
        )

◆ _write()

microscope.lights.deepstar.DeepstarLaser._write	(		self,
			command )

protected

Send a command.

Reimplemented from microscope.abc.SerialDeviceMixin.

Definition at line 75 of file deepstar.py.

    def _write(self, command):
        """Send a command."""
        # We'll need to pad the command out to 16 bytes. There's also
        # a 7-byte mode but we never need to use it.  CR/LF counts
        # towards the byte limit, hence 14 (16-2)
        command = command.ljust(14) + b"\r\n"
        response = self.connection.write(command)
        return response
 

◆ get_is_on()

microscope.lights.deepstar.DeepstarLaser.get_is_on ( self )

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

Reimplemented from microscope.abc.LightSource.

Definition at line 136 of file deepstar.py.

    def get_is_on(self):
        self._write(b"S?")
        response = self._readline()
        _logger.debug("Are we on? [%s]", response.decode())
        return response == b"S2"
 

◆ get_status()

microscope.lights.deepstar.DeepstarLaser.get_status ( self )

Query and return the light source status.

Reimplemented from microscope.abc.LightSource.

Definition at line 87 of file deepstar.py.

    def get_status(self):
        result = []
        for i in range(4):
            self._write(("STAT%d" % i).encode())
            result.append(self._readline().decode())
        return result
 

◆ set_trigger()

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

Set device for a specific trigger.

Reimplemented from microscope.abc.TriggerTargetMixin.

Definition at line 181 of file deepstar.py.

    ) -> None:
        if ttype is not microscope.TriggerType.HIGH:
            raise microscope.UnsupportedFeatureError(
                "the only trigger type supported is 'high'"
            )
        if tmode is not microscope.TriggerMode.BULB:
            raise microscope.UnsupportedFeatureError(
                "the only trigger mode supported is 'bulb'"
            )
 

◆ trigger_mode()

microscope.TriggerMode microscope.lights.deepstar.DeepstarLaser.trigger_mode ( self )

Reimplemented from microscope.abc.TriggerTargetMixin.

Definition at line 178 of file deepstar.py.

    def trigger_mode(self) -> microscope.TriggerMode:
        return microscope.TriggerMode.BULB
 

◆ trigger_type()

microscope.TriggerType microscope.lights.deepstar.DeepstarLaser.trigger_type ( self )

Reimplemented from microscope.abc.TriggerTargetMixin.

Definition at line 174 of file deepstar.py.

    def trigger_type(self) -> microscope.TriggerType:
        return microscope.TriggerType.HIGH
 

Member Data Documentation

◆ _has_apc [1/2]

bool microscope.lights.deepstar.DeepstarLaser._has_apc = True

protected

Definition at line 67 of file deepstar.py.

◆ _has_apc [2/2]

str microscope.lights.deepstar.DeepstarLaser._has_apc = b"P"

Definition at line 156 of file deepstar.py.

◆ connection

microscope.lights.deepstar.DeepstarLaser.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 46 of file deepstar.py.

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

BioImager/PythonMicroscope/microscope/lights/deepstar.py

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _do_disable()

◆ _do_enable()

◆ _do_get_power()

◆ _do_set_power()

◆ _do_shutdown()

◆ _do_trigger()

◆ _write()

◆ get_is_on()

◆ get_status()

◆ set_trigger()

◆ trigger_mode()

◆ trigger_type()

Member Data Documentation

◆ _has_apc [1/2]

◆ _has_apc [2/2]

◆ connection

◆ init()