PySigmaKoki 1.0.0__tar.gz → 2.1.2__tar.gz

{PySigmaKoki-1.0.0 → PySigmaKoki-2.1.2}/PKG-INFO

@@ -1,17 +1,17 @@
-Metadata-Version: 1.0
+Metadata-Version: 2.1
 Name: PySigmaKoki
-Version: 1.0.0
+Version: 2.1.2
 Summary: Python Interface for Instruments by Sigma Koki
-Home-page: https://sourceforge.net/p/pysigmakoki/
+Home-page: https://github.com/akira-okumura/PySigmaKoki
 Author: Akira Okumura
 Author-email: oxon@mac.com
 License: BSD License
-Description: 
-        This is an interface module for instruments produced by Sigma Koki
-        
 Platform: MacOS :: MacOS X
 Platform: POSIX
 Platform: Windows
 Classifier: Topic :: Terminals :: Serial
-Classifier: Development Status :: 4 - Beta
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Programming Language :: Python
+
+
+This is an interface module for instruments produced by Sigma Koki

PySigmaKoki-2.1.2/PySigmaKoki.egg-info/PKG-INFO

@@ -0,0 +1,17 @@
+Metadata-Version: 2.1
+Name: PySigmaKoki
+Version: 2.1.2
+Summary: Python Interface for Instruments by Sigma Koki
+Home-page: https://github.com/akira-okumura/PySigmaKoki
+Author: Akira Okumura
+Author-email: oxon@mac.com
+License: BSD License
+Platform: MacOS :: MacOS X
+Platform: POSIX
+Platform: Windows
+Classifier: Topic :: Terminals :: Serial
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Programming Language :: Python
+
+
+This is an interface module for instruments produced by Sigma Koki

PySigmaKoki-2.1.2/PySigmaKoki.egg-info/SOURCES.txt

@@ -0,0 +1,8 @@
+README.md
+setup.py
+sigma_koki.py
+PySigmaKoki.egg-info/PKG-INFO
+PySigmaKoki.egg-info/SOURCES.txt
+PySigmaKoki.egg-info/dependency_links.txt
+PySigmaKoki.egg-info/requires.txt
+PySigmaKoki.egg-info/top_level.txt

PySigmaKoki-2.1.2/PySigmaKoki.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

PySigmaKoki-2.1.2/PySigmaKoki.egg-info/requires.txt

@@ -0,0 +1 @@
+pyserial

PySigmaKoki-2.1.2/PySigmaKoki.egg-info/top_level.txt

@@ -0,0 +1 @@
+sigma_koki

PySigmaKoki-2.1.2/README.md

@@ -0,0 +1,12 @@
+# PySigmaKoki
+Python module to control Sigma Koki stages
+
+# Example
+    >>> import sigma_koki
+    >>> gsc02 = sigma_koki.GSC02()
+    >>> gsc02.open('/dev/tty.usbserial-FTT75V89A')
+    >>> gsc02.setSpeed(1, 50, 20000, 1000, 50, 20000, 1000)
+    >>> gsc02.returnToMechanicalOrigin('+', '+')
+    >>> gsc02.move(-50000, -50000)
+    >>> gsc02.getStatus()
+    '-    50000,-    50000,K,K,R'

PySigmaKoki-2.1.2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

{PySigmaKoki-1.0.0 → PySigmaKoki-2.1.2}/setup.py

