Skip to main content

Python interface to Newport XPS motion controllers

Project description

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:

 >>> 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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

newportxps-0.9.tar.gz (36.0 kB view details)

Uploaded Source

Built Distribution

newportxps-0.9-py3-none-any.whl (29.3 kB view details)

Uploaded Python 3

File details

Details for the file newportxps-0.9.tar.gz.

File metadata

  • Download URL: newportxps-0.9.tar.gz
  • Upload date:
  • Size: 36.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for newportxps-0.9.tar.gz
Algorithm Hash digest
SHA256 04dcc74728e0eade3e72f972652d95a4bf419321060ce58efc9ebeb0942411b1
MD5 3a5a99878a96db3b7d58bca3cda0c5ec
BLAKE2b-256 93646e7e4513f1da1b4d47078a85adfa537655ebf90a0c26630beac4da3f2361

See more details on using hashes here.

File details

Details for the file newportxps-0.9-py3-none-any.whl.

File metadata

  • Download URL: newportxps-0.9-py3-none-any.whl
  • Upload date:
  • Size: 29.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for newportxps-0.9-py3-none-any.whl
Algorithm Hash digest
SHA256 7cd1f879d0aba956a088e95fbd4f23c5d096e4ef42c2f1329e76a08a07c23537
MD5 68590c822a7fc2a1c9f681fbd273a8e5
BLAKE2b-256 4923023e2d3e6ea838ef058d3e51dd53c1acb76f77f4028f4d66640b65d70bf1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page