microscope.abc.SerialDeviceMixin Class Reference

Inheritance diagram for microscope.abc.SerialDeviceMixin:

Public Member Functions
	__init__ (self, **kwargs)

Static Public Member Functions
	lock_comms (func)

Public Attributes
	connection = None

Protected Member Functions
bytes	_readline (self)
int	_write (self, bytes command)

Protected Attributes
	_comms_lock = threading.RLock()

Detailed Description

Mixin for devices that are controlled via serial.

DEPRECATED: turns out that this was a bad idea.  A device that has
  a serial connection is not a serial connection.  The "has a" and
  the not "is a" should have told us that we should have been
  using composition instead of subclassing, but there you go.

Currently handles the flushing and locking of the comms channel
until a command has finished, and the passthrough to the serial
channel.

Definition at line 993 of file abc.py.

Constructor & Destructor Documentation

__init__()

microscope.abc.SerialDeviceMixin.__init__	(		self,
		**	kwargs )

Definition at line 1007 of file abc.py.

    def __init__(self, **kwargs):
        super().__init__(**kwargs)
        # TODO: We should probably construct the connection here but
        #       the Serial constructor takes a lot of arguments, and
        #       it becomes tricky to separate those from arguments to
        #       the constructor of other parent classes.
        self.connection = None  # serial.Serial (to be constructed by child)
        self._comms_lock = threading.RLock()
 

Member Function Documentation

_readline()

bytes microscope.abc.SerialDeviceMixin._readline ( self )

protected

Read a line from connection without leading and trailing whitespace.

Reimplemented in microscope.lights.obis.ObisLaser.

Definition at line 1016 of file abc.py.

    def _readline(self) -> bytes:
        """Read a line from connection without leading and trailing whitespace."""
        return self.connection.readline().strip()
 

_write()

int microscope.abc.SerialDeviceMixin._write ( self, bytes command )

protected

Send a command to the device.

This is not a simple passthrough to ``serial.Serial.write``,
it will append ``b'\\r\\n'`` to command.  Override this method
if a device requires a specific format.

Reimplemented in microscope.lights.deepstar.DeepstarLaser, microscope.lights.obis.ObisLaser, and microscope.lights.sapphire.SapphireLaser.

Definition at line 1020 of file abc.py.

    def _write(self, command: bytes) -> int:
        """Send a command to the device.
 
        This is not a simple passthrough to ``serial.Serial.write``,
        it will append ``b'\\r\\n'`` to command.  Override this method
        if a device requires a specific format.
        """
        return self.connection.write(command + b"\r\n")
 

lock_comms()

microscope.abc.SerialDeviceMixin.lock_comms ( func )

static

Decorator to flush input buffer and lock communications.

There have been problems with the DeepStar lasers returning
junk characters after the expected response, so it is
advisable to flush the input buffer prior to running a command
and subsequent readline.  It also locks the comms channel so
that a function must finish all its communications before
another can run.

Definition at line 1030 of file abc.py.

    def lock_comms(func):
        """Decorator to flush input buffer and lock communications.
 
        There have been problems with the DeepStar lasers returning
        junk characters after the expected response, so it is
        advisable to flush the input buffer prior to running a command
        and subsequent readline.  It also locks the comms channel so
        that a function must finish all its communications before
        another can run.
 
        """
 
        @functools.wraps(func)
        def wrapper(self, *args, **kwargs):
            with self._comms_lock:
                self.connection.flushInput()
                return func(self, *args, **kwargs)
 
        return wrapper
 
 

Member Data Documentation

_comms_lock

microscope.abc.SerialDeviceMixin._comms_lock = threading.RLock()

protected

Definition at line 1014 of file abc.py.

connection

microscope.abc.SerialDeviceMixin.connection = None

Definition at line 1013 of file abc.py.

---

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

• BioImager/PythonMicroscope/microscope/abc.py