From bbd9e19c8a37965adbe4082b426487fdcfd28f2e Mon Sep 17 00:00:00 2001
From: nial <nonbiostudent@hotmail.com>
Date: Thu, 29 Jan 2015 12:39:37 +0000
Subject: [PATCH] adds functions for opening a spectrometer by serial number

---
 oceanoptics/__init__.py                  |   3 +-
 oceanoptics/base.py                      |  57 +++++----
 oceanoptics/spectrometers/APEX.py        |   4 +-
 oceanoptics/spectrometers/MAYA.py        |   4 +-
 oceanoptics/spectrometers/MAYA2000pro.py |   4 +-
 oceanoptics/spectrometers/QE65xxx.py     |   9 +-
 oceanoptics/spectrometers/STS.py         |   4 +-
 oceanoptics/spectrometers/TORUS.py       |   4 +-
 oceanoptics/spectrometers/XXX2000.py     |  12 +-
 oceanoptics/spectrometers/XXX2000plus.py |   8 +-
 oceanoptics/spectrometers/XXX4000.py     |   8 +-
 oceanoptics/utils.py                     | 141 ++++++++++++++++++++---
 12 files changed, 194 insertions(+), 64 deletions(-)

diff --git a/oceanoptics/__init__.py b/oceanoptics/__init__.py
index 56b4de1..1604536 100644
--- a/oceanoptics/__init__.py
+++ b/oceanoptics/__init__.py
@@ -13,4 +13,5 @@
 
 from oceanoptics.defines import OceanOpticsError
 
-from oceanoptics.utils import get_a_random_spectrometer
+from oceanoptics.utils import get_a_random_spectrometer, get_available_spectrometers 
+from oceanoptics.utils import get_spectrometer, list_available_spectrometers
diff --git a/oceanoptics/base.py b/oceanoptics/base.py
index 87ba45c..0bdad51 100644
--- a/oceanoptics/base.py
+++ b/oceanoptics/base.py
@@ -21,6 +21,7 @@ class OceanOpticsSpectrometer(object):
     All spectrometers should inherit from this!
     (or from a class that inherits from this)
     """
+    
     def wavelengths(self, only_valid_pixels=True):
         """ returns a np.array with wavelenghts in nm """
         raise NotImplementedError
@@ -44,10 +45,10 @@ def integration_time(self, time_sec=None):
 
 class OceanOpticsUSBComm(object):
 
-    def __init__(self, model):
-        self._usb_init_connection(model)
+    def __init__(self, model, device=None):
+        self._usb_init_connection(model, device)
 
-    def _usb_init_connection(self, model):
+    def _usb_init_connection(self, model, device):
 
         if model not in _OOModelConfig.keys():
             raise _OOError('Unkown OceanOptics spectrometer model: %s' % model)
@@ -63,20 +64,25 @@ def _usb_init_connection(self, model):
         self._EPin1_size = _OOModelConfig[model]['EPin1_size']
         self._min_integration_time, self._max_integration_time = _OOMinMaxIT[model]
 
-        devices = usb.core.find(find_all=True,
-                        custom_match=lambda d: (d.idVendor==vendorId and
-                                                d.idProduct in productId))
-        # FIXME: generator fix
-        devices = list(devices)
+        if device is None:
+            #if no specific device is passed in, then search for all OO devices
+            #and open the first one.
+            devices = usb.core.find(find_all=True,
+                            custom_match=lambda d: (d.idVendor==vendorId and
+                                                    d.idProduct in productId))
+            # FIXME: generator fix
+            devices = list(devices)
 
-        try:
-            self._dev = devices.pop(0)
-        except (AttributeError, IndexError):
-            raise _OOError('No OceanOptics %s spectrometer found!' % model)
+            try:
+                self._dev = devices.pop(0)
+            except (AttributeError, IndexError):
+                raise _OOError('No OceanOptics %s spectrometer found!' % model)
+            else:
+                if devices:
+                    warnings.warn('Currently the first device matching the '
+                                  'Vendor/Product id is used')
         else:
-            if devices:
-                warnings.warn('Currently the first device matching the '
-                              'Vendor/Product id is used')
+            self._dev = device
 
         self._dev.set_configuration()
         self._USBTIMEOUT = self._dev.default_timeout * 1e-3
@@ -117,8 +123,8 @@ class OceanOpticsBase(OceanOpticsSpectrometer, OceanOpticsUSBComm):
 
     """
 
-    def __init__(self, model):
-        super(OceanOpticsBase, self).__init__(model)
+    def __init__(self, model,**kwargs):
+        super(OceanOpticsBase, self).__init__(model, **kwargs)
         self._initialize()
 
         status = self._init_robust_status()
