microscope.lights.toptica._iBeamConnection Class Reference

Public Member Functions
def	__init__ (self, str port)
bytes	command (self, bytes command)
None	laser_on (self)
None	laser_off (self)
None	set_normal_channel_power (self, float power)
float	show_power_uW (self)
bytes	status_laser (self)
float	show_max_power (self)

Detailed Description

Connection to a specific Toptica iBeam smart laser.

This class wraps the serial connection to the device, and provides
access to some of its commands performing most of the parsing and
validation.

Args:
    port: port name (Windows) or path to port (everything else) to
        connect to.  For example, `/dev/ttyS1`, `COM1`, or
        `/dev/cuad1`.

Definition at line 51 of file toptica.py.

Constructor & Destructor Documentation

__init__()

def microscope.lights.toptica._iBeamConnection.__init__	(		self,
		str	port
	)

Definition at line 65 of file toptica.py.

    def __init__(self, port: str):
        # From the Toptica iBeam SMART manual:
        # Direct connection via COMx with 115200,8,N,1 and serial
        # interface handshake "none". That means that no hardware
        # handshake (DTR, RTS) and no software handshake (XON,XOFF) of
        # the underlying operating system is supported.
        serial_conn = serial.Serial(
            port=port,
            baudrate=115200,
            timeout=1.0,
            bytesize=serial.EIGHTBITS,
            stopbits=serial.STOPBITS_ONE,
            parity=serial.PARITY_NONE,
            xonxoff=False,
            rtscts=False,
            dsrdtr=False,
        )
        self._serial = microscope._utils.SharedSerial(serial_conn)
 
        # We don't know what is the current verbosity state and so we
        # don't know yet what we should be reading back.  So blindly
        # set to the level we want, flush all output, and then check
        # if indeed this is a Toptica iBeam device.
        with self._serial.lock:
            self._serial.write(b"echo off\r\n")
            self._serial.write(b"prompt off\r\n")
            # The talk level we want is 'usual'.  In theory we should
            # be able to use 'quiet' which only answers queries but in
            # practice 'quiet' does not answer some queries like 'show
            # serial'.
            self._serial.write(b"talk usual\r\n")
            self._serial.readlines()  # discard all pending lines
 
        # Empty command does nothing and returns nothing extra so we
        # use it to ensure this at least behaves like a Toptica iBeam.
        try:
            self.command(b"")
        except microscope.DeviceError as e:
            raise microscope.InitialiseError(
                "Failed to confirm Toptica iBeam on %s" % (port)
            ) from e
 
        answer = self.command(b"show serial")
        if not answer.startswith(b"SN: "):
            raise microscope.DeviceError(
                "Failed to parse serial from %s" % answer
            )
        _logger.info("got connection to Toptica iBeam %s", answer.decode())
 

Member Function Documentation

command()

bytes microscope.lights.toptica._iBeamConnection.command	(		self,
		bytes	command
	)

Run command and return answer after minimal validation.

The output of a command has the format::

    \r\nANSWER\r\n[OK]\r\n

The returned bytes only include `ANSWER` without its own final
`\r\n`.  This means that the return value might be an empty
array of bytes.

Definition at line 114 of file toptica.py.

    def command(self, command: bytes) -> bytes:
        """Run command and return answer after minimal validation.
 
        The output of a command has the format::
 
            \r\nANSWER\r\n[OK]\r\n
 
        The returned bytes only include `ANSWER` without its own final
        `\r\n`.  This means that the return value might be an empty
        array of bytes.
        """
        # We expect to be on 'talk usual' mode without prompt so each
        # command will end with [OK] on its own line.
        with self._serial.lock:
            self._serial.write(command + b"\r\n")
            # An answer always starts with \r\n so there will be one
            # before [OK] even if this command is not a query.
            answer = self._serial.read_until(b"\r\n[OK]\r\n")
 
        if not answer.startswith(b"\r\n"):
            raise microscope.DeviceError(
                "answer to command %s does not start with CRLF."
                " This may be leftovers from a previous command:"
                " %s" % (command, answer)
            )
        if not answer.endswith(b"\r\n[OK]\r\n"):
            raise microscope.DeviceError(
                "Command %s failed or failed to read answer: %s"
                % (command, answer)
            )
 
        # If an error occurred, the answer still ends in [OK].  We
        # need to check if the second line (first line is \r\n) is an
        # error code with the format "%SYS-L-XXX, error description"
        # where L is the error level (I for Information, W for
        # Warning, E for Error, and F for Fatal), and XXX is the error
        # code number.
        if answer[2:7] == b"%SYS-" and answer[7] != ord(b"I"):
            # Errors of level I (information) should not raise an
            # exception since they can be replies to normal commands.
            raise microscope.DeviceError(
                "Command %s failed: %s" % (command, answer)
            )
 
        # Exclude the first \r\n, the \r\n from a possible answer, and
        # the final [OK]\r\n
        return answer[2:-8]
 

References microscope._utils.SharedSerial._serial, microscope.controllers.coolled._CoolLEDConnection._serial, microscope.controllers.lumencor._SpectraIIIConnection._serial, microscope.controllers.prior._ProScanIIIConnection._serial, microscope.controllers.toptica._iChromeConnection._serial, microscope.controllers.zaber._ZaberConnection._serial, microscope.lights.toptica._iBeamConnection._serial, and microscope.stages.ludl._LudlController._serial.

Referenced by microscope.controllers.zaber._ZaberDeviceConnection.been_homed(), microscope.controllers.zaber._ZaberDeviceConnection.command(), microscope.controllers.zaber._ZaberDeviceConnection.get_absolute_position(), microscope.controllers.prior._ProScanIIIConnection.get_command(), microscope.stages.ludl._LudlController.get_command(), microscope.controllers.zaber._ZaberDeviceConnection.get_current_index(), microscope.controllers.prior._ProScanIIIConnection.get_description(), microscope.stages.ludl._LudlController.get_description(), microscope.controllers.zaber._ZaberDeviceConnection.get_index_distance(), microscope.controllers.zaber._ZaberDeviceConnection.get_limit_max(), microscope.controllers.zaber._ZaberDeviceConnection.get_limit_min(), microscope.controllers.zaber._ZaberDeviceConnection.get_number_axes(), microscope.controllers.zaber._ZaberDeviceConnection.get_rotation_length(), microscope.controllers.zaber._ZaberDeviceConnection.home(), microscope.lights.toptica._iBeamConnection.laser_off(), microscope.lights.toptica._iBeamConnection.laser_on(), microscope.lights.toptica._iBeamConnection.set_normal_channel_power(), microscope.lights.toptica._iBeamConnection.show_power_uW(), and microscope.lights.toptica._iBeamConnection.status_laser().

laser_off()

None microscope.lights.toptica._iBeamConnection.laser_off

(

self

)

Deactivate LD driver.

Definition at line 166 of file toptica.py.

    def laser_off(self) -> None:
        """Deactivate LD driver."""
        self.command(b"laser off")
 

References microscope.controllers.prior._ProScanIIIConnection.command(), microscope.lights.toptica._iBeamConnection.command(), microscope.stages.ludl._LudlController.command(), and microscope.controllers.zaber._ZaberDeviceConnection.command().

laser_on()

None microscope.lights.toptica._iBeamConnection.laser_on

(

self

)

Activate LD driver.

Definition at line 162 of file toptica.py.

    def laser_on(self) -> None:
        """Activate LD driver."""
        self.command(b"laser on")
 

References microscope.controllers.prior._ProScanIIIConnection.command(), microscope.lights.toptica._iBeamConnection.command(), microscope.stages.ludl._LudlController.command(), and microscope.controllers.zaber._ZaberDeviceConnection.command().

set_normal_channel_power()

None microscope.lights.toptica._iBeamConnection.set_normal_channel_power	(		self,
		float	power
	)

Set power in mW for channel 2 (normal operating level channel).

We don't have channel number as an argument because we only
want to be setting the power via channel 2 (channel 1 is the
bias and we haven't seen a laser with a channel 3 yet).

Definition at line 170 of file toptica.py.

    def set_normal_channel_power(self, power: float) -> None:
        """Set power in mW for channel 2 (normal operating level channel).
 
        We don't have channel number as an argument because we only
        want to be setting the power via channel 2 (channel 1 is the
        bias and we haven't seen a laser with a channel 3 yet).
        """
        self.command(b"channel 2 power %f" % power)
 

References microscope.controllers.prior._ProScanIIIConnection.command(), microscope.lights.toptica._iBeamConnection.command(), microscope.stages.ludl._LudlController.command(), and microscope.controllers.zaber._ZaberDeviceConnection.command().

show_max_power()

float microscope.lights.toptica._iBeamConnection.show_max_power

(

self

)

Definition at line 192 of file toptica.py.

    def show_max_power(self) -> float:
        # There should be a cleaner way to get these, right?  We can
        # query the current limits (mA) but how do we go from there to
        # the power limits (mW)?
        table = self.command(b"show satellite")
        value = _get_table_value(table, key=b"Pmax")
        if not value.endswith(b" mW"):
            raise microscope.DeviceError(
                "failed to parse power from %s" % value
            )
        return float(value[:-3])
 
 

show_power_uW()

float microscope.lights.toptica._iBeamConnection.show_power_uW

(

self

)

Returns actual laser power in µW.

Definition at line 179 of file toptica.py.

    def show_power_uW(self) -> float:
        """Returns actual laser power in µW."""
        answer = self.command(b"show power")
        if not answer.startswith(b"PIC  = ") and not answer.endswith(b" uW  "):
            raise microscope.DeviceError(
                "failed to parse power from answer: %s" % answer
            )
        return float(answer[7:-5])
 

References microscope.controllers.prior._ProScanIIIConnection.command(), microscope.lights.toptica._iBeamConnection.command(), microscope.stages.ludl._LudlController.command(), and microscope.controllers.zaber._ZaberDeviceConnection.command().

status_laser()

bytes microscope.lights.toptica._iBeamConnection.status_laser

(

self

)

Returns actual status of the LD driver (ON or OFF).

Definition at line 188 of file toptica.py.

    def status_laser(self) -> bytes:
        """Returns actual status of the LD driver (ON or OFF)."""
        return self.command(b"status laser")
 

References microscope.controllers.prior._ProScanIIIConnection.command(), microscope.lights.toptica._iBeamConnection.command(), microscope.stages.ludl._LudlController.command(), and microscope.controllers.zaber._ZaberDeviceConnection.command().

---

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

• F:/repos/BioImager/BioImager/PythonMicroscope/microscope/lights/toptica.py