Newport XPS-D User manual

XPS-D
Universal High-
Performance Motion
Controller/Driver
User Interface
Manual

XPS-D Controller User Interface Manual
©2018by Newport Corporation, Irvine, CA. All rights reserved.
Original instructions.
No part of this document may be reproduced or copied without the prior written
approval of Newport Corporation. This document is provided for information only, and
product specifications are subject to change without notice. Any change will be
reflected in future publishings.
EDH0405En1012 – 09/18ii

XPS-D Controller User Interface Manual
Table of Contents
1.0 Introduction .................................................................................................. 1
1.1 Scope of the Manual ...................................................................................................1
1.2 Prerequisite .................................................................................................................1
1.3 System Environment...................................................................................................1
2.0 User Interface description............................................................................ 2
2.1 Interface Overview......................................................................................................2
2.2 Restart and Reboot......................................................................................................3
2.3 Controller – Users Management .................................................................................3
2.4 Controller – IP Management.......................................................................................4
2.5 Controller – General Information................................................................................5
2.6 Controller – Terminal Configurator............................................................................5
2.7 Controller – TCL to API Builder ................................................................................6
2.8 Controller – Firmware Update ....................................................................................8
2.9 System – Error file Display.........................................................................................9
2.10 System – Previous Error File Display.......................................................................10
2.11 System – Default Configuration................................................................................10
2.12 System – Quick Configuration..................................................................................11
2.13 System – Manual Configuration ...............................................................................11
2.14 Stage – Add, Remove or Edit Stages ........................................................................12
2.15 Stages – Create Custom Stages.................................................................................12
2.16 Stages – Tuning.........................................................................................................13
2.16.1 Tuning – Auto-Scaling.............................................................................13
2.16.2 Tuning – Auto-Tuning .............................................................................14
2.17 Front Panel – Move...................................................................................................17
2.18 Front Panel – Cycle...................................................................................................18
2.19 Front Panel – Jog ......................................................................................................18
2.20 Front Panel – Spindle................................................................................................19
2.21 Front Panel – I/O Control..........................................................................................20
2.22 Front Panel – Device Status ......................................................................................20
2.22.1 Device Status – Positioner Errors.............................................................20
2.22.2 Device Status – Hardware Status .............................................................21
2.22.3 Device Status – Driver Status...................................................................21
2.23 Terminal .................................................................................................................22
2.24 Data Acquisition – Easy Gathering...........................................................................24
2.25 Data Acquisition – Easy External Gathering ............................................................30
2.26 Data Acquisition – Functional Tests.........................................................................34
2.27 Files – Gathering Files ..............................................................................................35
iii EDH0405En1012 – 09/18

XPS-D Controller User Interface Manual
2.28 Files – Trajectory Files .............................................................................................36
2.29 Files – TCL Scripts ...................................................................................................37
2.30 Files – Configuration Files........................................................................................38
2.31 Files – Log Files........................................................................................................39
2.32 Documentation..........................................................................................................40
Service Form ........................................................................................................ 41
EDH0405En1012 – 09/18iv

XPS-D Controller User Interface Manual
1.0 Introduction
1.1 Scope of the Manual
The XPS is an extremely high-performance, easy to use, integrated motion
controller/driver offering high-speed communication through 10/100/1000 Base-T
Ethernet, outstanding trajectory accuracy and powerful programming functionality. It
combines user-friendly web interfaces with advanced trajectory and synchronization
features to precisely control from the most basic to the most complex motion sequences.
Multiple digital and analog I/O's, triggers and supplemental encoder inputs provide
users with additional data acquisition, synchronization and control features that can
improve the most demanding motion applications.
To maximize the value of the XPS Controller/Driver system, it is important that users
become thoroughly familiar with available documentation.
The present XPS-D User Interface Manual describes the Graphical User Interface
(also called web interface) of the controller.
1.2 Prerequisite
It is mandatory that XPS-D Start-Up Manual be thoroughly read and understood
before going through the User Interface.
Particularly, Ethernet connection must be established between the computer and the
controller, either directly or through a network.
1.3 System Environment
XPS-D web interface is compatible with Windows 7 and above.
Universal High
-Performance
Motion Controller/Driver
XPS
-D Controller
1 EDH0405En1012 – 09/18

XPS-D Controller User Interface Manual
2.0 User Interface description
2.1 Interface Overview
The XPS software tools provide users a convenient access to the most common features
and functions of the XPS controller. All software tools are implemented as a web
interface. The advantage of a web interface is that it is independent from the user's
operating system and doesn't require any specific software on the host PC.
When connected to the controller, a log-in menu pops up. There are two options to log-
in to the XPS controller: as “User” or as “Administrator”. Users can log-in only with
User rights. Administrators can log-in with User or with Administrator rights by
selecting the respective Role in the login page. When logged-in with Administrator
rights, you have an extended set of tools available.
The predefined user has the log-in name Anonymous, Password Anonymous. The
predefined Administrator has the log-in name Administrator, Password
Administrator. Both the log-in name and the password are case sensitive. Select
"Remember me" to save the login credentials.
Once logged, the main tab is displayed across the top of the XPS Motion
Controller/Driver main program window, and lists each primary interface option. Each
interface option has its own pull-down menu that allows the user to select various
options by clicking the mouse's left button.
Administrator Menus (with Administrator Rights)
Sub-Menu for CONTROLLER (with Administrator Rights)
EDH0405En1012 – 09/182

XPS-D Controller User Interface Manual
Restricted set of User Menus
On the following pages, a brief description of each available tool is provided.
2.2 Restart and Reboot
After making changes to the hardware or software parameters a Restart or a Reboot of
the controller will be a necessary to apply the changes. Restart is a quicker process than
a Reboot.
•Restart = reload all configuration files.
•Reboot = reload files + re-initialize hardware.
2.3 Controller – Users Management
This tool allows managing User accounts. There are two types of users: Administrators
and Users. Administrators have configurations rights. Users have restricted rights to use
the system.
The following steps are needed to create a new user:
1. Click on "New Account" and the following window appears:
2. Type in a Login name, password, and role (User or Administrator).
3. Click “OK” to add the new access account.
3 EDH0405En1012 – 09/18

XPS-D Controller User Interface Manual
2.4 Controller – IP Management
To access this Web Tool, users must be logged in with Administrator rights. This screen
allows HOST Ethernet plug IP address management and setting (see Start-Up Manual
for further details).
EDH0405En1012 – 09/184

XPS-D Controller User Interface Manual
2.5 Controller – General Information
This screen provides valuable information about the firmware and the hardware of the
controller. It is an important screen for troubleshooting the controller. This screen also
displays information about the IP configuration as well as TCL scripts which are
currently running.
2.6 Controller – Terminal Configurator
Under Controller →Terminal configurator, an Administrator user can specify which
API functions will be displayed to all users in the Terminal webpage. Not all API
functions may be useful to a given application especially after the application has been
developed. For this purpose simplifying the Terminal display may be helpful.
1. Click a line to select/deselect the API function.
2. Once all desired API functions are selected, click RESTART CONTROLLER.
In the following example a total of 7 API functions were selected.
5 EDH0405En1012 – 09/18

XPS-D Controller User Interface Manual
2.7 Controller – TCL to API Builder
Under Controller →TCL to API builder, users can write custom API functions from a
TCL script then add the custom API to the terminal and launch the custom API.
Example
For this example, there must be a TCL file “ExcitationSignalSet.tcl” uploaded to the
XPS controller.
Go to the XPS Controller →TCL To API builder webpage:
1. Load the existing TCL script named ExcitationSignalSet.tcl by clicking on the folder
icon in the text editor.
2. In the Parameters list enter the arguments “char PositionerName[250], int Mode,
double Frequency, double Amplitude, double Time”.
3. Enter a description in the API description: “Set excitation signal mode from TCL”.
EDH0405En1012 – 09/186

XPS-D Controller User Interface Manual
4. Save the custom API by clicking in the floppy disk icon in the text editor.
5. In the TCL function list, “int ExcitationSignalSet(char PositionerName[250], int
Mode, double Frequency, double Amplitude, double Time) // Set excitation signal
mode from TCL” is added.
6. Click “RESTART APPLICATION” to take in account the changes.
7. Connect to the website, go to the “Terminal” page and search for the new API,
“ExcitationSignalSet,” in the Function list.
8. Select new API and enter the parameters as usual.
7 EDH0405En1012 – 09/18

XPS-D Controller User Interface Manual
2.8 Controller – Firmware Update
Users can regularly update the controller with new firmware releases. Updating the
firmware does overwrite the stages.ini or system.ini files if changes are required. The
configuration will also be reset when upgrading the firmware hence the Configuration
should be backed up prior to the firmware upgrade. Refer to the FirmwareHistory
document which explains changes to the stages.ini and system.ini files, if any.
Refer to the XPS webpage at www.newport.com for more information including the
FirmwareHistory document, the StageDataBase.txt file and the new firmware installer
pack.
Updating the XPS Firmware
1. Download the firmware installer pack from the XPS webpage at www.newport.com.
2. Connect to the XPS controller. For more information see Start-Up Manual.
3. Login on to the XPS with Administrator rights.
4. Go to Controller →Firmware update.
5. Click on UPLOAD FIRMWARE and select the installer pack file saved on the PC.
6. Click INSTALL and the following Confirmation window appears:
7. Select “Yes, I confirm that I want to install this upgrade.” Resetting the controller IP
address or user accounts is optional.
8. Click INSTALL NOW.
EDH0405En1012 – 09/188

XPS-D Controller User Interface Manual
NOTE
This will reboot the controller and reset the controller configuration.
NOTE
Controller configuration files including stages.ini and system.ini files can be
downloaded under Files→Configuration files prior to updating the controller
firmware. See chapter 2.30: “Files – Configuration Files” for more information.
2.9 System – Error file Display
The Error File Display is another important screen for troubleshooting the XPS
controller. When the XPS encounters any error during booting, for instance due to an
error in the configuration files or because the configuration is not compatible with the
connected hardware, there are entries in the error log file that guides you to correct the
error. If several consecutive boot sequences contain errors, they are all reported.
When no error is detected during the last system boot, this file becomes blank.
9 EDH0405En1012 – 09/18

XPS-D Controller User Interface Manual
2.10 System – Previous Error File Display
The Previous error file display shows all errors encountered during the previous series
of consecutive faulty XPS boots once the last is OK. After the following boot (OK or
not), this file becomes blank.
2.11 System – Default Configuration
With the help of this screen, a fast, basic configuration of the XPS controller can be
done. For further information, refer to Configuration Manual.
EDH0405En1012 – 09/1810

XPS-D Controller User Interface Manual
2.12 System – Quick Configuration
The Quick configuration is very similar to the Default configuration as it also lists all
detected hardware including Newport ESP compatible stages and motor drivers under
the respectively columns Stage Model and Driver model. The Quick configuration
differs in the source for stage configuration.
As a result, this screen also provides valuable information for diagnosing or
troubleshooting the system.
For further information, refer to Configuration Manual.
2.13 System – Manual Configuration
Manual Configuration allows you to review the current system configuration or to
define a new one. See Configuration Manual for further information.
11 EDH0405En1012 – 09/18

XPS-D Controller User Interface Manual
2.14 Stage – Add, Remove or Edit Stages
With the help of this screen, a stage from the Newport stage data base can be added to
or removed from the personal stage data base, called stages.ini, as well as modified. On
the left side of the screen, you can review the name of the stages that are already in
stages.ini file. See Configuration Manual for details.
2.15 Stages – Create Custom Stages
This web page is used to build stage configuration files for stages not found in the
controller's StageDataBase.txt such as non-Newport stages.
The integrated web tool, Stages →Create custom stages, is accessible when logged in
as administrator. This web tool is designed to help users configure the XPS controller
for motors and stages that are not included in the XPS general stage data base such as
stages not manufactured by Newport. The tool generates a new entry in the customer’s
stage database, stages.ini, which is stored on the controller and is accessible through the
webpage Files →Configuration files.
Refer to Configuration Manual for more information.
EDH0405En1012 – 09/1812