@@ -2,17 +2,17 @@ from distutils.core import setup
 import sigma_koki
 
 setup(name='PySigmaKoki',
-      version='1.0.0',
+      version='2.1.2',
       description='Python Interface for Instruments by Sigma Koki',
       author='Akira Okumura',
       author_email='oxon@mac.com',
       license='BSD License',
       platforms=['MacOS :: MacOS X', 'POSIX', 'Windows'],
-      url='https://sourceforge.net/p/pysigmakoki/',
+      url='https://github.com/akira-okumura/PySigmaKoki',
       py_modules=['sigma_koki'],
       install_requires=['pyserial'],
       classifiers=['Topic :: Terminals :: Serial',
-                   'Development Status :: 4 - Beta',
+                   'Development Status :: 5 - Production/Stable',
                    'Programming Language :: Python',
                    ],
       long_description=sigma_koki.__doc__

{PySigmaKoki-1.0.0 → PySigmaKoki-2.1.2}/sigma_koki.py

@@ -2,26 +2,65 @@
 This is an interface module for instruments produced by Sigma Koki
 """
 
-import exceptions
+try:
+    # It is not needed to import ValueError in newer Python versions
+    from exceptions import ValueError
+except:
+    pass
 import serial
 import sys
 
-class GSC02(object):
+class BaseStageController(object):
     """
-    Stage controller GSC-02
+    Stage controller class commonly used for Sigma Koki GSC02 and SHOT702
     """
-    def __init__(self):
-        self.__baudRate = 9600 # 9600 bps
+    def __init__(self, baudrate, product):
+        self.__baudRate = baudrate
         self.__parityBit = 'N' # None
         self.__dataBit = 8
         self.__stopBit = 1
         self.__rtscts = True
+        self.__product = product
+        self.__acknowledge =  True
 
     def setBaudRate(self, rate):
-        if rate in (2400, 4800, 9600, 19200):
+        if product == 'GSC-02' and rate in (2400, 4800, 9600, 19200):
+            self.__baudRate = rate
+        elif product == 'SHOT-702' and rate == 38400:
             self.__baudRate = rate
         else:
-            raise exceptions.ValueError('Invalid buard rate %d was given. Must be chosen from 2400/4800/9600/19200.' % rate)
+            raise ValueError('Attempting to set an invalid buard rate %d to %s. Must be chosen from 2400/4800/9600/19200 for GSC-02 and 38400 for SHOT-702.' % (rate, self.__product))
+
+    def disableAcknowledge(self):
+        self.__acknowledge = False
+
+    def write(self, command, acknowledge=True):
+        # 'str' class needs be converted into 'bytes'
+        # e.g., 'command' -> b'command'
+        self.serial.write((command + '\r\n').encode())
+
+        if not self.__acknowledge or not acknowledge:
+            return
+        
+        ack = self.readline()
+        if ack == 'OK':
+            return
+        else:
+            raise RuntimeError('%s returned bad acknowledge "%s"' % (self.__product, ack))
+
+    def query(self, command):
+        self.write(command, False)
+        return self.readline()
+
+    def readline(self):
+        # convert 'bytes' to 'str'
+        result = str(self.serial.readline())
+        if result[:2] == "b'" and result[-1:] == "'":
+            result = result[2:-1] # drop byte code prefix and suffix
+        if result[-4:] == '\\r\\n':
+            result = result[:-4] # drop delimeter
+
+        return result
 
     def open(self, port, readTimeOut = 1, writeTimeOut = 1):
         self.serial = serial.Serial(port         = port,
@@ -33,35 +72,42 @@ class GSC02(object):
                                     writeTimeout = writeTimeOut,
                                     rtscts       = self.__rtscts)
 
-    def write(self, command):
-        self.serial.write(command + '\r\n')
-
-    def readline(self):
-        return self.serial.readline()[:-2]
+    def close(self):
+        self.serial.close()
 
     def returnToMechanicalOrigin(self, stage1, stage2):
         """
         Moves the stages to the +/- end points and reset the coordinate values
         to zero.
         """
-        if stage1 == '+' and stage2 == '+':
-            self.write('H:W++')
-        elif stage1 == '+' and stage2 == '-':
-            self.write('H:W+-')
-        elif stage1 == '-' and stage2 == '+':
-            self.write('H:W-+')
-        elif stage1 == '-' and stage2 == '-':
-            self.write('H:W--')
-        elif stage1 == '+':
-            self.write('H:1+')
-        elif stage1 == '-':
-            self.write('H:1-')
-        elif stage2 == '+':
-            self.write('H:2+')
-        elif stage2 == '-':
-            self.write('H:2-')
-        else:
-            return
+        if self.__product == 'GSC-02':
+            if stage1 == '+' and stage2 == '+':
+                self.write('H:W++')
+            elif stage1 == '+' and stage2 == '-':
+                self.write('H:W+-')
+            elif stage1 == '-' and stage2 == '+':
+                self.write('H:W-+')
+            elif stage1 == '-' and stage2 == '-':
+                self.write('H:W--')
+            elif stage1 == '+':
+                self.write('H:1+')
+            elif stage1 == '-':
+                self.write('H:1-')
+            elif stage2 == '+':
+                self.write('H:2+')
+            elif stage2 == '-':
+                self.write('H:2-')
+            else:
+                return
+        elif self.__product == 'SHOT-702':
+            if stage1 == True and stage2 == True:
+                self.write('H:W')
+            elif stage1 == True:
+                self.write('H:1')
+            elif stage2 == True:
+                self.write('H:2')
+            else:
+                return
 
     def move(self, stage1, stage2):
         """
@@ -69,11 +115,16 @@ class GSC02(object):
         stepping driver, 1 pulse corresponds to "half-step movement" in the
         stage catalogues.
         """
-        if not (-16777214 <= stage1 <= 16777214):
-            raise exceptions.ValueError('stage1 must be between -16777214 and 16777214.')
+        if self.__product == 'GSC-02':
+            limit = 16777214
+        elif self.__product == 'SHOT-702':
+            limit = 268435455
+
+        if not (-limit <= stage1 <= limit):
+            raise ValueError('stage1 must be between -%d and %d.' % (limit, limit))
 
-        if not (-16777214 <= stage2 <= 16777214):
-            raise exceptions.ValueError('stage2 must be between -16777214 and 16777214.')
+        if not (-limit <= stage2 <= limit):
+            raise ValueError('stage2 must be between -%d and %d.' % (limit, limit))
 
         command = 'M:W'
         if stage1 >= 0:
@@ -152,6 +203,43 @@ class GSC02(object):
         if stage2:
             self.write('R:2')
 
+    def enableMotorExcitation(self, stage1 = True, stage2 = False):
+        """
+        Enables motor excitation
+        """
+        if stage1 in (True, False):
+            self.write('C:1%d' % stage1)
+
+        if stage2 in (True, False):
+            self.write('C:2%d' % stage2)
+
+    def getStatus(self):
+        """
+        Returns the status of the controller
+        """
+        return self.query('Q:')
+
+    def getACK3(self):
+        """
+        Returns the status of ACK3
+        """
+        return self.query('!:')
+
+    def getVersion(self):
+        """
+        Returns the ROM version
+        """
+        return self.query('?:V')
+
+class GSC02(BaseStageController):
+    """
+    Stage controller GSC-02
+    """
+    def __init__(self):
+        # 9600 bps the initial factory setting
+        BaseStageController.__init__(self, 9600, 'GSC-02')
+        self.disableAcknowledge()
+
     def setSpeed(self, highspeed, minSpeed1, maxSpeed1, accelerationTime1,
                  minSpeed2, maxSpeed2, accelerationTime2):
         """
@@ -173,53 +261,54 @@ class GSC02(object):
         """
         if not highspeed:
             if not (1 <= minSpeed1 <= maxSpeed1 <= 200):
-                raise exceptions.ValueError('Must be 1 <= minSpeed1 <= maxSpeed1 <= 200 in low speed range.')
+                raise ValueError('Must be 1 <= minSpeed1 <= maxSpeed1 <= 200 in low speed range.')
             if not (1 <= minSpeed2 <= maxSpeed2 <= 200):
-                raise exceptions.ValueError('Must be 1 <= minSpeed2 <= maxSpeed2 <= 200 in low speed range.')
+                raise ValueError('Must be 1 <= minSpeed2 <= maxSpeed2 <= 200 in low speed range.')
         else:
             if not (50 <= minSpeed1 <= maxSpeed1 <= 20000):
-                raise exceptions.ValueError('Must be 50 <= minSpeed1 <= maxSpeed1 <= 20000 in high speed range.')
+                raise ValueError('Must be 50 <= minSpeed1 <= maxSpeed1 <= 20000 in high speed range.')
             if not (50 <= minSpeed2 <= maxSpeed2 <= 20000):
-                raise exceptions.ValueError('Must be 50 <= minSpeed2 <= maxSpeed2 <= 20000 in high speed range.')
+                raise ValueError('Must be 50 <= minSpeed2 <= maxSpeed2 <= 20000 in high speed range.')
 
         if not (0 <= accelerationTime1 <= 1000):
-            raise exceptions.ValueError('Must be 00 <= accelerationTime1 <= 1000.')
+            raise ValueError('Must be 0 <= accelerationTime1 <= 1000.')
 
         if not (0 <= accelerationTime2 <= 1000):
-            raise exceptions.ValueError('Must be 00 <= accelerationTime2 <= 1000.')
+            raise ValueError('Must be 0 <= accelerationTime2 <= 1000.')
 
         if highspeed:
             self.write('D:2S%dF%dR%dS%dF%dR%d' % (minSpeed1, maxSpeed1, accelerationTime1, minSpeed2, maxSpeed2, accelerationTime2))
         else:
             self.write('D:1S%dF%dR%dS%dF%dR%d' % (minSpeed1, maxSpeed1, accelerationTime1, minSpeed2, maxSpeed2, accelerationTime2))
 
-    def enableMotorExcitation(self, stage1 = True, stage2 = False):
+class SHOT702(BaseStageController):
+    """
+    Stage controller SHOT-702
+    """
+    def __init__(self):
+        # 9600 bps the initial factory setting
+        BaseStageController.__init__(self, 38400, 'SHOT-702')
+
+    def setSpeed(self, minSpeed1, maxSpeed1, accelerationTime1, minSpeed2, maxSpeed2, accelerationTime2):
         """
-        Enables motor excitation
+        Sets the movement speeds of the stages
+        minSpeed1/2: Minimum speed (PPS)
+        maxSpeed1/2: Maximum speed (PPS)
+        accelerationTime1/2: Acceleration time to be taken from min to max (ms)     
         """
-        if stage1 in (True, False):
-            self.write('C:1%d' % stage1)
+        if not (1 <= minSpeed1 <= maxSpeed1 <= 500000):
+            raise ValueError('Must be 1 <= minSpeed1 <= maxSpeed1 <= 500000.')
 
-        if stage2 in (True, False):
-            self.write('C:2%d' % stage2)
+        if not (1 <= minSpeed2 <= maxSpeed2 <= 500000):
+            raise ValueError('Must be 1 <= minSpeed2 <= maxSpeed2 <= 500000.')
 
-    def getStatus(self):
-        """
-        Returns the status of the controller
-        """
-        self.write('Q:')
-        return self.readline()
+        if not (0 <= accelerationTime1 <= 1000):
+            raise ValueError('Must be 0 <= accelerationTime <= 1000.')
 
-    def getACK3(self):
-        """
-        Returns the status of ACK3
-        """
-        self.write('!:')
-        return self.readline()
+        if not (0 <= accelerationTime2 <= 1000):
+            raise ValueError('Must be 0 <= accelerationTime <= 1000.')
 
-    def getVersion(self):
-        """
-        Returns the ROM version
-        """
-        self.write('?:V')
-        return self.readline()
+        self.write('D:WS%dF%dR%dS%dF%dR%d' % (minSpeed1, maxSpeed1, accelerationTime1, minSpeed2, maxSpeed2, accelerationTime2))
+
+    # Some query commands, ?:P, ?:S, ?:D, and ?:B, are not implemented yet
+    

PySigmaKoki-1.0.0/README

@@ -1,12 +0,0 @@
-=== Requirements ===
-- PySerial
-
-=== Example ===
->>> import sigma_koki
->>> gsc02 = sigma_koki.GSC02()
->>> gsc02.open('/dev/tty.usbserial-FTT75V89A')
->>> gsc02.setSpeed(1, 50, 20000, 1000, 50, 20000, 1000)
->>> gsc02.returnToMechanicalOrigin('+', '+')
->>> gsc02.move(-50000, -50000)
->>> gsc02.getStatus()
-'-    50000,-    50000,K,K,R'