XtraWare Version 3.0 for XtraDrive Version 3.04 – 3.23
Cat. No. 8U0109 Rev. G
June 2007
All rights reserved. No part of this publication may be stored in a retrieval system, or reproduced in
any way, including but not limited to photocopy, photography, magnetic or other recording, without
the prior agreement and written permission of the publisher. Program listings may be entered, stored
and executed in a computer system, but not reproduced for publication.
This manual is designed to provide information about the XtraWare software. Every effort has been
made to make this book complete and as accurate as possible. However, no warranty of suitability,
purpose or fitness is made or implied. YET Ltd. is not liable or responsible to any person or entity for
loss or damage in connection with or stemming from the use of XtraWare and/or the information
contained in this publication
YET Ltd. bears no responsibility for errors which may appear in this publication and retains the right
to make changes to the software and manual without prior notice.
12.2.3.Profile Jerk Smoothing Time ................................................................. 251
12.3. Explanation of Command Table ...............................................................251
vi XtraWare User Manual
1. Introduction
The XtraWare software constitutes the user interface and tool of operation
for the XtraDrive. It enables the user to set parameters, tune control loops
and monitor faults. It also facilitates programming of the driver both for
professional programmers and novices.
The topics described in this manual include:
♦ Software installation (including system requirements and setup
instructions)
♦ User menus and toolbars
♦ Operation of the XtraDrive driver using the XtraWare software
(including communication, parameters and program handling)
♦ Command reference which lists alphabetically:
The commands used in the XtraWare software
The commands available in the serial communication protocol
♦ The XtraDrive serial communication protocol
♦ Error messages
♦ Parameter reference providing information on all the parameters
available in the XtraWare software
♦ System Variables
♦ Status Word Bits
♦ Operation Codes
Related documents:
Introduction
Title Catalog Number
XtraDrive (XD-) SERIES AC SERVO
DRIVER User Manual
AC SERVO MOTOR INSTRUCTIONS TOE-C231-2 for ∑-II
XtraDrive (XD-) SERIES AC SERVO
DRIVER Short Form Installation Guide
XtraWare User Manual 1
8U0108
servomotors or other
compatible motors
8U0107
1BSystem Requirements and Software Installation
2. System Requirements and
Software Installation
For optimum performance, XtraWare requires:
♦ Computer: Pentium 166 MHz (Pentium II 350 MHz recommended).
♦ At least 32 MB of RAM (64 MB recommended).
♦ A hard drive with at least 100 MB of free disk space.
♦ Operating System:
Windows
Windows 98
Windows NT4.0 Service Pack 3 or later (IE4.01 Service Pack 2 or
later)
Windows 2000
Windows Me
Windows XP
♦ Super VGA or better graphics display, minimum 256 colors (65536
colors recommended).
♦ When using a computer that does not have a serial port, use either a
USB-to-serial converter or a PC Card expansion interface (PMCIA) with
a serial port. Review vendors’ system requirements for further details,
as not all USB-to-serial converters have exhibited satisfactory
performance. See Appendix E, page E12 of the XtraDrive User Guide for
a description of the cable and pin assignments.
♦ CD-ROM drive (for installation only).
TM
95 OSR2 or later (IE4.01 Service Pack 2 or later).
The XtraWare software is provided on a CD-ROM supplied with the
XtraDrive. To obtain a copy, visit the web site (www.yetmotion.com) and
login to the download section. You may also contact your sales
representative.
Before proceeding with the installation procedure, close any applications
that are open. During the procedure, XtraWare and its related files are
installed on your hard disk. If a previous version of XtraWare is already
installed, the existing program is overwritten. All files created with previous
versions of the software should be backed up.
XtraWare User Manual 3
1BSystem Requirements and Software Installation
¾ To install XtraWare:
1. Insert the CD into the CD-ROM drive.
2. If the procedure does not start automatically, either:
Click Start>Run and type "D:\Install\SETUP" (where D: is your
CD drive), or
Using Windows Explorer, navigate to the CD-ROM drive, and double-
click D:\Install\SETUP.EXE.
The installation screen is displayed, the installation procedure
commences and a message welcoming you to XtraWare is displayed.
3. Click Next to continue.
4. Follow the onscreen instructions to choose a destination folder for the
XtraWare files.
5. Click Next to continue.
6. Select the program group to create the XtraWare icon. C:\Program Files\YET\XtraWare is the default setting.
7. After selecting the program group or folder, click Next to continue.
The PC files are copied from the CD-ROM. During the procedure, the
installation progress is displayed.
Note:
If new versions of the PC support files are needed to install
XtraWare, a window will appear asking whether to overwrite the
current version or to cancel the installation. XtraWare may not run
correctly if the new versions of the support files are not installed.
4 XtraWare User Manual
The Main Screen Interface
3. The Main Screen Interface
This chapter describes the XtraWare main screen. The main screen
comprises a main toolbar, menus and several windows. A sample main
screen is shown in Figure 1 below. For clarity, the screen has been divided
into separate elements.
Figure 1: Sample Main Screen
3.1. Title Bar (A)
The XtraWare title bar displays the name of the currently opened project
file.
3.2. Menu Bar (B)/Toolbar (C)
The XtraWare menu bar provides access to the XtraWare menus: File, Edit,
View, Run, Communication, Tools, Maintenance, Window and Help.
The toolbar is located immediately beneath the menu bar. It comprises
shortcut icons to the most commonly used XtraWare options. In the
following descriptions of the menu options, the appropriate icon (where
applicable) is listed next to each option.
Note:
Some menu options are not available in all modes and will appear as
disabled (grayed) when unavailable. Similarly, disabled icons indicate
that communication is offline.
XtraWare User Manual 5
The Main Screen Interface
3.2.1. File Menu
A project contains all the data currently active in XtraWare, such as the user
program, parameter settings, and definitions. The File Menu options are
used to create new XtraWare projects, open existing projects, and save
changes to projects. Project files, which are handled like any other file, are
automatically assigned an extension of XDR, for example, project1.XDR.
In addition, the File Menu opti ons are used to download, upload and print
programs and parameters.
Table 1: File Menu Options
Option Icon Description
New
Project
(Ctrl+N)
Creates a new XtraWare project. When this
option is selected, the Motor Selection
window in which you select the motor that
will be used for this project, is displayed.
Figure 2: Motor Selection Window
Select the appropriate manufacturer and
then one of the listed modules. If you are
using a model that is not listed, click Add Another Motor.
Enter the name of the model in the Motor
Model field and select the Motor Type
(either Rotary or Linear).
Click Finish to proceed; the Workspace,
Program, History and Parameters windows
are opened with their default contents.
6 XtraWare User Manual
Option Icon Description
The Main Screen Interface
Open
Project
(Ctrl+O)
Save
Project
Opens an existing XtraWare project. When
this option is selected, the Load Project
window is opened:
Figure 3: Load Project Window
Saves the current project under its existing
name. If the project has not yet been
named, the Save Project window is opened:
Save
Saves the current project under a new
Project as
Close
Closes the current project. If the project
Project
XtraWare User Manual 7
Figure 4: Save Project Window
In the File name field, type a name for the
project and click Save.
name. When this option is selected, the
Save Project window is opened.
has not been saved, the following message
is displayed:
Save changes to <project-name>?
Click Save to save the project.
The Main Screen Interface
Option Icon Description
Download
Program
Download
Parameters
Download
1
Cam
Upload
Print
Prints the current program.
Downloads a program to the XtraDrive
driver.
Downloads a set of parameters to the
XtraDrive driver.
Downloads cam profiles to the XtraDrive
driver.
Uploads data from the XtraDrive driver.
Program
Print
Parameters
Prints the parameter list, including their
values, on the printer. The parameters are
printed in tabular format.
Print Chart Prints the currently displayed chart and its
corresponding data. See section
4.7.4,
Printing a Chart, for further information.
Exit Exits from XtraWare.
Note:
1) The ECAM-related options are only activated if an ECAM license
has been purchased.
3.2.2. Edit Menu
The Edit Menu options are used to edit the command order of a program in
the Program window.
Table 2: Edit Menu Options
Option Description
Cut
(Ctrl+X)
Copy
(Ctrl+C)
Paste
(Ctrl+V)
Deletes selected text or lines from the program and
places the selection on the Windows and XtraWare
clipboards.
Places a copy of selected text or lines from the program
on the Windows and XtraWare clipboards.
Inserts the contents of the XtraWare clipboard into the
program.
8 XtraWare User Manual
3.2.3. View Menu
The View Menu options are used to select which windows you want
displayed on the XtraWare screen.
Table 3: View Menu Options
Option Icon Description
Program Displays/hides the Program window.
Parameters Displays/hides the Parameters window.
Cam List Displays/hides the CAM window.
Workspace Displays/hides the Workspace window.
History Displays/hides the History window.
The Main Screen Interface
Chart
Variable
Opens the Charts window. See section
Charts, for a description of this window’s
operation.
Opens the Variables window:
4.7,
Toolbar Displays/hides the toolbar.
Status bar Displays/hides the status bar.
XtraWare User Manual 9
Figure 5: Variables Window
The Main Screen Interface
3.2.4. Run Menu
The Run Menu options enable you to control the program running on the
XtraDrive driver.
Table 4: Run Menu Options
Option Icon Description
Run
Program
Stop
Program
Servo ON
Servo OFF
Immediate
Mode
Program
Mode
Runs the program immediately.
Stops the program immediately.
Switches the XtraDrive driver ON so that the
motor is now under driver control. In this
mode, the driver holds the motor in position
under various load conditions, even when no
motion is required.
Switches the XtraDrive driver OFF so that the
motor is no longer under driver control.
Switches to Immediate mode. In Immediate
mode, commands are downloaded immediately
to the driver’s memory. For details of all the
available modes, see section
Modes.
Switches to Program mode. In Program mode,
a list of commands is prepared in the program
editor to be downloaded to the driver at a later
stage. For details of all the available modes,
see section
4.5, Program Modes.
4.5, Program
Sequential
Mode
Jog
Stop
10 XtraWare User Manual
Switches to Sequential mode. In Sequential
mode, each command is downloaded
individually to the driver and then processed.
For details of all the available modes, see
section
Runs the motor at a constant predefined speed.
Immediately stops the motor motion. You can
also click Stop on the toolbar or press F9.
For further details, see the STOP_EX command
in Chapter
4.5, Program Modes.
5, Command Reference.
3.3. Communication Menu
The Communication Menu options are used to switch the communication
between the XtraWare and the XtraDrive on and off. Options in this menu
are used to customize the communication parameters.
Table 5: Communication Menu Options
Option Description
Online Switches to working in online mode.
Offline Switches to working in offline mode.
Setting Opens the Communication Settings window. See
section
this option.
3.3.1. Tool Menu
The Tool Menu options allow you to access the Electronic Cam interface, to
automatically tune the control loops, and to perform a mechanical analysis
of the motor-load system.
4.1.1, Communication Settings, for details on
The Main Screen Interface
Table 6: Tool Menu Options
Option Icon Description
Electronic
1
Cam
Autotuning
Mechanical
Analysis
Creates motion according to a specified profile
that is dependent on the position of a master
axis or on the elapsed time.
Automatically sets control loop gains based on
actual system measurements and tunes the
XtraDrive driver accordingly. See section
Tuning the Control Loops, for full details.
The mechanical analysis (FFT) option samples
and analyzes 2000 speed data points. The
speed is a response to sinusoidal torque
frequency commands. The response is
displayed as a graph of the gain (dB) and
phase angle (degree) versus frequency (Hz in
log scale). According to the graph, the relevant
parameters can then be adjusted in order to
reduce the effect of the mechanical restrictions.
See section
details.
4.6,
4.8, Mechanical Analysis, for full
XtraWare User Manual 11
The Main Screen Interface
Note:
1) The ECAM related options are only activated if an
ECAM license has been purchased.
3.3.2. Maintenance Menu
The Maintenance Menu options allow you to tune the control loops
automatically or manually, to open and close a log file, and to send a
command to the XtraWare device.
Table 7: Maintenance Menu Options
Option Icon Description
Reset
Driver
Reset to
Default
Parameters
Open Log
File
Cycles the main circuit and control power
supply. This is necessary after certain
parameters are edited, to enable the new
settings. The Need Reset indicator appears in
the status line when this action is necessary.
Discards user modifications to the parameters
and reverts to the factory default parameters.
Note that some parameters are updated at
power-up only and you must therefore restart
the XtraDrive after using this option.
Starts a new log file and inserts all the
commands sent via communication into the
log file. The log file is used mainly for
debugging purposes.
When this option is selected, the Open Log
File dialog box is displayed:
12 XtraWare User Manual
Figure 6: Open Log File Dialog Box
Select a directory and select the name of an
existing file, or type in a name to create a
new log file. When XtraWare is in Online
Option Icon Description
mode, all the commands sent via
communication to the XtraDrive are stored in
the selected log file.
To close the log file, select the Close Log File
option.
The Main Screen Interface
Close Log
Stops storing commands in the log file and
File
Password Enables an authorized user to enter a
Send
For internal use only.
Command
3.3.3. Window Menu
The Window menu is used to switch between different views in the
XtraWare system, and to save a customized screen for future use.
Table 8: Window Menu Options
Option Description
Project
Screen
Displays the default XtraWare Main Screen interface,
which includes the Workspace, Program, History, Cam
and Parameters windows.
closes the log file that is currently open.
password to be permitted to modify certain
parameters (displayed in red in the
Parameters window) which can only be
modified by authorized users.
Program
Edit
Screen
User
Screen
Save
User
Screen
Enlarges the Program window to facilitate program
editing. The History, Cam and Parameters windows are
hidden.
Displays the current user customized screen saved under
the Save User Screen option.
The size and location of the Workspace, Program,
History, Cam and Parameters windows can be
customized to facilitate your work session. This option
enables you to save your customized screen for future
work sessions. Each time you save a new customized
screen, the previous user screen is overwritten.
XtraWare User Manual 13
The Main Screen Interface
3.4. Status Bar (D)
The Status Bar, located at the bottom of the XtraWare screen, indicates the
status of the current driver and of the Servo.
Figure 7: Status Bar
The indicators on the right of the status bar are as follows:
♦A: Indicates whether or not a program is running on the controller (Run
or Stop).
♦B: Need Reset indicator. After certain parameters are edited, the main
circuit and control power supply must be cycled in order to enable the
new settings. When this indicator appears, click Reset.
♦C: Indicates the status of the connection to the XtraDrive driver (Offline
or Online).
♦ D: Indicates the current status of the XtraDrive driver (ON or OFF).
3.5. Work Area (E)
The Work Area comprises the following windows:
♦ Workspace window
♦ Project tab
♦ Program window
♦ History window
♦ Parameters window
♦ Cam window
3.5.1. Workspace Window
The Workspace window includes:
♦ Project Tab: The subsections of the current project.
♦ Command Tab: A list of the XtraWare commands divided into six
groups.
♦ Description Pane: A description of the currently selected item.
3.5.2. Project Tab
The Project tab (Figure 8) presents the subsections (Program, Parameters
and Cam) of the current project.
14 XtraWare User Manual
To view the project subsections, click the + sign next to the project name in
the Workspace window.
Figure 8: Workspace Window – Project Tab
3.5.2.1. Command Tab
The Command tab (Figure 9) lists the commands that can be used to write
the program. The commands are divided into groups. A full description of
each command is provided in Chapter
To view the commands under a command group, click the + sign next to
the group name in the Command tab.
The Main Screen Interface
5, Command Reference.
Figure 9: Workspace Window – Command Tab
XtraWare User Manual 15
The Main Screen Interface
The icon next to each command indicates its current status. The availability
or unavailability of a command depends on the current working mode. Table
9 below lists the three command tab icons.
Table 9: Command Tab Icons
Icon Description
Available command. This command can be used in the
current working mode.
Currently selected command. When a command is selected
its description is displayed in the Description area under the
command list.
Command is not available in the currently selected mode.
¾ To select a command:
1. Double-click on the command name. The appropriate command dialog
box is displayed.
See section
4.4.1, Writing a Program, for details on how to insert
commands into the program.
2. Click on a command name to see a short description of the command in
the Description pane, or see Chapter
detailed description.
3.5.2.2. Command Groups
The Command Groups are listed in the table below.
5, Command Reference, for a more
Table 10: Command Groups
Group Description
ECAM Controls the motor
motion according to a
profile that is
Included Commands
(examples)
ECAM_ENGAGE;
ECAM_DISENGAGE;
ECAM_VIRTUAL_AXIS
dependent on the
position of a master
axis or on time
elapsed.
Encoder
Latching
Controls the latching
and registration
LATCHING_TRIGGER,
REGISTRATION_DISTANCE
process.
Home Moves the motor to
search for the
(system) home
HARD_HOME, HOME_C,
HOME_SW, HOME_SW_C,
SET_ZERO_POSITION
position.
16 XtraWare User Manual
The Main Screen Interface
Group Description
Interrupt Specifies the interrupt
Included Commands
(examples)
EXT_INT, INT, INT_RETURN
routines to be run for
various interrupt
events.
Motion Controls motor
motion.
GO, GO_D, GO_H, MOVE,
MOVE_D, MOVE_H, MOVE_R,
SLIDE, SLIDE_ANALOG,
SPEED_CONTROL, START,
STOP_EX, TORQUE,
TORQUE_ANALOG
Motion
Profile
Changes the default
values of speed,
ACCELERATION, JERK_TIME,
SPEED
acceleration and jerk
time.
Output Sets output ON/OFF. FAST_OUTPUT_SETTING,
SET_OUTPUT, SET_OUTPUTS;
Program
Flow
Control
Program flow handling
commands.
CALL, END, GO_TO, IF,
IF_INPUT, INPUT_CASE, LABEL,
LOOP, RETURN, RUN
System Enables and disables
SERVO control in the
program. Sets gain
and torque limits.
Variables Sets variable values in
the program.
Wait Delays program flow,
either for a specified
time or until a
condition is met.
3.5.3. Program Window
The Program Window (Figure 10) displays the entire program. The program
is written by selecting commands from the Command tab, and entering
values for the commands’ parameters. See section
Program, for details on how to write a program.
CONTROL, GAIN,
TORQUE_LIMITS,
ELECTRONIC_GEAR
MATH, READ_FROM_ARRAY,
SET_VAR, WRITE_TO_ARRAY
DELAY, WAIT_EXACT,
WAIT_FOR_START,
WAIT_INPUT, WAIT_STOP,
WAIT_VAR
4.4.1, Writing a
XtraWare User Manual 17
The Main Screen Interface
¾ To change the value of a command’s argument after it has
been added to the program:
1. Double-click on the command line to open its window, and enter a new
value or values.
Figure 10: Program Window
3.5.4. History Window
The History window presents a list of all the commands that have been
downloaded or sent (in Immediate mode) to the XtraDrive driver.
For each command, the following information is displayed:
Table 11: History Window Columns
Name Description
ID A sequential number assigned to the command.
Command The name of the command that was executed.
Operation
Mode
The operation mode (Program, Immediate,
Sequential) active when the command was issued.
3.5.5. Parameters Window
Each project in the XtraWare system comprises a program and parameters.
The XtraWare parameters are divided into different parameter groups, and
are displayed in the Parameters window (Figure 11).
For instructions on how to set parameters, see section
Parameters Online, and section
4.3.4, Setting Parameters Offline.
4.3.3, Setting
A full list of all the parameters available in the XtraDrive system and their
values is provided in Chapter
18 XtraWare User Manual
8, Parameter Reference.
The Main Screen Interface
The Parameters window is divided into three panes as shown below:
Figure 11: Parameters Window
♦ Group pane (A) lists the parameter groups. The parameters in the
selected group are displayed in the Parameters pane.
♦ The Parameters pane (B) displays the details of each parameter.
Initially, the values displayed for the parameters are the default values.
♦ The Description pane (C) displays a short description of the selected
parameter.
3.5.6. Cam Window
The Cam window lists all ECAM profiles that have been defined.
Figure 12: Cam Window
♦Download size: Indicates the number of data points that will be
downloaded to the XtraDrive when the Download Cam button is
pressed.
♦ Profile#: The profiles are identified in the Cam List by their numbers.
♦ Download: Check the checkboxes corresponding to all profiles that
should be downloaded to the XtraDrive when the Download Cam button
is pressed.
♦Size: The number of data points in each profile
XtraWare User Manual 19
The Main Screen Interface
¾ To view or edit a profile:
1. Double-click anywhere in the row corresponding to the profile number
that you would like to view or edit.
The Electronic Cam window is opened, with the Position Setting tab
displaying the selected profile. See section
Note:
The ECAM related options are only activated if an ECAM license has
been purchased. Contact YET to purchase an ECAM license.
4.9, ECAM (Electronic Cam).
20 XtraWare User Manual
Loading...
+ 233 hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.