Inheritance diagram for microscope.lights.obis.ObisLaser:

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

	get_status (self)

	initialize (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	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
	_write (self, command)

	_readline (self)

	_flush_handshake (self)

	_do_enable (self)

None	_do_shutdown (self)

	_do_disable (self)

	_get_power_mw (self)

	_set_power_mw (self, mw)

None	_do_set_power (self, float power)

float	_do_get_power (self)

None	_do_trigger (self)

Protected Member Functions inherited from microscope.abc.SerialDeviceMixin
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
float	_max_power_mw = float(response) * 1000.0

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

Definition at line 33 of file obis.py.

Constructor & Destructor Documentation

◆ init()

None microscope.lights.obis.ObisLaser.__init__	(		self,
			com,
			baud = 115200,
			timeout = 0.5,
		**	kwargs )

Reimplemented from microscope.abc.SerialDeviceMixin.

Definition at line 34 of file obis.py.

    def __init__(self, com, baud=115200, timeout=0.5, **kwargs) -> None:
        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.
        self._write(b"SYSTem:INFormation:MODel?")
        response = self._readline()
        _logger.info("OBIS laser model: [%s]", response.decode())
        self._write(b"SYSTem:INFormation:SNUMber?")
        response = self._readline()
        _logger.info("OBIS laser serial number: [%s]", response.decode())
        self._write(b"SYSTem:CDRH?")
        response = self._readline()
        _logger.info("CDRH safety: [%s]", response.decode())
        self._write(b"SOURce:TEMPerature:APRobe?")
        response = self._readline()
        _logger.info("TEC temperature control: [%s]", response.decode())
        self._write(b"*TST?")
        response = self._readline()
        _logger.info("Self test procedure: [%s]", response.decode())
 
        # We need to ensure that autostart is disabled so that we can
        # switch emission on/off remotely.
        self._write(b"SYSTem:AUTostart?")
        response = self._readline()
        _logger.info("Response to Autostart: [%s]", response.decode())
 
        self._write(b"SOURce:POWer:LIMit:HIGH?")
        response = self._readline()
        _logger.info("Max intensity in watts: [%s]", response.decode())
        self._max_power_mw = float(response) * 1000.0
 
        self.initialize()
 

Member Function Documentation

◆ _do_disable()

microscope.lights.obis.ObisLaser._do_disable ( self )

protected

Turn the laser OFF. Return True if we succeeded, False otherwise.

Reimplemented from microscope.abc.Device.

Definition at line 152 of file obis.py.

    def _do_disable(self):
        """Turn the laser OFF. Return True if we succeeded, False otherwise."""
        _logger.info("Turning laser OFF.")
        # Turning LASER OFF
        self._write(b"SOURce:AM:STATe OFF")
        self._flush_handshake()
 
        if self.get_is_on():
            _logger.error("Failed to turn OFF. Current status:\r\n")
            _logger.error(self.get_status())
            return False
        return True
 

◆ _do_enable()

microscope.lights.obis.ObisLaser._do_enable ( self )

protected

Turn the laser ON. Return True if we succeeded, False otherwise.

Reimplemented from microscope.abc.Device.

Definition at line 109 of file obis.py.

    def _do_enable(self):
        """Turn the laser ON. Return True if we succeeded, False otherwise."""
        _logger.info("Turning laser ON.")
        # Exiting Sleep Mode.
        self._write(b"SOURce:TEMPerature:APRobe ON")
        self._flush_handshake()
        # Turn on emission.
        self._write(b"SOURce:AM:STATe ON")
        self._flush_handshake()
        self._write(b"SOURce:AM:STATe?")
        response = self._readline()
        _logger.info("SOURce:AM:STATe? [%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.obis.ObisLaser._do_get_power ( self )

protected

Internal function that actually returns the light source power.

Reimplemented from microscope.abc.LightSource.

Definition at line 191 of file obis.py.

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

◆ _do_set_power()

None microscope.lights.obis.ObisLaser._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 188 of file obis.py.

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

◆ _do_shutdown()

None microscope.lights.obis.ObisLaser._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 129 of file obis.py.

    def _do_shutdown(self) -> None:
        self.disable()
        # We set the power to a safe level
        self._set_power_mw(2)
        # We want it back into direct control mode.
        self._write(b"SOURce:AM:INTernal CWP")
        self._flush_handshake()
 
        # Going into Sleep mode
        self._write(b"SOURce:TEMPerature:APRobe OFF")
        self._flush_handshake()
 

◆ _do_trigger()

None microscope.lights.obis.ObisLaser._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 214 of file obis.py.

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

◆ _flush_handshake()

microscope.lights.obis.ObisLaser._flush_handshake ( self )

protected

Definition at line 90 of file obis.py.

    def _flush_handshake(self):
        self.connection.readline()
 

◆ _get_power_mw()

microscope.lights.obis.ObisLaser._get_power_mw ( self )

protected

Definition at line 174 of file obis.py.

    def _get_power_mw(self):
        if not self.get_is_on():
            return 0.0
        self._write(b"SOURce:POWer:LEVel?")
        response = self._readline()
        return float(response.decode()) * 1000.0
 

◆ _readline()

microscope.lights.obis.ObisLaser._readline ( self )

protected

Read a line from connection without leading and trailing whitespace.
We override from SerialDeviceMixin

Reimplemented from microscope.abc.SerialDeviceMixin.

Definition at line 79 of file obis.py.

    def _readline(self):
        """Read a line from connection without leading and trailing whitespace.
        We override from SerialDeviceMixin
        """
        response = self.connection.readline().strip()
        if self.connection.readline().strip() != b"OK":
            raise microscope.DeviceError(
                "Did not get a proper answer from the laser serial comm."
            )
        return response
 

◆ _set_power_mw()

microscope.lights.obis.ObisLaser._set_power_mw	(		self,
			mw )

protected

Definition at line 182 of file obis.py.

    def _set_power_mw(self, mw):
        power_w = mw / 1000.0
        _logger.info("Setting laser power to %.7sW", power_w)
        self._write(b"SOURce:POWer:LEVel:IMMediate:AMPLitude %.5f" % power_w)
        self._flush_handshake()
 

◆ _write()

microscope.lights.obis.ObisLaser._write	(		self,
			command )

protected

Send a command.

Reimplemented from microscope.abc.SerialDeviceMixin.

Definition at line 74 of file obis.py.

    def _write(self, command):
        """Send a command."""
        response = self.connection.write(command + b"\r\n")
        return response
 

◆ get_is_on()

microscope.lights.obis.ObisLaser.get_is_on ( self )

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

Reimplemented from microscope.abc.LightSource.

Definition at line 166 of file obis.py.

    def get_is_on(self):
        """Return True if the laser is currently able to produce light."""
        self._write(b"SOURce:AM:STATe?")
        response = self._readline()
        _logger.info("Are we on? [%s]", response.decode())
        return response == b"ON"
 

◆ get_status()

microscope.lights.obis.ObisLaser.get_status ( self )

Query and return the light source status.

Reimplemented from microscope.abc.LightSource.

Definition at line 94 of file obis.py.

    def get_status(self):
        result = []
        for cmd, stat in [
            (b"SOURce:AM:STATe?", "Emission on?"),
            (b"SOURce:POWer:LEVel:IMMediate:AMPLitude?", "Target power:"),
            (b"SOURce:POWer:LEVel?", "Measured power:"),
            (b"SYSTem:STATus?", "Status code?"),
            (b"SYSTem:FAULt?", "Fault code?"),
            (b"SYSTem:HOURs?", "Head operating hours:"),
        ]:
            self._write(cmd)
            result.append(stat + " " + self._readline().decode())
        return result
 

◆ initialize()

microscope.lights.obis.ObisLaser.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 141 of file obis.py.

    def initialize(self):
        # self.flush_buffer()
        # We ensure that handshaking is off.
        self._write(b"SYSTem:COMMunicate:HANDshaking ON")
        self._flush_handshake()
        # We don't want 'direct control' mode.
        # TODO: Change to MIXED when analogue output is available
        self._write(b"SOURce:AM:EXTernal DIGital")
        self._flush_handshake()
 

◆ set_trigger()

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

Set device for a specific trigger.

Reimplemented from microscope.abc.TriggerTargetMixin.

Definition at line 202 of file obis.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.obis.ObisLaser.trigger_mode ( self )

Reimplemented from microscope.abc.TriggerTargetMixin.

Definition at line 199 of file obis.py.

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

◆ trigger_type()

microscope.TriggerType microscope.lights.obis.ObisLaser.trigger_type ( self )

Reimplemented from microscope.abc.TriggerTargetMixin.

Definition at line 195 of file obis.py.

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

Member Data Documentation

◆ _max_power_mw

microscope.lights.obis.ObisLaser._max_power_mw = float(response) * 1000.0

protected

Definition at line 70 of file obis.py.

◆ connection

microscope.lights.obis.ObisLaser.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 36 of file obis.py.

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

BioImager/PythonMicroscope/microscope/lights/obis.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()

◆ _flush_handshake()

◆ _get_power_mw()

◆ _readline()

◆ _set_power_mw()

◆ _write()

◆ get_is_on()

◆ get_status()

◆ initialize()

◆ set_trigger()

◆ trigger_mode()

◆ trigger_type()

Member Data Documentation

◆ _max_power_mw

◆ connection

◆ init()