newportxps 0.2__tar.gz → 0.3.0__tar.gz

newportxps-0.3.0/LICENSE

@@ -0,0 +1,25 @@
+BSD 2-Clause License
+
+Copyright (c) 2018, Matthew Newville, The University of Chicago
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

newportxps-0.3.0/PKG-INFO

@@ -0,0 +1,121 @@
+Metadata-Version: 2.1
+Name: newportxps
+Version: 0.3.0
+Summary: Python interface to Newport XPS motion controllers
+Author-email: Matthew Newville <newville@cars.uchicago.edu>
+License: BSD License
+Keywords: motion control,data collection
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Other Audience
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: Jython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Topic :: Education
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pysftp
+
+# newportxps
+
+This module provides code for using Newport XPS motor controllers from Python.
+
+While Newport Corp. has provided a basic socket and ftp interface to the XPS
+controller for a long time, this interface is very low-level. In addition,
+there are some incompatibilities between the different generations of XPS
+controllers (generations C, Q, D in that chronological order), and a lack of
+support for Python 3 in the Newport-provided interface.  The `newportxps`
+module here aims to provide a simple, user-friendly interface for the Newport
+XPS that works uniformly for all three generations of XPS and for both Python
+2 and 3.
+
+As an example, connecting to and reading the status of an XPS controller may
+look like this:
+
+```python
+ >>> from newportxps import NewportXPS
+ >>> xps = NewportXPS('164.54.160.000', username='Administrator', password='Please.Let.Me.In')
+ >>> print(xps.status_report())
+ # XPS host:         164.54.160.000 (164.54.160.000)
+ # Firmware:         XPS-D-N13006
+ # Current Time:     Sun Sep 16 13:40:24 2018
+ # Last Reboot:      Wed Sep 12 14:46:44 2018
+ # Trajectory Group: None
+ # Groups and Stages
+ DetectorZ (SingleAxisInUse), Status: Ready state from motion
+    DetectorZ.Pos (ILS@ILS150CC@XPS-DRV11)
+       Hardware Status: First driver powered on - ZM low level
+       Positioner Errors: OK
+ SampleX (SingleAxisInUse), Status: Ready state from motion
+    SampleX.Pos (UTS@UTS150PP@XPS-DRV11)
+       Hardware Status: First driver powered on - ZM high level
+       Positioner Errors: OK
+ SampleY (SingleAxisInUse), Status: Ready state from motion
+    SampleY.Pos (UTS@UTS150PP@XPS-DRV11)
+       Hardware Status: First driver powered on - ZM high level
+       Positioner Errors: OK
+ SampleZ (SingleAxisInUse), Status: Ready state from motion
+   SampleZ.Pos (UTS@UTS150PP@XPS-DRV11)
+       Hardware Status: First driver powered on - ZM low level
+       Positioner Errors: OK
+
+ >>> for gname, info in xps.groups.items():
+ ...     print(gname, info)
+ ...
+ DetectorX {'category': 'SingleAxisInUse', 'positioners': ['Pos']}
+ SampleX {'category': 'SingleAxisInUse', 'positioners': ['Pos']}
+ SampleY {'category': 'SingleAxisInUse', 'positioners': ['Pos']}
+ SampleZ {'category': 'SingleAxisInUse', 'positioners': ['Pos']}
+ >>>
+ >>> for sname, info in xps.stages.items():
+ ...     print(sname, xps.get_stage_position(sname), info)
+ ...
+ DetectorX.Pos 36.5 {'type': 'ILS@ILS150CC@XPS-DRV11', 'max_velo': 100, 'max_accel': 400, 'low_limit': -74, 'high_limit': 74}
+ SampleX.Pos 1.05 {'type': 'UTS@UTS150PP@XPS-DRV11', 'max_velo': 20, 'max_accel': 80, 'low_limit': -74, 'high_limit': 74}
+ SampleY.Pos 0.24 {'type': 'UTS@UTS150PP@XPS-DRV11', 'max_velo': 20, 'max_accel': 80, 'low_limit': -74, 'high_limit': 74}
+ SampleZ.Pos 2.5 {'type': 'UTS@UTS150PP@XPS-DRV11', 'max_velo': 20, 'max_accel': 80, 'low_limit': -74, 'high_limit': 74}
+
+ >>> xps.move_stage('SampleZ.Pos', 1.0)
+
+ >>> xps.home_group('DetectorX')
+
+
+```
+
+On creation and initialization of the NewportXPS, the Groups and status of the
+controller are read in and Stages defined so that they can be queried or
+moved.
+
+
+The `NewportXPS` class has a number of methods to interact with the controller including:
+
+   * reboot controller
+   * get status, hardware errors, etc.
+   * save and upload new `system.ini` and `stages.ini` files.
+   * enable and disable Groups.
+   * initialize and home Stages and Groups of Stages.
+   * read Stage positions.
+   * move Stages and Groups to new positions.
+   * set Stage velocity.
+   * define simple linear trajectories (using PVT mode), both 'forward' and 'backward'.
+   * upload any PVT trajectory.
+   * arm PVT trajectory.
+   * run PVT trajectory.
+   * read and save Gathering file for a trajectory.

{newportxps-0.2 → newportxps-0.3.0}/newportxps/XPS_C8_drivers.py

@@ -14,11 +14,8 @@
 
 import sys
 import socket
-import six
-from collections import OrderedDict
-
-from .utils import bytes2str
 
+from .utils import bytes2str, str2bytes
 
 class XPSException(Exception):
     """XPS Controller Exception"""
@@ -41,7 +38,7 @@ class XPS:
         XPS.__nbSockets = 0
         for socketId in range(self.MAX_NB_SOCKETS):
             XPS.__usedSockets[socketId] = 0
-        self.errorcodes = OrderedDict()
+        self.errorcodes = {}
 
     def withValidSocket(fcn):
         """ decorator to ensure that a valid socket is passed as the
@@ -64,7 +61,7 @@ class XPS:
     def __sendAndReceive (self, socketId, command):
         # print("SEND REC ", command, type(command))
         try:
-            XPS.__sockets[socketId].send(six.b(command))
+            XPS.__sockets[socketId].send(str2bytes(command))
             ret = bytes2str(XPS.__sockets[socketId].recv(1024))
             while (ret.find(',EndOfAPI') == -1):
                 ret += bytes2str(XPS.__sockets[socketId].recv(1024))
@@ -114,7 +111,7 @@ class XPS:
             return -1
 
         err, ret = self.ErrorListGet(socketId)
-        self.errorcodes = OrderedDict()
+        self.errorcodes = {}
         for cline in ret.split(';'):
             if ':' in cline:
                 ecode, message = cline.split(':', 1)
@@ -233,7 +230,7 @@ class XPS:
 
     # TimerSet :  Set a timer
     def TimerSet (self, socketId, TimerName, FrequencyTicks):
-        return self.Send(socketId, 'TimerSet(%s, %s)' (TimerName, str(FrequencyTicks)))
+        return self.Send(socketId, 'TimerSet(%s, %s)' % (TimerName, str(FrequencyTicks)))
 
     # Reboot :  Reboot the controller
     def Reboot (self, socketId):
@@ -1345,6 +1342,19 @@ class XPS:
         command = 'PositionerPositionCompareAquadBWindowedSet(' + PositionerName + ',' + str(MinimumPosition) + ',' + str(MaximumPosition) + ')'
         return self.Send(socketId, command)
 
+    # PositionerPositionCompareAquadBPrescalerSet: Sets PCO AquadB interpolation factor.
+    def PositionerPositionCompareAquadBPrescalerSet(self, socketId, PositionerName, PCOInterpolationFactor):
+        command = 'PositionerPositionCompareAquadBPrescalerSet(' + PositionerName + ',' + str(
+            PCOInterpolationFactor) + ')'
+        return self.Send(socketId, command)
+
+    # PositionerPositionCompareAquadBPrescalerGet : Gets PCO AquadB interpolation factor.
+    def PositionerPositionCompareAquadBPrescalerGet(self, socketId, PositionerName):
+        command = 'PositionerPositionCompareAquadBPrescalerGet(' + PositionerName + ',double *)'
+        error, returnedString = self.Send(socketId, command)
+        if (error != 0):
+            return [error, returnedString]
+
     # PositionerPositionCompareGet :  Read position compare parameters
     def PositionerPositionCompareGet (self, socketId, PositionerName):
         command = 'PositionerPositionCompareGet(' + PositionerName + ',double *,double *,double *,bool *)'
@@ -1601,6 +1611,11 @@ class XPS:
     def MultipleAxesPVTVerification (self, socketId, GroupName, TrajectoryFileName):
         command = 'MultipleAxesPVTVerification(' + GroupName + ',' + TrajectoryFileName + ')'
         return self.Send(socketId, command)
+    
+    # MultipleAxesPTVerification :  Multiple axes PT trajectory verification
+    def MultipleAxesPTVerification (self, socketId, GroupName, TrajectoryFileName):
+        command = 'MultipleAxesPTVerification(' + GroupName + ',' + TrajectoryFileName + ')'
+        return self.Send(socketId, command)
 
     # MultipleAxesPVTVerificationResultGet :  Multiple axes PVT trajectory verification result get
     def MultipleAxesPVTVerificationResultGet (self, socketId, PositionerName):
@@ -1621,6 +1636,11 @@ class XPS:
     def MultipleAxesPVTExecution (self, socketId, GroupName, TrajectoryFileName, ExecutionNumber):
         command = 'MultipleAxesPVTExecution(' + GroupName + ',' + TrajectoryFileName + ',' + str(ExecutionNumber) + ')'
         return self.Send(socketId, command)
+    
+    # MultipleAxesPTExecution :  Multiple axes PT trajectory execution
+    def MultipleAxesPTExecution (self, socketId, GroupName, TrajectoryFileName, ExecutionNumber):
+        command = 'MultipleAxesPTExecution(' + GroupName + ',' + TrajectoryFileName + ',' + str(ExecutionNumber) + ')'
+        return self.Send(socketId, command)
 
     # MultipleAxesPVTParametersGet :  Multiple axes PVT trajectory get parameters
     def MultipleAxesPVTParametersGet (self, socketId, GroupName):
@@ -2036,3 +2056,13 @@ class XPS:
     # TestTCP :  Test TCP/IP transfert
     def TestTCP (self, socketId, InputString):
         return self.Send(socketId, 'TestTCP(%s, char *)' % InputString)
+
+    # ========== Only for XPS-D ==========
+
+    # CleanCoreDumpFolder :   Remove core file in /Admin/Public/CoreDump folder
+    def CleanCoreDumpFolder (self, socketId):
+        return self.Send(socketId, 'CleanCoreDumpFolder()')
+
+    # CleanTmpFolder :   Clean the tmp folder
+    def CleanTmpFolder(self, socketId):
+        return self.Send(socketId, 'CleanTmpFolder()')

{newportxps-0.2 → newportxps-0.3.0}/newportxps/ftp_wrapper.py

@@ -1,10 +1,8 @@
 #!/usr/bin/env python
 
-from __future__ import print_function
-import os
 import ftplib
-import six
-from .utils import six, bytes2str, bytesio, FTP_ENCODING
+from io import BytesIO
+from .utils import str2bytes, bytes2str, ENCODING
 
 import logging
 logger = logging.getLogger('paramiko')
@@ -37,19 +35,19 @@ class FTPBaseWrapper(object):
         self._conn.cwd(remotedir)
 
     def connect(self, host=None, username=None, password=None):
-        raise NotImplemented
+        raise NotImplementedError
 
     def save(self, remotefile, localfile):
         "save remote file to local file"
-        raise NotImplemented
+        raise NotImplementedError
 
     def getlines(self, remotefile):
         "read text of remote file"
-        raise NotImplemented
+        raise NotImplementedError
 
     def put(self, text, remotefile):
         "put text to remote file"
-        raise NotImplemented
+        raise NotImplementedError
 
 
 class SFTPWrapper(FTPBaseWrapper):
@@ -72,7 +70,7 @@ class SFTPWrapper(FTPBaseWrapper):
         try:
             self._conn = pysftp.Connection(self.host,
                                            username=self.username,
-                                           password=self.username)
+                                           password=self.password)
         except:
             print("ERROR: sftp connection to %s failed" % self.host)
             print("You may need to add the host keys for your XPS to your")
@@ -82,18 +80,18 @@ class SFTPWrapper(FTPBaseWrapper):
 
     def save(self, remotefile, localfile):
         "save remote file to local file"
-        self._conn.get(remotefile, remotefile)
+        self._conn.get(remotefile, localfile)
 
     def getlines(self, remotefile):
         "read text of remote file"
-        tmp = bytesio()
+        tmp = BytesIO()
         self._conn.getfo(remotefile, tmp)
         tmp.seek(0)
         text = bytes2str(tmp.read())
         return text.split('\n')
 
     def put(self, text, remotefile):
-        txtfile = bytesio(six.b(text))
+        txtfile = BytesIO(str2bytes(text))
         self._conn.putfo(txtfile, remotefile)
 
 
@@ -116,14 +114,15 @@ class FTPWrapper(FTPBaseWrapper):
         self._conn.connect(self.host)
         self._conn.login(self.username, self.password)
 
+    def list(self):
+        "list files in a given directory (default the current)"
+        return self._conn.nlst()
+
     def save(self, remotefile, localfile):
         "save remote file to local file"
         output = []
-        x = self._conn.retrbinary('RETR %s' % remotefile, output.append)
-        open_opts = {}
-        if six.PY3:
-            open_opts['encoding'] = FTP_ENCODING
-        with open(localfile, 'w', **open_opts) as fout:
+        self._conn.retrbinary(f'RETR {remotefile}', output.append)
+        with open(localfile, 'w', encoding=ENCODING) as fout:
             fout.write(''.join([bytes2str(s) for s in output]))
 
     def getlines(self, remotefile):
@@ -134,6 +133,9 @@ class FTPWrapper(FTPBaseWrapper):
         return text.split('\n')
 
     def put(self, text, remotefile):
-        txtfile = bytesio(six.b(text))
-        # print(" Put ", text, txtfile)
+        txtfile = BytesIO(str2bytes(text))
         self._conn.storbinary('STOR %s' % remotefile, txtfile)
+
+    def delete(self, remotefile):
+        "delete remote file"
+        self._conn.delete(remotefile)

{newportxps-0.2 → newportxps-0.3.0}/newportxps/newportxps.py

@@ -1,19 +1,17 @@
-#!/usr/bin/env python
+ #!/usr/bin/env python
 
-from __future__ import print_function
 import os
 import posixpath
 import sys
 import time
 import socket
-from collections import OrderedDict
-
-from six.moves import StringIO
-from six.moves.configparser import  ConfigParser
+from io import StringIO
+from configparser import  ConfigParser
 import numpy as np
 
+from .debugtime import debugtime
+from .utils import clean_text
 from .XPS_C8_drivers import XPS, XPSException
-
 from .ftp_wrapper import SFTPWrapper, FTPWrapper
 
 IDLE, ARMING, ARMED, RUNNING, COMPLETE, WRITING, READING = \
@@ -31,6 +29,7 @@ def withConnectedXPS(fcn):
 
     return wrapper
 
+
 class NewportXPS:
     gather_header = '# XPS Gathering Data\n#--------------'
     def __init__(self, host, group=None,
@@ -38,11 +37,6 @@ class NewportXPS:
                  port=5001, timeout=10, extra_triggers=0,
                  outputs=('CurrentPosition', 'SetpointPosition')):
 
-        socket.setdefaulttimeout(5.0)
-        try:
-            host = socket.gethostbyname(host)
-        except:
-            raise ValueError('Could not resolve XPS name %s' % host)
         self.host = host
         self.port = port
         self.username = username
@@ -57,8 +51,9 @@ class NewportXPS:
         self.traj_file = None
         self.traj_positioners = None
 
-        self.stages = OrderedDict()
-        self.groups = OrderedDict()
+        self.nsegments = -1
+        self.stages = {}
+        self.groups = {}
         self.firmware_version = None
 
         self.ftpconn = None
@@ -71,6 +66,9 @@ class NewportXPS:
         if group is not None:
             self.set_trajectory_group(group)
 
+    def __repr__(self):
+        return f"NewportXPS(host='{self.host}', port={self.port})"
+
     @withConnectedXPS
     def status_report(self):
         """return printable status report"""
@@ -113,7 +111,7 @@ class NewportXPS:
         self.firmware_version = val
         self.ftphome = ''
 
-        if 'XPS-D' in self.firmware_version:
+        if any([m in self.firmware_version for m in ['XPS-D', 'HXP-D']]):
             err, val = self._xps.Send(self._sid, 'InstallerVersionGet(char *)')
             self.firmware_version = val
             self.ftpconn = SFTPWrapper(**self.ftpargs)
@@ -128,7 +126,7 @@ class NewportXPS:
 
 
     def check_error(self, err, msg='', with_raise=True):
-        if err is not 0:
+        if err != 0:
             err = "%d" % err
             desc = self._xps.errorcodes.get(err, 'unknown error')
             print("XPSError: message= %s, error=%s, description=%s" % (msg, err, desc))
@@ -165,19 +163,20 @@ class NewportXPS:
         self.ftpconn.cwd(posixpath.join(self.ftphome, 'Config'))
         lines = self.ftpconn.getlines('system.ini')
         self.ftpconn.close()
+        initext = '\n'.join([line.strip() for line in lines])
 
         pvtgroups = []
-        self.stages= OrderedDict()
-        self.groups = OrderedDict()
+        self.stages= {}
+        self.groups = {}
         sconf = ConfigParser()
-        sconf.readfp(StringIO('\n'.join(lines)))
+        sconf.readfp(StringIO(initext))
 
         # read and populate lists of groups first
         for gtype, glist in sconf.items('GROUPS'): # ].items():
             if len(glist) > 0:
                 for gname in glist.split(','):
                     gname = gname.strip()
-                    self.groups[gname] = OrderedDict()
+                    self.groups[gname] = {}
                     self.groups[gname]['category'] = gtype.strip()
                     self.groups[gname]['positioners'] = []
                     if gtype.lower().startswith('multiple'):
@@ -236,9 +235,71 @@ class NewportXPS:
         """
         self.ftpconn.connect(**self.ftpargs)
         self.ftpconn.cwd(posixpath.join(self.ftphome, 'Public', 'Trajectories'))
-        self.ftpconn.put(text, filename)
+        self.ftpconn.put(clean_text(text), filename)
+        self.ftpconn.close()
+
+    def list_scripts(self):
+        """list all existent scripts files
+        """
+        remotefiles = ""
+        self.ftpconn.connect(**self.ftpargs)
+        self.ftpconn.cwd(posixpath.join(self.ftphome, 'Public', 'Scripts'))
+        remotefiles = self.ftpconn.list()
+        self.ftpconn.close()
+
+        return remotefiles
+
+    def read_script(self, filename):
+        """read script content
+
+        Arguments:
+        ----------
+           filename (str):  name of script file
+        """
+        filecontent = ""
+        self.ftpconn.connect(**self.ftpargs)
+        self.ftpconn.cwd(posixpath.join(self.ftphome, 'Public', 'Scripts'))
+        filecontent = self.ftpconn.getlines(filename)
+        self.ftpconn.close()
+
+        return filecontent
+
+    def download_script(self, filename):
+        """download script file
+
+        Arguments:
+        ----------
+           filename (str):  name of script file
+        """
+        self.ftpconn.connect(**self.ftpargs)
+        self.ftpconn.cwd(posixpath.join(self.ftphome, 'Public', 'Scripts'))
+        self.ftpconn.save(filename, filename)
+        self.ftpconn.close()
+
+    def upload_script(self, filename, text):
+        """upload script file
+
+        Arguments:
+        ----------
+           filename (str):  name of script file
+           text  (str):   full text of script file
+        """
+        self.ftpconn.connect(**self.ftpargs)
+        self.ftpconn.cwd(posixpath.join(self.ftphome, 'Public', 'Scripts'))
+        self.ftpconn.put(clean_text(text), filename)
         self.ftpconn.close()
 
+    def delete_script(self, filename):
+        """delete script file
+
+        Arguments:
+        ----------
+           filename (str):  name of script file
+        """
+        self.ftpconn.connect(**self.ftpargs)
+        self.ftpconn.cwd(posixpath.join(self.ftphome, 'Public', 'Scripts'))
+        self.ftpconn.delete(filename)
+        self.ftpconn.close()
 
     def upload_systemini(self, text):
         """upload text of system.ini
@@ -249,7 +310,7 @@ class NewportXPS:
         """
         self.ftpconn.connect(**self.ftpargs)
         self.ftpconn.cwd(posixpath.join(self.ftphome, 'Config'))
-        self.ftpconn.put(text, 'system.ini')
+        self.ftpconn.put(clean_text(text), 'system.ini')
         self.ftpconn.close()
 
     def upload_stagesini(self, text):
@@ -269,7 +330,7 @@ class NewportXPS:
         """
         self.ftpconn.connect(**self.ftpargs)
         self.ftpconn.cwd(posixpath.join(self.ftphome, 'Config'))
-        self.ftpconn.put(text, 'system.ini')
+        self.ftpconn.put(clean_text(text), 'stages.ini')
         self.ftpconn.close()
 
     @withConnectedXPS
@@ -413,8 +474,12 @@ class NewportXPS:
         initialize all groups, no homing
         """
         for g in self.groups:
-            self.initialize_group(group=g)
-
+            try:
+                self.initialize_group(group=g)
+            except XPSException:
+                print(f"Warning: could not initialize '{g}' (already initialized?)")
+                
+                
     def home_allgroups(self, with_encoder=True, home=False):
         """
         home all groups
@@ -481,7 +546,7 @@ class NewportXPS:
         """
         get dictionary of status for each group
         """
-        out = OrderedDict()
+        out = {}
         for group in self.groups:
             err, stat = self._xps.GroupStatusGet(self._sid, group)
             self.check_error(err, msg="GroupStatus '%s'" % (group))
@@ -497,7 +562,7 @@ class NewportXPS:
         """
         get dictionary of hardware status for each stage
         """
-        out = OrderedDict()
+        out = {}
         for stage in self.stages:
             if stage in ('', None): continue
             err, stat = self._xps.PositionerHardwareStatusGet(self._sid, stage)
@@ -513,7 +578,7 @@ class NewportXPS:
         """
         get dictionary of positioner errors for each stage
         """
-        out = OrderedDict()
+        out = {}
         for stage in self.stages:
             if stage in ('', None): continue
             err, stat = self._xps.PositionerErrorGet(self._sid, stage)
@@ -583,6 +648,18 @@ class NewportXPS:
                 vals.append(ret[i+1])
         self._xps.GroupMoveAbsolute(self._sid, group, vals)
 
+    @withConnectedXPS
+    def execute_script(self, script, task, arguments):
+        """
+        Execute a TCL script
+
+        Parameters:
+           script (string): name of script file
+           task (string): task name to be identified
+           arguments (string): script arguments
+        """
+        self._xps.TCLScriptExecute(self._sid, script, task, arguments)
+
     @withConnectedXPS
     def move_stage(self, stage, value, relative=False):
         """
@@ -767,13 +844,11 @@ class NewportXPS:
         for out in self.gather_outputs:
             for i, ax in enumerate(traj['axes']):
                 outputs.append('%s.%s.%s' % (self.traj_group, ax, out))
-                # move_kws[ax] = float(traj['start'][i])
 
+        end_segment = traj['nsegments'] # - 1 + self.extra_triggers
+        self.nsegments = end_segment
 
-        end_segment = traj['nsegments'] - 1 + self.extra_triggers
-        # self.move_group(self.traj_group, **move_kws)
         self.gather_titles = "%s\n#%s\n" % (self.gather_header, " ".join(outputs))
-
         err, ret = self._xps.GatheringReset(self._sid)
         self.check_error(err, msg="GatheringReset")
         if verbose:
@@ -785,7 +860,7 @@ class NewportXPS:
         if verbose:
             print(" GatheringConfigurationSet outputs ", outputs)
             print(" GatheringConfigurationSet returned ", ret)
-            print( end_segment, traj['pixeltime'])
+            print(" segments, pixeltime" , end_segment, traj['pixeltime'])
 
         err, ret = self._xps.MultipleAxesPVTPulseOutputSet(self._sid, self.traj_group,
                                                            2, end_segment,
@@ -803,7 +878,7 @@ class NewportXPS:
         self.traj_state = ARMED
 
     @withConnectedXPS
-    def run_trajectory(self, name=None, save=True,
+    def run_trajectory(self, name=None, save=True, clean=False,
                        output_file='Gather.dat', verbose=False):
 
         """run a trajectory in PVT mode
@@ -811,8 +886,14 @@ class NewportXPS:
         The trajectory *must be in the ARMED state
         """
 
-        if name in self.trajectories:
-            self.arm_trajectory(name)
+        if 'xps-d' in self.firmware_version.lower():
+            self._xps.CleanTmpFolder(self._sid)
+
+            if clean:
+                self._xps.CleanCoreDumpFolder(self._sid)
+
+        if name in self.trajectories and self.traj_state != ARMED:
+            self.arm_trajectory(name, verbose=verbose)
 
         if self.traj_state != ARMED:
             raise XPSException("Must arm trajectory before running!")
@@ -851,41 +932,70 @@ class NewportXPS:
         self.traj_state = COMPLETE
         npulses = 0
         if save:
-            self.read_and_save(output_file)
+            self.read_and_save(output_file, verbose=verbose)
         self.traj_state = IDLE
         return npulses
 
     @withConnectedXPS
-    def read_and_save(self, output_file):
+    def read_and_save(self, output_file, verbose=False):
         "read and save gathering file"
         self.ngathered = 0
-        npulses, buff = self.read_gathering(set_idle_when_done=False)
+        npulses, buff = self.read_gathering(set_idle_when_done=False,
+                                            verbose=verbose)
+        if npulses < 1:
+            return
         self.save_gathering_file(output_file, buff,
-                                 verbose=False,
+                                 verbose=verbose,
                                  set_idle_when_done=False)
         self.ngathered = npulses
 
     @withConnectedXPS
-    def read_gathering(self, set_idle_when_done=True, debug_time=False):
+    def read_gathering(self, set_idle_when_done=True, verbose=False,
+                       debug_time=False):
         """
         read gathering data from XPS
         """
+        verbose = verbose or debug_time
+        if verbose:
+            print("READ Gathering XPS ", self.host, self._sid,
+                  self.nsegments, time.ctime())
+        dt = debugtime()
         self.traj_state = READING
-        ret, npulses, nx = self._xps.GatheringCurrentNumberGet(self._sid)
+        npulses = -1
+        t0 = time.time()
+        while npulses < 1:
+            try:
+                ret, npulses, nx = self._xps.GatheringCurrentNumberGet(self._sid)
+            except SyntaxError:
+                print("#XPS Gathering Read failed, will try again")
+                pass
+            if time.time()-t0 > 5:
+                print("Failed to get gathering size after 5 seconds: return 0 points")
+                print("Gather Returned: ", ret, npulses, nx, self._xps, time.ctime())
+                return (0, ' \n')
+            if npulses < 1 or ret != 0:
+                time.sleep(0.05)
+        dt.add("gather num %d npulses=%d (%d)" % (ret, npulses, self.nsegments))
         counter = 0
         while npulses < 1 and counter < 5:
             counter += 1
-            time.sleep(0.5)
+            time.sleep(0.25)
             ret, npulses, nx = self._xps.GatheringCurrentNumberGet(self._sid)
             print( 'Had to do repeat XPS Gathering: ', ret, npulses, nx)
-        ret, buff = self._xps.GatheringDataMultipleLinesGet(self._sid, 0, npulses)
+        dt.add("gather before multilinesget, npulses=%d" % (npulses))
+        try:
+            ret, buff = self._xps.GatheringDataMultipleLinesGet(self._sid, 0, npulses)
+        except ValueError:
+            print("Failed to read gathering: ", ret, buff)
+            return (0, ' \n')
+        dt.add("gather after multilinesget  %d" % ret)
         nchunks = -1
         if ret < 0:  # gathering too long: need to read in chunks
             nchunks = 3
             nx  = int((npulses-2) / nchunks)
             ret = 1
             while True:
-                time.sleep(0.1)
+                time.sleep(0.05)
                 ret, xbuff = self._xps.GatheringDataMultipleLinesGet(self._sid, 0, nx)
                 if ret == 0:
                     break
@@ -902,23 +1012,25 @@ class NewportXPS:
                                                                 npulses-nchunks*nx)
             buff.append(xbuff)
             buff = ''.join(buff)
-
+        dt.add("gather after got buffer  %d" % len(buff))
         obuff = buff[:]
         for x in ';\r\t':
             obuff = obuff.replace(x,' ')
-
+        dt.add("gather cleaned buffer  %d" % len(obuff))
         if set_idle_when_done:
             self.traj_state = IDLE
+        if verbose:
+            dt.show()
         return npulses, obuff
 
-    def save_gathering_file(self, fname, buffer, verbose=False, set_idle_when_done=True):
+    def save_gathering_file(self, fname, buff, verbose=False, set_idle_when_done=True):
         """save gathering buffer read from read_gathering() to text file"""
         self.traj_state = WRITING
         f = open(fname, 'w')
         f.write(self.gather_titles)
-        f.write(buffer)
+        f.write(buff)
         f.close()
-        nlines = len(buffer.split('\n')) - 1
+        nlines = len(buff.split('\n')) - 1
         if verbose:
             print('Wrote %i lines, %i bytes to %s' % (nlines, len(buff), fname))
         if set_idle_when_done:
@@ -1052,16 +1164,14 @@ class NewportXPS:
                 outputs.append('%s.%s.%s' % (self.traj_group, ax, out))
                 # move_kws[ax] = float(traj['start'][i])
 
-
         end_segment = traj['nsegments'] - 1 + self.extra_triggers
         # self.move_group(self.traj_group, **move_kws)
         self.gather_titles = "%s\n#%s\n" % (self.gather_header, " ".join(outputs))
 
-
         self._xps.GatheringReset(self._sid)
         self._xps.GatheringConfigurationSet(self._sid, self.gather_outputs)
 
-        print("step_number", step_number)
+        # print("step_number", step_number)
         ret = self._xps.MultipleAxesPVTPulseOutputSet(self._sid, self.traj_group,
                                                       2, step_number + 1, dtime)
         ret = self._xps.MultipleAxesPVTVerification(self._sid, self.traj_group, traj_file)

newportxps-0.3.0/newportxps/utils.py

@@ -0,0 +1,33 @@
+
+# it appears ftp really wants this encoding:
+ENCODING = 'latin-1'
+
+def bytes2str(s):
+    'byte to string conversion'
+    if isinstance(s, str):
+        return s
+    if isinstance(s, bytes):
+        return str(s, ENCODING)
+    else:
+        return str(s)
+
+def str2bytes(s):
+    'string to bytes conversion'
+    if isinstance(s, bytes):
+        return s
+    if not isinstance(s, str):
+        s = str(s)
+    return s.encode(ENCODING)
+
+def read_xps_file(fname):
+    """read file written by XPS, decoding bytes as latin-1"""
+    with open(fname, 'rb') as fh:
+        data = fh.read()
+    return data.decode(ENCODING)
+
+def clean_text(text):
+    buff = []
+    for line in text.split('\n'):
+        line = line.replace('\r', '').replace('\n', '') + ' '
+        buff.append(line)
+    return '\n'.join(buff)

newportxps-0.3.0/newportxps.egg-info/PKG-INFO

@@ -0,0 +1,121 @@
+Metadata-Version: 2.1
+Name: newportxps
+Version: 0.3.0
+Summary: Python interface to Newport XPS motion controllers
+Author-email: Matthew Newville <newville@cars.uchicago.edu>
+License: BSD License
+Keywords: motion control,data collection
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Other Audience
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: Jython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Topic :: Education
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pysftp
+
+# newportxps
+
+This module provides code for using Newport XPS motor controllers from Python.
+
+While Newport Corp. has provided a basic socket and ftp interface to the XPS
+controller for a long time, this interface is very low-level. In addition,
+there are some incompatibilities between the different generations of XPS
+controllers (generations C, Q, D in that chronological order), and a lack of
+support for Python 3 in the Newport-provided interface.  The `newportxps`
+module here aims to provide a simple, user-friendly interface for the Newport
+XPS that works uniformly for all three generations of XPS and for both Python
+2 and 3.
+
+As an example, connecting to and reading the status of an XPS controller may
+look like this:
+
+```python
+ >>> from newportxps import NewportXPS
+ >>> xps = NewportXPS('164.54.160.000', username='Administrator', password='Please.Let.Me.In')
+ >>> print(xps.status_report())
+ # XPS host:         164.54.160.000 (164.54.160.000)
+ # Firmware:         XPS-D-N13006
+ # Current Time:     Sun Sep 16 13:40:24 2018
+ # Last Reboot:      Wed Sep 12 14:46:44 2018
+ # Trajectory Group: None
+ # Groups and Stages
+ DetectorZ (SingleAxisInUse), Status: Ready state from motion
+    DetectorZ.Pos (ILS@ILS150CC@XPS-DRV11)
+       Hardware Status: First driver powered on - ZM low level
+       Positioner Errors: OK
+ SampleX (SingleAxisInUse), Status: Ready state from motion
+    SampleX.Pos (UTS@UTS150PP@XPS-DRV11)
+       Hardware Status: First driver powered on - ZM high level
+       Positioner Errors: OK
+ SampleY (SingleAxisInUse), Status: Ready state from motion
+    SampleY.Pos (UTS@UTS150PP@XPS-DRV11)
+       Hardware Status: First driver powered on - ZM high level
+       Positioner Errors: OK
+ SampleZ (SingleAxisInUse), Status: Ready state from motion
+   SampleZ.Pos (UTS@UTS150PP@XPS-DRV11)
+       Hardware Status: First driver powered on - ZM low level
+       Positioner Errors: OK
+
+ >>> for gname, info in xps.groups.items():
+ ...     print(gname, info)
+ ...
+ DetectorX {'category': 'SingleAxisInUse', 'positioners': ['Pos']}
+ SampleX {'category': 'SingleAxisInUse', 'positioners': ['Pos']}
+ SampleY {'category': 'SingleAxisInUse', 'positioners': ['Pos']}
+ SampleZ {'category': 'SingleAxisInUse', 'positioners': ['Pos']}
+ >>>
+ >>> for sname, info in xps.stages.items():
+ ...     print(sname, xps.get_stage_position(sname), info)
+ ...
+ DetectorX.Pos 36.5 {'type': 'ILS@ILS150CC@XPS-DRV11', 'max_velo': 100, 'max_accel': 400, 'low_limit': -74, 'high_limit': 74}
+ SampleX.Pos 1.05 {'type': 'UTS@UTS150PP@XPS-DRV11', 'max_velo': 20, 'max_accel': 80, 'low_limit': -74, 'high_limit': 74}
+ SampleY.Pos 0.24 {'type': 'UTS@UTS150PP@XPS-DRV11', 'max_velo': 20, 'max_accel': 80, 'low_limit': -74, 'high_limit': 74}
+ SampleZ.Pos 2.5 {'type': 'UTS@UTS150PP@XPS-DRV11', 'max_velo': 20, 'max_accel': 80, 'low_limit': -74, 'high_limit': 74}
+
+ >>> xps.move_stage('SampleZ.Pos', 1.0)
+
+ >>> xps.home_group('DetectorX')
+
+
+```
+
+On creation and initialization of the NewportXPS, the Groups and status of the
+controller are read in and Stages defined so that they can be queried or
+moved.
+
+
+The `NewportXPS` class has a number of methods to interact with the controller including:
+
+   * reboot controller
+   * get status, hardware errors, etc.
+   * save and upload new `system.ini` and `stages.ini` files.
+   * enable and disable Groups.
+   * initialize and home Stages and Groups of Stages.
+   * read Stage positions.
+   * move Stages and Groups to new positions.
+   * set Stage velocity.
+   * define simple linear trajectories (using PVT mode), both 'forward' and 'backward'.
+   * upload any PVT trajectory.
+   * arm PVT trajectory.
+   * run PVT trajectory.
+   * read and save Gathering file for a trajectory.

{newportxps-0.2 → newportxps-0.3.0}/newportxps.egg-info/SOURCES.txt

@@ -1,4 +1,6 @@
+LICENSE
 README.md
+pyproject.toml
 setup.py
 newportxps/XPS_C8_drivers.py
 newportxps/__init__.py

newportxps-0.3.0/pyproject.toml

@@ -0,0 +1,45 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "newportxps"
+version = "0.3.0"
+authors = [
+    {name="Matthew Newville", email="newville@cars.uchicago.edu"},
+]
+description = "Python interface to Newport XPS motion controllers"
+readme = "README.md"
+requires-python = ">=3.8"
+keywords = ["motion control", "data collection"]
+
+license = {text = "BSD License"}
+dependencies = ['pysftp']
+
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Education",
+    "Intended Audience :: Other Audience",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: BSD License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: Implementation :: Jython",
+    "Programming Language :: Python :: Implementation :: PyPy",
+    "Topic :: Education",
+    "Topic :: Scientific/Engineering",
+    "Topic :: Scientific/Engineering :: Physics",
+    "Topic :: Software Development",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Utilities"
+]
+
+

newportxps-0.3.0/setup.py

@@ -0,0 +1,6 @@
+#!/usr/bin/env python
+
+import setuptools
+
+if __name__ == "__main__":
+    setuptools.setup()

newportxps-0.2/PKG-INFO

@@ -1,10 +0,0 @@
-Metadata-Version: 1.0
-Name: newportxps
-Version: 0.2
-Summary: Python interface to Newport XPS controllers
-Home-page: UNKNOWN
-Author: Matthew Newville
-Author-email: newville@cars.uchicago.edu
-License: BSD
-Description: UNKNOWN
-Platform: UNKNOWN

newportxps-0.2/newportxps/utils.py

@@ -1,22 +0,0 @@
-import sys
-import six
-from six.moves import StringIO as bytesio
-
-# it appears ftp really wants this encoding:
-FTP_ENCODING = 'latin-1'
-
-def bytes2str(s):
-    return str(s)
-
-
-if six.PY3:
-    from io import BytesIO as bytesio
-
-    def bytes2str(s):
-        'byte to string conversion'
-        if isinstance(s, str):
-            return s
-        elif isinstance(s, bytes):
-            return str(s, FTP_ENCODING)
-        else:
-            return str(s)

newportxps-0.2/newportxps.egg-info/PKG-INFO

@@ -1,10 +0,0 @@
-Metadata-Version: 1.0
-Name: newportxps
-Version: 0.2
-Summary: Python interface to Newport XPS controllers
-Home-page: UNKNOWN
-Author: Matthew Newville
-Author-email: newville@cars.uchicago.edu
-License: BSD
-Description: UNKNOWN
-Platform: UNKNOWN

newportxps-0.2/setup.py

@@ -1,13 +0,0 @@
-#!/usr/bin/env python
-
-from setuptools import setup
-
-setup(name = 'newportxps',
-      version = '0.2',
-      author = 'Matthew Newville',
-      author_email = 'newville@cars.uchicago.edu',
-      license = 'BSD',
-      description = 'Python interface to Newport XPS controllers',
-      packages = ['newportxps'],
-      install_requires = ['pysftp']
-      )