XPS-D Controller User Interface Manual
2.16 Stages – Tuning
2.16.1 Tuning – Auto-Scaling
Auto-scaling is only available with positioners that feature a direct drive motor such as
the XM, ILS-LM, IMS-LM or RGV100BL. To guarantee consistent performance of
these stages, it is strongly recommended to perform Auto-scaling once the load is
attached to the stage. During auto-scaling, the XPS controller measures the mass (inertia
for rotation stages) on the positioner and returns recommended values for the Scaling
Acceleration parameter.
Repeat Auto-scaling with any major change of the payload on the positioner. With no
major change of the payload, there is no need to redo Auto-scaling.
To perform Auto-scaling, do the following:
1. Select the main tab TUNING. Then select a positioner name. The following screen
appears:
2. Click “Kill” if not in “Not initialized state”, then click “Auto-scaling”. The stage
vibrates and an auto-scaling progress bar appears.
13 EDH0405En1012 – 09/18

XPS-D Controller User Interface Manual
3. When the auto-scaling routine is complete, the results are displayed. To save the
recommended values and reboot the controller, click “Save”. The positioner should
now work properly.
NOTE
All other functions of the tuning page should be used only by experienced users.
2.16.2 Tuning – Auto-Tuning
NOTE
Apart from the Auto-scaling feature, which is described in the previous chapter,
only experienced motion control users should use the TUNING tool of the XPS
controller.
All Newport positioners are supplied with default tuning parameters that provide
consistently high performance for the vast majority of applications. Use the
Tuning tool with Newport positioners only when not fully satisfied with the
dynamic behavior of the positioners. Auto-Tuning works best with direct drive
stages. Friction drive or ballscrew drive systems may not result in optimum tuning
using this feature.
The following is a brief description of the TUNING tool:
1. Select a positioner name. The following screen appears:
EDH0405En1012 – 09/1814

XPS-D Controller User Interface Manual
2. Using this screen, perform a data gathering with your current parameter settings:
1. Initialize and home the positioner, then move to the desired start position (set the
position in the “Absolute move” field on top righte and then click “Go”).
2. Under “Acquisition parameters”, define the gathering data: For the stage tuning,
it is recommended to gather only the following error and the current position.
3. Define the frequency divisor. The frequency divisor defines the sampling rate of
the gathering. A frequency divisor equal to one means one data point is gathered
every servo cycle. With most positioners, it is sufficient to set a value of 10.
4. Define the number of points in relation to the distance, the frequency divisor, the
velocity and the acceleration.
5. Define the velocity, acceleration and jerk time.
6. Define a typical motion distance.
7. When done, click “MOVE”. The following page appears:
15 EDH0405En1012 – 09/18

XPS-D Controller User Interface Manual
3. If satisfied with the results, there is no need to tune the stage. If not satisfied, return to
the tuning page by clicking “Close” and move back to the start position.
4. Next to the Auto-tuning button, there is a Mode field for Auto-tuning. Select “Short
settling” or “High robustness”. Choose “Short settling” to improve the settling time
after a motion or to reduce the following error during the motion. Short settling will
define “high” PID vales for your stage, but there is a risk of oscillation. Choose
“High robustness” to improve the robustness of the motion system and to avoid
oscillations during or after a motion. “High robustness”, for instance, can avoid
oscillations for a rotation stage with high payload inertia.
When done with the selection, click Auto-tuning.
5. The stage vibrates for a couple of seconds. When done the following screen appears:
6. Press “OK” in the pop-up window, the proposed modifications are colored in red.
You must click “Set” to apply the new parameters. “Set” only changes the working
parameters without saving them. Recover the previous parameters by rebooting the
system.
7. To test the behavior of the motion system with the new parameters, repeat the same
data gathering and compare the results. Make manual changes to the settings if
necessary and verify the behavior.
8. To permanently save the settings to the stages.ini, press “SAVE TO FILE”. “SAVE
TO FILE” overwrites the current settings in your stages.ini. Press “SAVE TO FILE”
only when fully satisfied with the results. For recovery, Newport recommends
making a copy of the stages.ini with the old settings.
NOTE
For further information about the meaning of the different tuning parameters, see
Features Manual.
EDH0405En1012 – 09/1816