Inheritance diagram for microscope.lights.obis.ObisLaser:

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

def	get_status (self)

def	initialize (self)

def	get_is_on (self)

microscope.TriggerType	trigger_type (self)

microscope.TriggerMode	trigger_mode (self)

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

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.TriggerTargetMixin
microscope.TriggerMode	trigger_mode (self)

microscope.TriggerType	trigger_type (self)

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

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

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

◆ get_is_on()

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

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

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

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

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

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

◆ 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
 

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

◆ 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
 

Referenced by microscope.cameras.ximea.XimeaCamera.__init__(), microscope.abc.DeformableMirror.apply_pattern(), and microscope.abc.TriggerTargetMixin.trigger().

Member Data Documentation

◆ connection

microscope.lights.obis.ObisLaser.connection

Definition at line 36 of file obis.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/obis.py

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ get_is_on()

◆ get_status()

◆ initialize()

◆ set_trigger()

◆ trigger_mode()

◆ trigger_type()

Member Data Documentation

◆ connection

◆ init()