@@ -127,9 +133,11 @@ def __init__(self, model):
         self._pixels = status['pixels']
         self._EPspec = self._EPin1 if self._usb_speed == 0x80 else self._EPin0
         self._packet_N, self._packet_size, self._packet_func = (
-                _OOSpecConfig[model][self._usb_speed] )
+                _OOSpecConfig[self.model][self._usb_speed] )
         self._init_robust_spectrum()
-
+        
+        self._serial_number = self._query_information(0)
+        
         # XXX: differs for some spectrometers...
         #self._sat_factor = 65535.0/float(
         #      stuct.unpack('<h', self._query_information(17, raw=True)[6:8])[0])
@@ -137,12 +145,19 @@ def __init__(self, model):
         self._nl_factors = [float(self._query_information(i)) for i in range(6,14)]
         self._wl = sum( self._wl_factors[i] *
               np.arange(self._pixels, dtype=np.float64)**i for i in range(4) )
-        self._valid_pixels = _OOValidPixels[model]
+        self._valid_pixels = _OOValidPixels[self.model]
 
     #---------------------
     # High level functions
     #---------------------
-
+    
+    @property
+    def serial_number(self):
+        """
+        The serial number of the spectrometer (string).
+        """
+        return self._serial_number
+    
     def wavelengths(self, only_valid_pixels=True):
         """returns array of wavelengths
 
diff --git a/oceanoptics/spectrometers/APEX.py b/oceanoptics/spectrometers/APEX.py
index 36b91f4..30d3b5b 100644
--- a/oceanoptics/spectrometers/APEX.py
+++ b/oceanoptics/spectrometers/APEX.py
@@ -6,7 +6,7 @@
 
 class APEX(_OOBase):
 
-    def __init__(self):
-        super(APEX, self).__init__('Apex')
+    def __init__(self, **kwargs):
+        super(APEX, self).__init__('Apex', **kwargs)
 
 
diff --git a/oceanoptics/spectrometers/MAYA.py b/oceanoptics/spectrometers/MAYA.py
index b0679b2..c648528 100644
--- a/oceanoptics/spectrometers/MAYA.py
+++ b/oceanoptics/spectrometers/MAYA.py
@@ -6,7 +6,7 @@
 
 class MAYA(_OOBase):
 
-    def __init__(self):
-        super(MAYA, self).__init__('Maya')
+    def __init__(self, **kwargs):
+        super(MAYA, self).__init__('Maya', **kwargs)
 
 
diff --git a/oceanoptics/spectrometers/MAYA2000pro.py b/oceanoptics/spectrometers/MAYA2000pro.py
index 242dcbd..18235b1 100644
--- a/oceanoptics/spectrometers/MAYA2000pro.py
+++ b/oceanoptics/spectrometers/MAYA2000pro.py
@@ -6,7 +6,7 @@
 
 class MAYA2000pro(_OOBase):
 
-    def __init__(self):
-        super(MAYA2000pro, self).__init__('Maya2000pro')
+    def __init__(self, **kwargs):
+        super(MAYA2000pro, self).__init__('Maya2000pro', **kwargs)
 
 
diff --git a/oceanoptics/spectrometers/QE65xxx.py b/oceanoptics/spectrometers/QE65xxx.py
index 96cc24c..b2f396a 100644
--- a/oceanoptics/spectrometers/QE65xxx.py
+++ b/oceanoptics/spectrometers/QE65xxx.py
@@ -3,6 +3,7 @@
 from oceanoptics.base import OceanOpticsBase as _OOBase
 from oceanoptics.base import OceanOpticsTEC as _OOTEC
 import struct
+import numpy as np
 #----------------------------------------------------------
 
 
@@ -39,8 +40,8 @@ def _query_status(self):
 #--------
 
 class QE65000(_QE65xxx):
-    def __init__(self):
-        super(QE65000, self).__init__('QE65000')
+    def __init__(self, **kwargs):
+        super(QE65000, self).__init__('QE65000', **kwargs)
         # The QE65000 needs a -10 offset for calculating the wavelengths
         # due to some legacy issues...
         self._wl = sum( self._wl_factors[i] *
@@ -53,8 +54,8 @@ def __init__(self):
 #----------
 
 class QE65pro(_QE65xxx):
-    def __init__(self):
-        super(QE65pro, self).__init__('QE65pro')
+    def __init__(self, **kwargs):
+        super(QE65pro, self).__init__('QE65pro', **kwargs)
         self.initialize_TEC()
 
 
diff --git a/oceanoptics/spectrometers/STS.py b/oceanoptics/spectrometers/STS.py
index cd2b15b..b3f1e35 100644
--- a/oceanoptics/spectrometers/STS.py
+++ b/oceanoptics/spectrometers/STS.py
@@ -179,8 +179,8 @@ class _STSCONSTANTS(object):
 class STS(_OOSpec, _OOUSBComm):
     """Rewrite of STS class"""
 
-    def __init__(self, integration_time=0.001):
-        super(STS, self).__init__('STS')
+    def __init__(self, integration_time=0.001, **kwargs):
+        super(STS, self).__init__('STS', **kwargs)
 
         self._const = _STSCONSTANTS
 
diff --git a/oceanoptics/spectrometers/TORUS.py b/oceanoptics/spectrometers/TORUS.py
index 8e8cdd1..fca62c6 100644
--- a/oceanoptics/spectrometers/TORUS.py
+++ b/oceanoptics/spectrometers/TORUS.py
@@ -6,7 +6,7 @@
 
 class TORUS(_OOBase):
 
-    def __init__(self):
-        super(TORUS, self).__init__('Torus')
+    def __init__(self, **kwargs):
+        super(TORUS, self).__init__('Torus', **kwargs)
 
 
diff --git a/oceanoptics/spectrometers/XXX2000.py b/oceanoptics/spectrometers/XXX2000.py
index 2128738..19c491a 100644
--- a/oceanoptics/spectrometers/XXX2000.py
+++ b/oceanoptics/spectrometers/XXX2000.py
@@ -36,8 +36,8 @@ def _request_spectrum(self):
 
 class USB2000(_XXX2000):
 
-    def __init__(self):
-        super(USB2000, self).__init__('USB2000')
+    def __init__(self, **kwargs):
+        super(USB2000, self).__init__('USB2000', **kwargs)
 
     def _set_integration_time(self, time_us):
         """ send command 0x02 """
@@ -76,8 +76,8 @@ def _query_status(self):
 
 class HR2000(_XXX2000):
 
-    def __init__(self):
-        super(HR2000, self).__init__('HR2000')
+    def __init__(self, **kwargs):
+        super(HR2000, self).__init__('HR2000', **kwargs)
 
     def _set_integration_time(self, time_us):
         """ send command 0x02 """
@@ -118,8 +118,8 @@ def _query_status(self):
         
 class USB650(_XXX2000):
 
-    def __init__(self):
-        super(USB650, self).__init__('USB650')
+    def __init__(self, **kwargs):
+        super(USB650, self).__init__('USB650', **kwargs)
 
     def _set_integration_time(self, time_us):
         """ send command 0x02 """
diff --git a/oceanoptics/spectrometers/XXX2000plus.py b/oceanoptics/spectrometers/XXX2000plus.py
index ac7089f..cff449e 100644
--- a/oceanoptics/spectrometers/XXX2000plus.py
+++ b/oceanoptics/spectrometers/XXX2000plus.py
@@ -6,13 +6,13 @@
 
 class USB2000plus(_OOBase):
 
-    def __init__(self):
-        super(USB2000plus, self).__init__('USB2000+')
+    def __init__(self, **kwargs):
+        super(USB2000plus, self).__init__('USB2000+', **kwargs)
 
 
 class HR2000plus(_OOBase):
 
-    def __init__(self):
-        super(HR2000plus, self).__init__('HR2000+')
+    def __init__(self, **kwargs):
+        super(HR2000plus, self).__init__('HR2000+', **kwargs)
 
 
diff --git a/oceanoptics/spectrometers/XXX4000.py b/oceanoptics/spectrometers/XXX4000.py
index f98470f..28be98f 100644
--- a/oceanoptics/spectrometers/XXX4000.py
+++ b/oceanoptics/spectrometers/XXX4000.py
@@ -55,12 +55,12 @@ def _read_pcb_temperature(self):
 
 class USB4000(_XXX4000):
 
-    def __init__(self):
+    def __init__(self, **kwargs):
         self._EPin2 = _OOModelConfig['USB4000']['EPin2']
         self._EPin6 = _OOModelConfig['USB4000']['EPin6']
         self._EPin2_size = _OOModelConfig['USB4000']['EPin2_size']
         self._EPin6_size = _OOModelConfig['USB4000']['EPin6_size']
-        super(USB4000, self).__init__('USB4000')
+        super(USB4000, self).__init__('USB4000', **kwargs)
 
 
 #----------
@@ -69,10 +69,10 @@ def __init__(self):
 
 class HR4000(_XXX4000):
 
-    def __init__(self):
+    def __init__(self, **kwargs):
         self._EPin2 = _OOModelConfig['HR4000']['EPin2']
         self._EPin6 = _OOModelConfig['HR4000']['EPin6']
         self._EPin2_size = _OOModelConfig['HR4000']['EPin2_size']
         self._EPin6_size = _OOModelConfig['HR4000']['EPin6_size']
-        super(HR4000, self).__init__('HR4000')
+        super(HR4000, self).__init__('HR4000', **kwargs)
 
diff --git a/oceanoptics/utils.py b/oceanoptics/utils.py
index d2bd3b8..2e03735 100644
--- a/oceanoptics/utils.py
+++ b/oceanoptics/utils.py
@@ -16,22 +16,135 @@
 from oceanoptics.spectrometers.STS import STS
 
 _models = {
-	"USB2000"	: USB2000,
-	"USB650"	: USB650,
-	"HR2000"	: HR2000,
-	"USB2000+"	: USB2000plus,
-	"HR2000+"	: HR2000plus,
-	"USB4000"	: USB4000,
-	"HR4000"	: HR4000,
-	"MAYA"	: MAYA,
-	"MAYA2000pro"	: MAYA2000pro,
-	"APEX"	: APEX,
-	"QE65000"	: QE65000,
-	"QE65pro"	: QE65pro,
-	"TORUS"	: TORUS,
-	"STS"	: STS,
+    "USB2000"    : USB2000,
+    "USB650"    : USB650,
+    "HR2000"    : HR2000,
+    "USB2000+"    : USB2000plus,
+    "HR2000+"    : HR2000plus,
+    "USB4000"    : USB4000,
+    "HR4000"    : HR4000,
+    "MAYA"    : MAYA,
+    "MAYA2000pro"    : MAYA2000pro,
+    "APEX"    : APEX,
+    "QE65000"    : QE65000,
+    "QE65pro"    : QE65pro,
+    "TORUS"    : TORUS,
+    "STS"    : STS,
         }
 
+
+def get_available_spectrometers():
+    """
+    Returns a dict of all available spectrometers with their serial numbers as
+    keys.
+    
+    Note that an "available" spectrometer is one which is plugged in, but is not
+    currently connected to. This means that unless the spectrometer objects 
+    returned by this function are disposed of, subsequent calls to the function 
+    will return an empty dict.
+    
+    Returns
+    -------
+    spectrometers : dict {string: OceanOpticsBase object,...}
+        dict of spectrometer objects with their serial numbers as keys
+    
+    """
+    
+    ProductId = {}
+    for model in _OOSupMod:
+        pid = _OOModConf[model]['ProductId']
+        ProductId.update(zip(pid, [model] * len(pid)))
+
+    devices = usb.core.find(find_all=True,
+                            custom_match=lambda d: (d.idVendor == _OOVendorId and
+                                                    d.idProduct in ProductId.keys()))
+    
+    spectrometers = {}
+    
+    for d in devices:
+        mod = ProductId[d.idProduct]
+    
+        spec_class = _models[mod]
+        
+        try:
+            spectro = spec_class(device=d)
+            spectrometers[spectro.serial_number] = spectro
+            
+        except usb.core.USBError:
+            #the spectrometer is already connected - skip it
+            continue
+    
+    return spectrometers
+    
+
+def get_spectrometer(serial_num=None):
+    """
+    If serial_num is specified, then returns the object corresponding to that 
+    particular spectrometer, otherwise the first available spectrometer is 
+    returned.
+    
+    Parameters
+    ----------
+    serial_num : string, optional
+        the serial number of the spectrometer that you want to connect to
+    
+    Returns
+    -------
+    spectrometer : OceanOpticsBase object
+        the spectrometer with the requested serial number, or the first 
+        available spectrometer if serial_num=None
+    
+    Raises
+    ------
+        OceanOpticsError: 
+            if the requested spectrometer is not available.
+    """
+    
+    spectrometers = get_available_spectrometers()
+    
+    if not spectrometers:
+        raise _OOError('no available spectrometers found')
+    
+    if serial_num is None:
+        #then just return the first spectrometer in the list
+        serial_num = spectrometers.keys()[0]
+
+    try:
+        selected_spectro = spectrometers.pop(serial_num)
+    except KeyError:
+        raise _OOError('Spectrometer %s is not available'%serial_num)
+    finally:
+        for s in spectrometers.values():
+            s.dispose()
+    
+    return selected_spectro
+
+
+def list_available_spectrometers():
+    """
+    Returns a list of spectrometer serial numbers (strings) for all the currently
+    available spectrometers.
+    
+    Note that an "available" spectrometer is one which is plugged in, but is not
+    currently connected to.
+    
+    Returns
+    -------
+    serial numbers : list of strings
+        the serial numbers of all the available spectrometers
+    """
+    spectros = get_available_spectrometers()
+    
+    spectro_ids = spectros.keys()
+    
+    for s in spectros.values():
+        s.dispose()
+    
+    return spectro_ids
+    
+    
+
+
 def get_a_random_spectrometer():
     ProductId = {}
     for model in _OOSupMod: