Squashed commit of the following:

    Ran black over all source files
    updated documentation
    Added hw interupts to raspberry Pi input lines

Author: iandobbie

NEWS.rst

@@ -33,14 +33,18 @@ Version 0.7.0 (upcoming)
 
 * New devices supported:
 
+  * Added a DigitalIO device type
+    * Implemented a simulated DigitalIO device (:class:`microscope.simulations.SimulatedDigitalIO`)
+    * Implemented a concrete DigitalIO device on a Raspberry Pi (:class:`microscope.digitalio.raspberrypi.RPiDIO`)
+    
   * Hamamatsu cameras (:class:`microscope.cameras.hamamatsu.HamamatsuCamera`)
 
   * Ludl MC 2000 (:class:`microscope.controllers.ludl.LudlMC2000`)
 
   * RaspberryPi camera (:class:`microscope.cameras.picamera.PiCamera`)
 
   * Toptica iChrome MLE (:class:`microscope.controllers.toptica.iChromeMLE`)
-
+  
 * Device specific changes:
 
   * `PVCamera`:

doc/architecture/abc.rst

@@ -28,11 +28,18 @@ Microscope has the following ABCs that map to a specific device type:
 * :class:`microscope.abc.FilterWheel`
 * :class:`microscope.abc.LightSource`
 * :class:`microscope.abc.Stage`
+* :class:`microscope.abc.DigitalIO`
 
 In addition, they all subclass from :class:`microscope.abc.Device`
 which defines a base interface to all devices such as the
 :meth:`shutdown <microscope.abc.Device.shutdown>` method.
 
+There is an additional special device class
+:class:`microsope.abc.DataDevice` which defines a class that has the
+ability to asynchronously send data back to the calling
+connection. This is used for situations like cameras and asynchronous
+communication such as digital input signals. 
+      
 The actual concrete classes, those which provide actual control over
 the devices, are listed on the section :ref:`supported-devices`.
 

doc/architecture/supported-devices.rst

@@ -67,6 +67,11 @@ Stages
 - Ludl (:class:`microscope.controllers.ludl.LudlMC2000`)
 - Zaber (:class:`microscope.controllers.zaber.ZaberDaisyChain`)
 
+DigitalIO
+=========
+
+- Raspberry Pi (:class:`microsocpe.digitalio.raspberrypi`)
+
 Other
 =====
 

microscope/abc.py

@@ -453,6 +453,7 @@ def get_setting(self, name: str):
 
     def get_all_settings(self):
         """Return ordered settings as a list of dicts."""
+
         # Fetching some settings may fail depending on device state.
         # Report these values as 'None' and continue fetching other settings.
         def catch(f):
@@ -870,7 +871,8 @@ def get_transform(self) -> typing.Tuple[bool, bool, bool]:
     def _update_transform(self):
         """Update transform (after setting the client or readout transform)."""
         lr, ud, rot = (
-            self._readout_transform[i] ^ self._client_transform[i] for i in range(3)
+            self._readout_transform[i] ^ self._client_transform[i]
+            for i in range(3)
         )
         if self._readout_transform[2] and self._client_transform[2]:
             lr = not lr
@@ -1556,15 +1558,16 @@ def move_to(self, position: typing.Mapping[str, float]) -> None:
         """
         raise NotImplementedError()
 
-class DigitalIO(Device, metaclass=abc.ABCMeta):
+
+class DigitalIO(DataDevice, metaclass=abc.ABCMeta):
     """ABC for digital IO devices.
 
     Digital IO devices (DIO) have a num,ber of digital lines that can
     be for output, or optionally input and can switch between a on and
     off state.
 
     Args:
-        numLines: total number of digital lines numberes 0 to n-1. 
+        numLines: total number of digital lines numberes 0 to n-1.
 
     """
 
@@ -1576,25 +1579,25 @@ def __init__(self, numLines: int, **kwargs) -> None:
             )
         self._numLines = numLines
 
-        #array to map wether lines are input or output
-        # true is output, start with all lines defined for output. 
-        self._IOMap = [True]*self._numLines
-  
+        # array to map wether lines are input or output
+        # true is output, start with all lines defined for output.
+        self._IOMap = [True] * self._numLines
+
     def get_num_lines(self):
         """Returns the number of Io lines present in this instance"""
         return self._numLines
 
-    @abc.abstractmethod    
+    @abc.abstractmethod
     def set_IO_state(self, line: int, state: bool):
         """Sets the state of a single Digital line to either Output or Input
 
         Args:
             line: The line to have its mode set.
-        
+
             state: True for Output or False for Input."""
         raise NotImplementedError()
 
-    @abc.abstractmethod    
+    @abc.abstractmethod
     def get_IO_state(self, line):
         """Returns the state of a single Digital line, either Output or Input
 
@@ -1610,48 +1613,47 @@ def set_all_IO_state(self, stateArray):
             stateArray: Boolean array for the lines, True in output False
                         is Input"""
         for i, state in enumerate(stateArray):
-                #set each line as defined in stateArray
-                self.set_IO_state(i,state)
-            
+            # set each line as defined in stateArray
+            self.set_IO_state(i, state)
 
     def get_all_IO_state(self):
         """Returns the state of a all Digital line, either Output or Input
 
-        Returns a boolean array one entry for each line, 
+        Returns a boolean array one entry for each line,
         True for Output and False for Input"""
 
-        stateArray=[None]*self._numLines
+        stateArray = [None] * self._numLines
         for i in range(self._numLines):
-              stateArray[i]=self.get_IO_state(i)
+            stateArray[i] = self.get_IO_state(i)
         return stateArray
 
-    @abc.abstractmethod    
-    def write_line(self,line,ouput):
+    @abc.abstractmethod
+    def write_line(self, line, ouput):
         """Sets the level of a single output line
 
         Args:
             line: the line to be set
             output: the level True for high and Flase for low."""
-        
+
         raise NotImplementedError()
 
-    def write_all_lines(self,ouput_array):
+    def write_all_lines(self, ouput_array):
         """Sets the output level of every output line.
 
         Args:
-            output_array: Boolean array of output states True for high, 
-                          False for low, array entries for lines set 
+            output_array: Boolean array of output states True for high,
+                          False for low, array entries for lines set
                           as inputs are ignored."""
-        
-        if len(output_array) != self._numLines :
-            raise("Output array must be numLines in length")
+
+        if len(ouput_array) != self._numLines:
+            raise ("Output array must be numLines in length")
         for i in range(self._numLines):
-            #set line i to the IOMap entry, true for output false for input.
-            if(not self._IOMap[i]):
-                self.write_line(i,output_array[i])
+            # set line i to the IOMap entry, true for output false for input.
+            if not self._IOMap[i]:
+                self.write_line(i, ouput_array[i])
 
-    @abc.abstractmethod    
-    def read_line(self,line):
+    @abc.abstractmethod
+    def read_line(self, line):
         """Read a single input line.
         Args:
             line: the line to read
@@ -1661,8 +1663,8 @@ def read_line(self,line):
     def read_all_lines(self):
         """Read all the input lines.
         Return: Boolean Array with outline enteries set to None."""
-        
-        readarray=[None]*self._numLines
+
+        readarray = [None] * self._numLines
         for i in range(self._numLines):
-            readarray[i]=self.read_line(i)
-        return(readarray)
+            readarray[i] = self.read_line(i)
+        return readarray

microscope/cameras/_SDK3.py

@@ -123,6 +123,7 @@ class TimeoutError(CameraError):
 ### Functions ###
 STRING = POINTER(AT_WC)
 
+
 # classes so that we do some magic and automatically add byrefs etc ... can classify outputs
 class _meta:
     pass

microscope/cameras/andorsdk3.py

@@ -142,6 +142,7 @@
     "_vertically_centre_aoi": "VerticallyCentreAOI",
 }
 
+
 # Wrapper to ensure feature is readable.
 def readable_wrapper(func):
     def wrapper(self, *args, **kwargs):

microscope/cameras/atmcd.py

@@ -99,6 +99,8 @@
 at_u64 = c_ulonglong
 
 """Version Information Definitions"""
+
+
 # Version information enumeration
 class AT_VersionInfoId(c_int):
     pass
@@ -114,6 +116,8 @@ class AT_VersionInfoId(c_int):
 AT_CONTROLLER_CARD_MODEL_LEN = 80
 
 """DDG Lite Definitions"""
+
+
 # Channel enumeration
 class AT_DDGLiteChannelId(c_int):
     pass
@@ -501,6 +505,7 @@ class WHITEBALANCEINFO(Structure):
     if attrib_name.startswith("DRV_"):
         status_codes.update({eval(attrib_name): attrib_name})
 
+
 # The lookup function.
 def lookup_status(code):
     key = code[0] if type(code) is list else code
@@ -513,6 +518,7 @@ def lookup_status(code):
 # The following DLL-wrapping classes are largely lifted from David Baddeley's
 # SDK3 wrapper, with some modifications and additions.
 
+
 # Classes used to handle outputs and parameters that need buffers.
 class _meta:
     pass

microscope/cameras/hamamatsu.py

@@ -499,7 +499,6 @@ def _init_method_add_all_properties(self) -> None:
     def _init_method_get_prop_values(
         self, prop_attr: dcam.PROP_ATTR
     ) -> typing.Dict[int, str]:
-
         strbuf = ctypes.create_string_buffer(64)
         vtxt = _create_struct_with_cbSize(dcam.PROP_VALUETEXT)
         vtxt.iProp = prop_attr.iProp

microscope/cameras/pvcam.py

@@ -685,6 +685,7 @@ class md_frame(ctypes.Structure):
 ### Functions ###
 STRING = ctypes.c_char_p
 
+
 # classes so that we do some magic and automatically add byrefs etc ... can classify outputs
 # (Nicked from PYME's Ixon wrapper.)
 class _meta:
@@ -1691,6 +1692,7 @@ def initialize(self):
         _logger.info("Initializing %s", self._pv_name)
         self.handle = _cam_open(self._pv_name, OPEN_EXCLUSIVE)
         PVCamera.open_cameras.append(self.handle)
+
         # Set up event callbacks. Tried to use the resume callback to reinit camera
         # after power loss, but any attempt to close/reopen the camera or deinit the
         # DLL throws a Windows Error 0xE06D7363.
@@ -1717,7 +1719,7 @@ def _cb(event):
         )
         # Repopulate _params.
         self._params = {}
-        for (param_id, name) in _param_to_name.items():
+        for param_id, name in _param_to_name.items():
             try:
                 p = PVParam.factory(self, param_id)
             except: