Add docs for the SpinnakerCamera device I somehow overlooked.

Author: dihm

docs/source/devices.rst

@@ -39,6 +39,7 @@ The camera devices provide interfaces for using various scientific cameras to ac
    devices/IMAQdx
    devices/pylon
    devices/flycapture2
+   devices/spinnaker
    devices/andorsolis
 
 

docs/source/devices/flycapture2.rst

@@ -3,6 +3,8 @@ FlyCapture2 Cameras
 
 This device allows control of FLIR (formerly Point Grey) scientific cameras via the `FlyCapture2 SDK <https://www.flir.com/products/flycapture-sdk/>`_ with the now deprecated PyCapture2 wrapper. In order to use this device, both the SDK and the python wrapper must be installed. Note that PyCapture2 only supports up to Python 3.6.
 
+The new FLIR SDK is supported using the :doc:`SpinnakerCamera labscript device <spinnaker>`.
+
 .. autosummary::
    labscript_devices.FlyCapture2Camera.labscript_devices
    labscript_devices.FlyCapture2Camera.blacs_tabs
@@ -13,7 +15,7 @@ Installation
 
 First ensure that the FlyCapture2 SDK is installed. 
 
-The python wrapper is available via FLIR and is only released for Python up to 3.6. It must be installed separately to pointed to the correct conda environment during install.
+The python wrapper is available via FLIR and is only released for Python up to 3.6. It must be installed separately, pointed to the correct conda environment during install.
 
 
 For GigE cameras, ensure that the network interface card (NIC) on the computer with the BLACS controlling the camera has enabled Jumbo Frames. That maximum allowed value (typically 9000) is preferable to avoid dropped frames.

docs/source/devices/spinnaker.rst

@@ -0,0 +1,76 @@
+Spinnaker Cameras
+=================
+
+This device allows control of FLIR scientific cameras via the `Spinnaker SDK <https://www.flir.com/products/spinnaker-sdk/>`_ with the PySpin wrapper. In order to use this device, both the SDK and the python wrapper must be installed.
+
+.. autosummary::
+   labscript_devices.SpinnakerCamera.labscript_devices
+   labscript_devices.SpinnakerCamera.blacs_tabs
+   labscript_devices.SpinnakerCamera.blacs_workers
+
+Installation
+~~~~~~~~~~~~
+
+First ensure that the Spinnaker SDK is installed. 
+
+The python wrapper is available via FLIR. It must be installed separately and pointed to the correct conda environment during install.
+
+For GigE cameras, ensure that the network interface card (NIC) on the computer with the BLACS controlling the camera has enabled Jumbo Frames. That maximum allowed value (typically 9000) is preferable to avoid dropped frames.
+
+Usage
+~~~~~
+
+Like the :doc:`IMAQdxCamera <IMAQdx>` device, the bulk of camera configuration is performed using a dictionary of kwargs, where the key names and values mirror those provided by the Spinnaker SDK interface. Which parameters can/need to be set depend on the communication interface. Discovery of what parameters are available can be done in three ways:
+
+1. Careful reading of the Spinnaker SDK docs.
+2. Mirroring the SpinView parameter names and values.
+3. Connecting to the camera with a minimal configuration, viewing the current parameters dictionary, and copying the relevant values to the connection table (preferred).
+
+Below is a generic configuration.
+
+.. code-block:: python
+
+   from labscript import *
+   
+   from labscript_devices.SpinnakerCamera.labscript_devices import SpinnakerCamera
+
+   SpinnakerCamera('gigeCamera',parent_device=parent,connection=conn,
+               serial_number=1234567, # set to the camera serial number
+               minimum_recovery_time=36e-6, # the minimum exposure time depends on the camera model & configuration
+               camera_attributs={},
+               manual_camera_attributes={})
+
+   start()
+
+   gigeCamera.expose(t=0.5,'exposure1')
+
+
+   stop(1)
+
+
+Detailed Documentation
+~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: labscript_devices.SpinnakerCamera
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
+
+.. automodule:: labscript_devices.SpinnakerCamera.labscript_devices
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
+
+.. automodule:: labscript_devices.SpinnakerCamera.blacs_tabs
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
+
+.. automodule:: labscript_devices.SpinnakerCamera.blacs_workers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members: