Page 1
XPS-D Universal High-Performance Motion Controller/Driver User Interface Manual...
Page 2
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.
The present XPS-D User Interface Manual describes the Graphical User Interface (also called web interface) of the controller. 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.
XPS-D Controller User Interface Manual User Interface description 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.
XPS-D Controller User Interface Manual Restricted set of User Menus On the following pages, a brief description of each available tool is provided. 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.
XPS-D Controller User Interface Manual 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/18...
XPS-D Controller User Interface Manual 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.
XPS-D Controller User Interface Manual 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.
Page 11
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”...
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.
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.
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.
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.
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.
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.
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.
Page 19
XPS-D Controller User Interface Manual 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”).
Page 20
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.
XPS-D Controller User Interface Manual 2.17 Front Panel – Move The Move page provides access to basic group functions like initialize, home, or motor disable, and executes relative and absolute moves where speed, acceleration and jerk time can be modified during motion (but not during the acceleration period).
XPS-D Controller User Interface Manual 2.18 Front Panel – Cycle The cycle page allows cycling of a stage. A cycle motion moves back and forth between two defined positions where speed, acceleration and jerk time can be modified during motion (but not during the acceleration period).
XPS-D Controller User Interface Manual 2.20 Front Panel – Spindle The Spindle page provides similar functions to the Jog page. However, specific jog actions are replaced by spindle actions that only work for Spindle groups. NOTE Spindle configuration does not allow indexing of the rotary stage. For a rotary...
XPS-D Controller User Interface Manual 2.21 Front Panel – I/O Control The I/O Control page shows the current states or values of all analog and all digital I/O’s of the controller and allows the user to set all the analog and digital outputs of the controller.
XPS-D Controller User Interface Manual 2.22.2 Device Status – Hardware Status The Hardware Status section is another important page for trouble-shooting, but not all information is related to an error. 2.22.3 Device Status – Driver Status The Driver Status section is another important page for trouble-shooting, but not all information is related to an error.
XPS-D Controller User Interface Manual 2.23 Terminal The Terminal screen allows the execution of all XPS controller functions. It also provides a convenient method for generating executable TCL scripts. For more details about TCL scripts, see Features Manual. To execute a function from the Terminal, do the following: 1.
Page 27
XPS-D Controller User Interface Manual Step 3: To add another parameter, click “ADD BLOCK”. Repeat Step 1 and Step 2. When all arguments are defined, click “OK”. Now review the final syntax of the function and make final text changes, as needed. When done, click “Execute”.
XPS-D Controller User Interface Manual The functions are listed in alphabetical order and can be searched for using the search bar at the top of the Function list. Functions listed are those available for display through the Controller → Terminal configurator or functions available for the current system configuration.
Page 29
XPS-D Controller User Interface Manual Step 1: Configuration name 1. Enter a name for the Gathering Configuration. Example: Stage_Position. Step2: When to start This step configures the data collection trigger and is based upon the API function EventExtendedConfigurationTriggerSet([Actor].[Category].Event Name, Parameter1, Parameter2, Parameter3, Parameter4).
Page 30
XPS-D Controller User Interface Manual Example: Group1.Pos 3. From the list, highlight the event that starts the data gathering and then click ADD. Depending on the event selection, Parameters 1 through Parameter 4 need to be filled in. Example: SGamma.ConstantVelocityState 4.
Page 31
XPS-D Controller User Interface Manual Step 3: What to collect This step configures the data type to be collected and is based upon the API function GatheringConfigurationSet([DataType]). Refer to Features Manual for more information. If this section is not empty, delete example data collection type by clicking REMOVE.
Page 32
XPS-D Controller User Interface Manual Step 4: How much to collect This step specifies the sampling frequency and sampling duration for the gathering configuration and is based upon the API function EventExtendedConfigurationActionSet(GatheringRun, Nb of points, Divisor, 0, 0). Refer to Features Manual for more information.
Page 33
XPS-D Controller User Interface Manual Step 6: Start Gathering 1. To begin gathering data, click on START. 2. The controller then begins to monitor for the configured trigger. 3. Once the trigger event occurs, the data acquisition begins and a status bar appears.
XPS-D Controller User Interface Manual 2.25 Data Acquisition – Easy External Gathering Under Data acquisition → Easy external gathering, users can define and save data gathering configurations for routine data acquisition operations triggered by an external device. For more in depth information regarding data gathering types, refer to Features Manual.
Page 35
XPS-D Controller User Interface Manual Step 1: Configuration name 1. Enter a name for the Gathering Configuration. Example: Stage_Position. Step 2: When to start This step configures the data collection trigger and is based upon the API function EventExtendedConfigurationTriggerSet([Actor].[Category].Event Name, Parameter1, Parameter2, Parameter3, Parameter4).
Page 36
XPS-D Controller User Interface Manual 3. From the list, highlight the data type ExternalLatchPosition, and then click ADD. Example: ExternalLatchPosition 4. Click OK when the data type has been specified. 5. Repeat Step 3 Add Data to add other data types to be collected under this specific Gathering Configuration.
Page 37
XPS-D Controller User Interface Manual Step 5: Save Configuration 1. Click on SAVE CONFIGURATION to save the gathering configuration. Example: Step 6: Start Gathering 1. To begin gathering data, click on START. 2. The controller then immediately begins to monitor for the configured external trigger.
XPS-D Controller User Interface Manual 2.26 Data Acquisition – Functional Tests The FUNCTIONAL TESTS page allows running TCL scripts saved in the “/Admin/Public/Scripts/ FunctionalTests” folder of the XPS controller. Supplied in the firmware, the Functional Tests scripts will then display the results of a gathering file.
XPS-D Controller User Interface Manual 2.27 Files – Gathering Files In this webpage gathering files stored on the XPS controller can be downloaded, viewed, edited or deleted. To generate gathering files refer to Features Manual. Download/Edit/View/Delete Click on the gathering file name to open the file in the text editor and a window will appear with a graphical representation of the data.
XPS-D Controller User Interface Manual 2.28 Files – Trajectory Files In this webpage trajectory files stored on the XPS controller can be downloaded, uploaded, viewed, edited, created or deleted. Download/Edit/View/Delete Click on the trajectory file name to open the file in the text editor. In the text editor the user can edit, save, save as, view, download or delete the trajectory file.
XPS-D Controller User Interface Manual 2.29 Files – TCL Scripts In this webpage TCL script files stored on the XPS controller can be downloaded, viewed, edited or deleted. TCL scripts could also be uploaded through this webpage. Download/Edit/View/Delete Click on the TCL script file name to open the file in the text editor. In the text editor the user can edit, save, save as, view, download or delete the TCL script.
XPS-D Controller User Interface Manual 2.30 Files – Configuration Files In this webpage Configuration files stored on the XPS controller can be downloaded, uploaded, viewed, edited or deleted. Note: Users must be logged in with Administrator rights in order to access this webpage.
XPS-D Controller User Interface Manual 2.31 Files – Log Files In this webpage log files stored on the XPS controller can be downloaded, uploaded, viewed, edited or deleted. Note: Users must be logged in with Administrator rights in order to access this webpage.
XPS-D Controller User Interface Manual 2.32 Documentation Under the webpage Documentation users can open and download XPS-D manuals, help files, drivers and example code. EDH0405En1012 – 09/18...
XPS-D Controller User Interface Manual Service Form Your Local Representative Tel.: __________________ Fax: ___________________ Name: _________________________________________________ Return authorization #: ____________________________________ (Please obtain prior to return of item) Company:_______________________________________________ Address: ________________________________________________ Date: __________________________________________________ Country: ________________________________________________ Phone Number: __________________________________________ P.O. Number: ____________________________________________...
Page 46
Visit Newport Online at: www.newport.com North America & Asia Europe Newport Corporation MICRO-CONTROLE Spectra-Physics S.A.S 1791 Deere Ave. 9, rue du Bois Sauvage Irvine, CA 92606, USA 91055 Évry CEDEX France Sales Tel.: (800) 222-6440 Sales e-mail: sales@newport.com Tel.: +33 (0)1.60.91.68.68 Technical Support e-mail: france@newport.com...