Commits

iorodeo committed e7d7102

Project creation.

  • Participants

Comments (0)

Files changed (7)

+syntax: glob
+*.pyc
+*~
+*.o
+*.egg-info
+*.swp
+*.scad
+*.stl
+*.pkl
+*.dxf
+*.komodo*
+*.egg-info
+.DS_Store
+build
+dist
+.komodo*
+deb_dist
+syringe_pump installation instructions
+=======================================
+
+Requirements:
+
+  * pyserial 
+
+Installation:
+
+The package uses the Python setuptools, you can build it by calling
+
+python setup.py install
+
+which installs the package on your system.  
+
+See the "Installing Python Modules" manual inside your Python documentation or
+at http://docs.python.org/inst/inst.html if you want to customize the build
+process or the target location.
+
+
+
+
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+
+
+syringe_pump: pyserial based interface to the New Era Pump Systems Model
+NE-500/NE-501 , NE-1000 Family of syringe pumps. 
+
+Installations instructions can be found in the INSTALL file.
+
+Author: Will Dickson IO Rodeo Inc.
+
+syringe_pump may be freely distributed and modified in accordance with the
+Apache 2.0  License.
+"""
+Copyright 2010  IO Rodeo Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+"""
+from setuptools import setup, find_packages
+
+setup(name='syringe_pump',
+      version='0.1',
+      description = 'serial interface to New Era Pump Systems NE-500, NE-501, and NE-1000 Syringe pumps',
+      author = 'William Dickson, IO Rodeo Inc.',
+      author_email = 'will@iorodeo.com',
+      packages=find_packages(),
+      )
+

File syringe_pump/__init__.py

+from syringe_pump import *

File syringe_pump/syringe_pump.py

