Public Member Functions
None	__init__ (self, microscope._utils.SharedSerial shared_serial)

bytes	param_ref (self, bytes name)

None	param_set (self, bytes name, bytes value)

str	get_serial_number (self)

str	get_system_type (self)

Protected Member Functions
bytes	_param_command (self, bytes command)

Protected Attributes
	_serial = shared_serial

Detailed Description

Connection to the iChrome MLE.

This is a simple wrapper to the iChrome MLE interface.  It only
supports the parameter commands which reply with a single line
which is all we need to support this on Python-Microscope.

Definition at line 45 of file toptica.py.

Constructor & Destructor Documentation

◆ init()

None microscope.controllers.toptica._iChromeConnection.__init__	(		self,
		microscope._utils.SharedSerial	shared_serial )

Definition at line 54 of file toptica.py.

    def __init__(self, shared_serial: microscope._utils.SharedSerial) -> None:
        self._serial = shared_serial
 
        self._serial.readlines()  # discard anything that may be on the line
 
        if self.get_system_type() != "iChrome-MLE":
            raise microscope.DeviceError("not an iChrome MLE device")
 

Member Function Documentation

◆ _param_command()

bytes microscope.controllers.toptica._iChromeConnection._param_command	(		self,
		bytes	command )

protected

Run command and return raw answer (minus prompt and echo).

Definition at line 62 of file toptica.py.

    def _param_command(self, command: bytes) -> bytes:
        """Run command and return raw answer (minus prompt and echo)."""
        command = command + b"\r\n"
        with self._serial.lock:
            self._serial.write(command)
            answer = self._serial.read_until(b"\r\n> ")
 
        # When we read, we are reading the whole command console
        # including the prompt and even the command is echoed back.
        assert answer[: len(command)] == command and answer[-4:] == b"\r\n> "
 
        # Errors are indicated by the string "Error: " at the
        # beginning of a new line.
        if answer[len(command) : len(command) + 7] == b"Error: ":
            base_command = command[:-2]
            error_msg = answer[len(command) + 8 : -4]
            raise microscope.DeviceError(
                "error on command '%s': %s"
                % (base_command.decode(), error_msg.decode())
            )
 
        # Return the answer minus the "echoed" command and the prompt
        # for the next command.
        return answer[len(command) : -4]
 

◆ get_serial_number()

str microscope.controllers.toptica._iChromeConnection.get_serial_number ( self )

Definition at line 101 of file toptica.py.

    def get_serial_number(self) -> str:
        return _parse_string(self.param_ref(b"serial-number"))
 

◆ get_system_type()

str microscope.controllers.toptica._iChromeConnection.get_system_type ( self )

Definition at line 104 of file toptica.py.

    def get_system_type(self) -> str:
        return _parse_string(self.param_ref(b"system-type"))

◆ param_ref()

bytes microscope.controllers.toptica._iChromeConnection.param_ref	(		self,
		bytes	name )

Get parameter value (`param-ref` operator).

Definition at line 87 of file toptica.py.

    def param_ref(self, name: bytes) -> bytes:
        """Get parameter value (`param-ref` operator)."""
        return self._param_command(b"(param-ref '%s)" % name)
 

◆ param_set()

None microscope.controllers.toptica._iChromeConnection.param_set	(		self,
		bytes	name,
		bytes	value )

Change parameter (`param-set!` operator).

Definition at line 91 of file toptica.py.

    def param_set(self, name: bytes, value: bytes) -> None:
        """Change parameter (`param-set!` operator)."""
        answer = self._param_command(b"(param-set! '%s %s)" % (name, value))
        status = int(answer)
        if status < 0:
            raise microscope.DeviceError(
                "Failed to set parameter %s (return value %d)"
                % (name.decode(), status)
            )
 

Member Data Documentation

◆ _serial

microscope.controllers.toptica._iChromeConnection._serial = shared_serial

protected

Definition at line 55 of file toptica.py.

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

BioImager/PythonMicroscope/microscope/controllers/toptica.py

Public Member Functions

Protected Member Functions

Protected Attributes