microscope.abc.SerialDeviceMixin Class Reference

Inheritance diagram for microscope.abc.SerialDeviceMixin:

Public Member Functions
def	__init__ (self, **kwargs)

Static Public Member Functions
def	lock_comms (func)

Public Attributes
	connection

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

def 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

lock_comms()

def 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
 
 

References microscope.abc.SerialDeviceMixin._comms_lock, microscope.abc.SerialDeviceMixin.connection, microscope.filterwheels.thorlabs.ThorlabsFilterWheel.connection, microscope.lights.cobolt.CoboltLaser.connection, microscope.lights.deepstar.DeepstarLaser.connection, microscope.lights.obis.ObisLaser.connection, and microscope.lights.sapphire.SapphireLaser.connection.

Member Data Documentation

connection

microscope.abc.SerialDeviceMixin.connection

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