+from __future__ import print_function
+import serial
+import time
+
+debug = False 
+
+class SyringePump(serial.Serial):
+
+    def __init__(self,port,timeout=0.5,debug=False):
+        params = {
+                'timeout'  : timeout,
+                'baudrate' : 19200,
+                'bytesize' : serial.EIGHTBITS,
+                'parity'   : serial.PARITY_NONE,
+                'stopbits' : serial.STOPBITS_ONE,
+                }
+        super(SyringePump,self).__init__(port,**params)
+        self.debug=debug
+
+    def sendCmd(self,cmd):
+        if self.debug:
+            print('cmd: {0}'.format(cmd))
+        cmd = '{0}\r'.format(cmd)
+        self.write(cmd)
+        rsp = self.readline()
+        self.checkRsp(rsp)
+        return rsp
+
+    def checkRsp(self,rsp):
+        if self.debug:
+            print('rsp: {0}, {1}'.format([x for x in rsp],[ord(x) for x in rsp]))
+
+    def setDiameter(self,val):
+        """
+        Set the syringe inside diameter in mm. Valid diameters range from 
+        0.1mm to 50.0mm.
+        """
+        if val < 0.1 or val > 50.0:
+            raise ValueError, 'syringe diameter out of range'
+        valStr = float2PumpFormat(val)
+        self.sendCmd('DIA {0}'.format(valStr))
+
+    def setRate(self,val,units='NS'):
+        """
+        Set the pumping rate.  Value must be bewteen 0 and 1000 and 
+        units must be 'NS', 'UM', 'MM', 'UH', or 'MH'
+        """
+        if not units.upper() in ('NS', 'UM', 'MM', 'UH', 'MH'):
+            raise ValueError, 'unknown pumping rate units: {0}'.format(units)
+        if units.upper() == 'NS':
+            val = 60.0*val/(1.0e3)
+            units = 'UM'
+        valStr = float2PumpFormat(val)
+        self.sendCmd('RAT {0} {1}'.format(valStr,units))
+
+    def setDirection(self,val):
+        """
+        Set the pump direction - infuse 'INF', or withdraw 'WDR'
+        """
+        val = val.lower()
+        if val in ('infuse', 'inf'):
+            valStr = 'INF'
+        elif val in ('withdraw', 'wdr'):
+            valStr = 'WDR'
+        self.sendCmd('DIR {0}'.format(valStr))
+
+    def setAccumUnits(self,units):
+        """
+        Sets the volume units ML or UL - overides the default value set when the 
+        syringe diameter is set.
+        """
+        if not units in ('ML', 'UL'):
+            raise ValueError, 'unknown volume unit: {0}'.format(units)
+        self.sendCmd('VOL {0}'.format(units))
+
+    def clearVolumeAccum(self,accumType='both'):
+        """
+        Clears the volume accumlator. If accumType == 'INF' then just the
+        infused volume accumulator is cleared. If accumType == 'WDR' then just
+        the withdrawn volume accumulator is cleared. If accumType='BOTH' then
+        both infused and withdrawn volume accumulators are cleared.   
+        """
+        accumType = accumType.lower()
+        if accumType in ('inf', 'both'):
+            self.sendCmd('CLD INF')
+        if accumType in ('wdr', 'both'):
+            self.sendCmd('CLD WDR')
+
+    def run(self):
+        """
+        Start the syringe pump. 
+        """
+        self.sendCmd('RUN')
+
+    def stop(self):
+        """
+        Stop the syring pump.
+        """
+        self.sendCmd('STP')
+
+    def getVolumeAccum(self):
+        """
+        Return the values in the pump volume accumulators. Value is always returned in
+        nano liters.
+        """
+        rsp = self.sendCmd('DIS')
+        rsp = [x for x in rsp]
+        rsp = rsp[1:-1] # Remove STX and ETX
+
+        # Get volume units
+        units = ''.join(rsp[-2:])
+        infuse = float(''.join(rsp[4:9]))
+        withdraw = float(''.join(rsp[10:15]))
+
+        if units == 'UL':
+            scale = 1.0e3
+        elif units == 'ML':
+            scale = 1.0e6
+        else:
+            raise IOError, 'unknown volume unit: {0}'.format(units)
+        infuse = scale*infuse
+        withdraw = scale*withdraw
+        return infuse, withdraw
+
+def float2PumpFormat(val):
+    """
+    Normalize floating point number into format suitable for sending
+    to the syringe pump
+    """
+    val = float(val)
+    if val < 0 or val >=1000:
+        raise ValueError, 'value out of range'
+    if val >= 100:
+        pumpStr = '{0:3.1f}'.format(val)
+    elif val >=10:
+        pumpStr = '{0:2.2f}'.format(val)
+    else:
+        pumpStr = '{0:1.3f}'.format(val)
+    return pumpStr
+
+
+
+
+# -----------------------------------------------------------------------------
+if __name__ == '__main__':
+    if 1:
+        dev = SyringePump('/dev/ttyUSB1')
+        dev.debug = False 
+        dev.setDiameter(1.0)
+        dev.setRate(5.0,'NS')
+        dev.setAccumUnits('UL')
+        dev.clearVolumeAccum()
+        dev.setDirection('INF')
+        infuse, withdraw = dev.getVolumeAccum()
+        print('infuse: {0} (nl), withdraw: {1} (nl)'.format(infuse,withdraw))
+        dev.run()
+        time.sleep(3)
+        dev.setDirection('WDR')
+        time.sleep(3)
+        infuse, withdraw = dev.getVolumeAccum()
+        print('infuse: {0} (nl), withdraw: {1} (nl)'.format(infuse,withdraw))
+        dev.stop()
+
+    if 0:
+
+        dev = SyringePump('/dev/ttyUSB1')
+        dev.sendCmd('DIA 1.000\r')
+        dev.sendCmd('RAT 0.100 UM\r')
+        dev.sendCmd('VOL UL\r')
+        dev.sendCmd('CLD INF\r')
+        dev.sendCmd('CLD WDR\r')
+        dev.sendCmd('DIR INF\r')
+        dev.sendCmd('DIS\r')
+        dev.sendCmd('RUN\r')
+        time.sleep(4.0)
+        dev.sendCmd('STP\r')
+        dev.sendCmd('DIS\r')
+
+