YTerm Software Manual
YTerm Software Manual
WARNING
YASKAWA manufactures component parts that can be used in a wide variety of industrial
applications. The selection and application of YASKAWA products remain the responsibility
of the equipment designer or end user. YASKAWA accepts no responsibility for the way its
products may be incorporated into the final system design.
Under no circumstances should any YASKAWA product be incorporated into any product or
design as the exclusive or sole safety control. Without exception, all controls should be
designed to detect faults dynamically under all circumstances. All products designed to
incorporate a component part manufactured by YASKAWA must be supplied to the end user
with appropriate warnings and instructions as to that part’s safe use and operation. Any
warnings provided by Yaskawa must be promptly provided to the end user.
YASKAWA offers an express warranty only as to the quality of its products in conforming to
standards and specifications published in YASKAWA’S manual. NO OTHER WARRANTY,
EXPRESS OR IMPLIED, IS OFFERED. YASKAWA assumes no liability for any personal
injury, property damage, losses or claims arising from misapplication of its products.
YTerm Software Manual
YTerm Software Manual
CONTENTS
Overview ........................................................................1
Introduction to Y Term .............................................1
Features of Y Term ..................................................1
Getting Started ...............................................................2
Installing Y Term ......................................................2
Software Kit Contents ........................................2
System Requirements ........................................2
Software Installation ...........................................2
Launching Y Term ...................................................5
Using Y Term ...........................................................8
The Programming Screen ..................................8
Navigating around the Programming Screen .....9
The Edit Windows ..............................................10
The Command Reference Window ....................12
The Terminal Window ........................................13
Program Monitoring ...........................................15
The Next Button .................................................16
The Tuning Screen ............................................17
Manual Tuning ...................................................18
Autotuning ..........................................................19
Testing the Tuning .............................................21
Viewing the Tune Test Results ..........................22
Printing The Tuning Test Graphs .......................23
Storage Scope ...................................................23
Viewing the Scope Results .................................25
Saving the Gains on the SMC Controller ...........25
SMC Parameter Utility .......................................26
Sigma Servo Amplifier Setup .............................27
Emergency Stop Button .....................................29
The Monitoring Screen .......................................29
Axis Output ........................................................30
General I/O ........................................................33
Dedicated I/O .....................................................34
Appendix ........................................................................35
SMC to RS-232 Connection ....................................35
Sigma servo amplifier to PC Connection .................36
Theory of Operation of the Autotuning Algorithm ....37
YTerm Software Manual
NOTES:
YTerm Software Manual
Overview
Introduction to Y Term
Y Term is a front-end software package for the Yaskawa SMC Series Motion
Controller. Y Term provides a user-friendly Windows interface for design,
development and debugging of motion control applications. The software
package consists of three main sections:
Features of Y Term
Y Term enables you to fully control and program the SMC using:
• Text editor with dual edit windows for user programs and array
data .
• Search and replace support.
• Multiple step Undo function.
• Selectable program compression and error checking during down-
load.
• Real-time monitoring of program execution (includes multi-task-
ing).
• Full screen zoom capability in programming, online manual, and
terminal window section.
• Extensive on-screen context sensitive SMC keyword help text.
• Graphical online manual and auto tuning.
• Online scoping of up to four channels of data.
•Quick load/saveofSMCparametersinand outofthecontroller.
• Real-time monitoring speed, position error, position, and torque
for all connected motors (numerical and graphical).
• Real-time monitoring of all analog and digital I/O.
• Sigma servo amplifier quick setup (Hardware required: YS-11
cable).
• Context sensitive pop-up menus.
• Online ASCII Terminal emulator window.
• Scroll-back buffer for viewing data in the Terminal window.
• Clipboard access to the Terminal window.
• Full text logging of all events in the Terminal window.
• Context sensitive help in all screens, accessible through F1 key.
1
YTerm Software Manual
Getting Started
Installing Y Term
The Y Term software kit (SMCGUI1) that you have received should include
the following:
If any of the Y Term items are missing or damaged, contact Customer Ser-
vice at Yaskawa Electric America for replacement, telephone number 1-800-
YASKAWA.
System Requirements
Software Installation
Exit other programs as a precaution against a program conflict occurring the
first time you install the softwware.
All the files required for setup are contained on the CD ROM. Before using
Y Term, run the Y Term INSTALL.EXE program. This program decom-
presses and copies the Y Term program and its associated files onto your PC
hard disk.
2
YTerm Software Manual
To run the INSTALL program:
11. The installation is now complete. Press Finish to end the instal-
lation program.
3
YTerm Software Manual
Upon completion of a successful installation, the YTerm icon will appear on
the PC desktop window:
4
YTerm Software Manual
Launching Y Term
To run Y Term, double click on the Y Term icon.
The following screen (Figure 2) will appear, while the application loads indi-
cating the version number and release date, and any user information that
you entered during the installation process.
This screen will display for a few seconds while the application loads. When
the application is loaded, it will attempt to establish communication with an
SMC. The connection will be based on previously saved communication
parameters. The first time the program runs, it will use the first free commu-
nication port in the computer, and the connection will default to 19200 baud.
5
YTerm Software Manual
If the communication access attempt was successful, the following screen
appears:
(A)
(B)
(C)
To view the “About Y Term” screen, double click on the About YTerm but-
ton. Press Exit to exit Y Term.
6
YTerm Software Manual
If the communication access attempt failed, this screen will display the "No
Connection" message as follows:
(A)
(C)
(D)
Press Test (A) to try to establish communication once more and press Con-
tinue (B) when you see the connection screen.
Press Editor Only (C) to work in offline mode if you do not have an SMC
connected. In offline mode, only the Programming screen is available.
Note: All SMC units are configured for 19200 baud rate by default.
7
YTerm Software Manual
Using Y Term
After Y Term is running and communication with the SMC has been estab-
lished, the Programming Screen (Figure 5) is displayed. Use this screen to
develop and execute SMC programs.
8
YTerm Software Manual
Note: The first time Y Term is run the Tip of the Day window (see figure
6) will pop up on top of the Programming Screen.
Click on a specific icon on the screen to activate. For example, to select one
of the editing windows, move the mouse pointer to the desired window you
want to work in and click the left mouse button. The title of the active win-
dow is highlighted while the title of the other editing window will be gray.
To edit one of the programs in full screen mode, double click the left mouse
button on the frame of one of the windows (double clicking on the text area
will select text). Double click again to return to normal viewing.
9
YTerm Software Manual
The Edit Windows
Y Term provides the ability to add comments to the program. Any program
line beginning with a double slash (//) will be ignored as the program is sent
to the SMC. This allows you to add as many comments as needed without
overloading the controller's memory with comments.
Programs in the SMC can be up to 1,000 lines, with a maximum of 80 char-
acters per line (excluding lines that begin with a double slash, which are not
loaded into the controller).
The Toolbar and the Pop-up menu provide program editing functions.
New file
Open file
Save file
Print program
Cut selected text
Copy selected text
Paste selected text
Undo last action
Search and Replace
GoTo
Get program from controller
Send program from controller
Execute program
Stop program
Figure 7- The Edit Toolbar.
Note: The functions accessed through the Toolbar are for the active edit
window.
If monitor resolution is 1024 x 768 or more and/or when a window is in full
screen mode, five (5) additional buttons will appear as follows:
• Search and Replace: displays dialog box for search and replace-
ment of text in a program.
• Go to: displays dialog box for accessing to a given line number in
a program.
• Swap: exchanges the visible program for the one that was not vis-
ible (when the program window is maximized).
10
YTerm Software Manual
• Execute: (green light) sends the EXECUTE ("XQ") command to
the controller.
• Stop: (red light) sends the STOP ("ST") command to the control-
ler.
The Pop-up Menu is accessed by clicking the mouse's right button while the
cursor is located in one of the edit windows. The Active window is high-
lighted. The pop-up menu is shown below:
11
YTerm Software Manual
• Select Array Mode to use the edit window to send, receive, load
and save array data . Comments are not allowed in arrays. When
the Array Mode is selected, Send Compressed is disabled. All
arrays are compressed before being sent to the controller.
• Select Search and Replace to search the program in the active
window for text. If text is highlighted before selecting this function,
the selected text will be used as the text to seek. You can also use
this to replace text in the program.
(A)
Figure 9: SMC Command Reference Window.
The Command Reference window provides a reference for the SMC pro-
gramming language. Get help on any command by the use of two methods:
If detailed help on SMC commands is needed, press the Manual (A) button.
The SMC Online Manual (if installed) will come up in a separate window.
To copy text from the Command Reference window, select the text to be
copied by pressing on the mouse button while dragging the cursor over the
text. Release the mouse button and click on Copy (B) to duplicate the
selected text onto the clipboard.
A double click on the Command Reference window will display the window
in full screen mode. Double click again to return to the normal view.
12
YTerm Software Manual
The Terminal Window
The Terminal window can also be used (by the SMC) to display controller
status information such as I/O, debug messages, input prompts, error mes-
sages, etc.
The Paste button completes the transfer of the text (from the clipboard) onto
the Terminal window.
The Terminal window has a pop-up menu similar to the Editing window that
is accessed by clicking the right mouse button while the cursor is on the Ter-
minal window. The pop-up menu provides functions to communicate with
the controller such as enabling or disabling servo power, status reporting,
and logging features.
When the terminal window pop-up menu is active, the following menu will
appear:
13
YTerm Software Manual
The pop-up menu has the following options:
Notes: If the log file is started and not stopped, it will continue to log the
events in the Terminal window.
The file size will continue to increase until you turn it off or when you
exit Y Term.
14
YTerm Software Manual
Program Monitoring
Once a program has been created and sent to the controller, you can now
execute the program and monitor its progress with this function. The Pro-
gram Status window, shown in Figure 11, is accessed through the pop-up
menu on the Terminal window.
Programs are executed by clicking on the left mouse button. When a pro-
gram is executing, the button text will say “Stop Program”, and when the
program is halted it will indicate “Execute Program.”
Once the program is running, the current status of each of the four possible
programs is displayed at the top of the screen. This includes the state of the
program (Running, At Trippoint and Not Running) and the current line being
executed.
The lower portion of the screen will indicate the state of the axes. Select the
axes to monitor.
A status bar at the bottom of the screen indicates the SMC status byte.
15
YTerm Software Manual
In the event of a program error, the SMC stops the execution of the program.
Y Term will display the reported error and the line on which it occurred.
This will replace the top portion of the window (which displayed the pro-
grams status) with the Error Report as shown below in Figure 12.
To switch to the Tuning Screen, click the Next button. The Next button is
used to advance to the next screen in Y Term. The Next button icon will
appear on each screen located in the lower right corner.
16
YTerm Software Manual
The Tuning Screen
The Tuning screens (Figures 14 and 14A), are used to set up the gains of the
servo motors connected to the SMC. See the SMC User's Manual for
detailed explanation about tuning a servo system.
17
YTerm Software Manual
The Terminal screen is not resizable.
Note: Use the Axis Selection Panel to select the motor to tune. You are
able to tune only one motor at a time.
Manual Tuning
18
YTerm Software Manual
Autotuning
• Y Term includes a routine that autotunes a connected servo sys-
tem. This function is able to tune most systems. Systems can be
tuned to any one of five levels of rigidity.
• See the appendix for details on the theory of Autotuing.
19
YTerm Software Manual
4. Select the level of rigidity that you want to tune the system from
the Rigidity Setting panel.
5. Select the desired machine configuration (appearing in the
Advanced Configuration panel) from the available options list.
6. Enter the motor to load gear ratio.
7. Check the Use Integrator (KI) box to include the integration
constant of the PID loop in the autotune calculations.
8. Select the correct number of Pulse per rev (revolution) pre-
quadrature for your specific motor or the linear scale resolution if
a linear encoder is to be turned.
9. Click on Tune to execute the Autotune program. Click Cancel to
close the dialog screen and cancel the Autotune operation.
20
YTerm Software Manual
Testing the Tuning
Once a servo system is tuned, you can test the results of the tuning and
observe the performance of the system. The test will execute a program
based on a user-defined motion profile.
21
YTerm Software Manual
After the controller completes sampling the data, the information is trans-
ferred to the PC and displayed as follows:
22
YTerm Software Manual
Printing The Tuning Test Graphs
The graphs of the tuning test with all of the test parameters can be printed by
clicking on the Print button. Yterm will print out the three graphs on the
default printer. To change the printer, use Window’s Printer Manager Pro-
gram to change the default printer.
Storage Scope
The storage scope is used to store data. This allows the user to choose the
parameters observed and duration. The storage scope has the capability to
store up to four parameters (dependent on the type of graph selected).
Note: Two Dimensional and Three Dimension graphs' line color and
thickness is determined by the linecolor and thickness selected in Chan-
nel #1.
Note: One (1) is the minimum engineering unit conversion. Use the
engineering units field to convert stored data from encoder counts to the
desired unit.
24
YTerm Software Manual
Viewing the Scope Results
After the controller completes sampling the data, the information is trans-
ferred to the computer and displayed as folows:
To write the gains to the motion controller, click on Burn Gains button.
After verifying this, the gains are burned onto the SMC's EPROM (This is
the equivalent to typing BN in the Terminal window). The gains will now be
saved and not be lost after the power disconnected.
Notes: If the gains are not burned, they will be lost after a software or
hardware reset of the SMC.
The motor state at power up on the SMC (enabled or disabled) is saved
at this time.
25
YTerm Software Manual
SMC Parameter Utility
The SMC Parameter Setup screen allows you to upload, download, save-to-
file, and load-from-file parameter sets for the SMC. You can use it for quick
setup of SMC Controllers, backup of setups, debugging of applications, etc.
Note: Open will open the parameters into Y Term, but will not send
them to the SMC.
26
YTerm Software Manual
Sigma Servo Amplifier Setup
The Sigma servo amplifier setup program is designed for configuring the
amplifier to work with the SMC 2000 Controller only.
Disconnect the serial communications cable from the SMC and connect the
Yaskawa YS-11 Serial Communication Cable to the servopack.
Once this is done, you can run the setup program from Y Term using the Ser-
vopack button.
Connection will be established with the Servo amplifier, the result is a return
of the servo amplifier's present settings, and should look similar to Figure
21.
27
YTerm Software Manual
Now your servo amplifier is configured for work with the SMC. The result
should now look like Figure 22.
28
YTerm Software Manual
Emergency Stop Button
In the event that you need to stop the motion of the attached servo system,
click on the Stop button. This will issue Abort (AB) and Motor Off (MO)
commands to the SMC for the selected axis. While executing Autotune and
Tune Test, the stop button will stop the selected axis, and cancel the func-
tion, otherwise all axes will be stopped.
Note: The Abort command will stop all program execution. The Motor
Off command will turn off the command functions to the selected motor.
The Monitoring Section screen, shown in Figure 23, provides you with the
ability to observe the status of selected axes. This screen can be used to track
motion parameters, inputs, and outputs.
You can choose specific axes to be monitored, and select which parameters
are to be returned. There are tabs to select from three screens of SMC status
information.
Selecting the Axis Output tab will display a screen to allow you to monitor
any servo system on the SMC's axes. The monitoring consists of returning
in real-time, the values of any of the following parameters:
• Position
• Position Error
• Speed
• Torque/Force
To stop monitoring an axis, press again on the Axis Selection button for that
axis. To select a parameter for monitoring, click the check box located left of
the name label of the desired parameter.
To switch between the two modes of display screen, Press the Display List/
Display Graph button on the Axis Output Screen.
30
YTerm Software Manual
The Max. and Min. fields are used to enter the upper and lower range of val-
ues to be displayed. The points field will determine how many points of data
are displayed on the graph.
31
YTerm Software Manual
Note: Be certain that the Min. and Max. values include the actual range
of values that the controller is reporting. This can be verified through
the listing mode (see below).
The Engineering Unit Setup Screen enables the user to enter pre-determined
motions (engineering units) into the controller to be able to retrieve data in
the units of measure related to the particular application.
Click on Reset axis to encoder counts to restore to default values and con-
tinue monitoring with the default (1) engineering units.
32
YTerm Software Manual
General I/O
Selecting the General IO tab will allow you to monitor any I/O connected to
the SMC. The monitoring consists of returning in real-time, the values of
any of the following parameters:
• Digital Outputs
• Digital Inputs
• Analog Inputs
The digital inputs and outputs are banked. In groups of eight, click on the
check box located to the left of the bank to activate. The bank will update in
real time as the status on the SMC changes. Check boxes only appear for I/O
that exist on the connected SMC.
For digital outputs, green boxes indicate low (i.e. "ON"), dark gray indicate
high (i.e. "OFF"), and light gray indicates not available.
For digital inputs, yellow boxes indicate high (i.e. "ON"), dark gray indi-
cates low (i.e. "OFF"), and light gray are not available.
The analog inputs are activated in a similar way, each one with its own check
box. The analog value of the input is displayed next to it's check box.
You can "force" the status of a digital output by clicking the buttons. After
the output is clicked, the status will change from high to low, or low to high,
identified by a color change when YTerm reads the output status from the
controller.
33
YTerm Software Manual
Dedicated I/O
Selecting the Dedicated IO tab will allow you to monitor the limits and
home inputs on the SMC. The monitoring consists of returning, the values of
any of the following parameters in real-time:
The dedicated I/O are banked in goups of eight. To make a bank active,
click on the check box next to the bank. Check boxes only appear for I/Os
that are connected on the SMC.
Green boxes indicate inputs that are active, regardless of their on-state con-
figuration, dark gray indicates the inputs are not active, and light gray indi-
cates not available.
34
YTerm Software Manual
Appendix
SMC to RS-232 Connection (SMCCBL7 cable)
The layout of the connection cable between the SMC and the PC serial port
(RS-232) is as follows:
Pin # Pin #
1 1
6 6
2 2
7 7
3 3
8 8
4 4
9 9
5 5
35
YTerm Software Manual
Sigma servo amplifier to PC Connection (YS-11 cable)
The layout of the cable, between the PC serial port (RS-232) and the Sigma
Servo amplifier is as follows:
Pin # Pin #
1 1
6 6
2 2
7 7
3 3
8 8
4 4
9 9
5 5
Case Case
5 GND ground
6 n/c not used
36
YTerm Software Manual
Table 3: Pin Description (Servo Amplifier Side - 9 Pin Male)
Pin Number Pin Name Function
The PID loop is shut off (KD=0, KP=0, and KI=0) and a voltage of 1.5 volts
is applied to the motor command output for 100 msec. The motor position is
recorded before and after this voltage is applied to determinate how far the
motor traveled in 100 msec. The farther it moved, the lower the inertia mis-
match.
Calculations are made to determinate KD, KP, and KI based on the inertia
and selected rigidity level.
The motor is moved backward and forward (approximately 11 degrees for an
1:1 gear ratio, more for higher ratios). The motion is repeated as the gains
are increased until an oscillation is detected at the end of the move. When
this happens, the gains are decreased. If the rigidity level is other then 1, the
process is repeated using less reduction in the gains after oscillation while
watching for smaller amounts of oscillation.
37
YTerm Software Manual
INDEX
A
Abort 14, 29
Amplifier setup 27
Analog inputs 29, 33
Array mode 12
Autotuning 19, 20, 37
Axis Output Screen 30, 31
Axis output 29, 30
Axis selection 18, 19, 21, 30
B
Baud 5, 7
Burn 25
C
CD ROM 2, 3
Comment 10, 11, 12
Communication port 5
D
Dedicated IO 29, 34
Defaults 4, 23
Digital inputs 29, 33
Digital outputs 29, 33
E
Engineering units 24, 32
Execute 3, 8, 10, 11, 13, 14, 15, 16, 17, 20, 21, 22, 23
Execute program 10, 15, 16
G
Gains 18, 19, 26, 38
General I/O 30, 34
Graph 1, 23, 24, 25, 26, 31, 32
H
Hardware handshaking 6
Home switches 29, 34
I
Integrator 20
L
Limits 34
Linear scale resolution 20
Logging 1, 13, 14
38
YTerm Software Manual
M
Machine configuration 20
N
Next button 16
19200 5, 7
O
Offline mode 7
P
Parameter setup 26
Print 10, 11, 23, 26
Printing 23
Programs 1, 2, 8, 9, 10, 15, 16
Program status 14, 15
Pulse per rev 20, 22
R
Reset communication 14
Rigidity 19, 20, 37
S
Sampling 22, 25
Sample time 23
Save 1, 5, 10, 12, 25, 26
Search and replace 1, 10, 12
Send compressed 11, 12
Software requirements 2
Storage scope 23, 24, 25
View log file 14
T
Tell error 14
Tell position 14
Terminal window 1, 9, 13, 14, 15, 18, 19, 21, 25
Three dimensional data 24
Two dimensional data 24
U
Units 7, 24, 32
Y
YS-11 1, 27, 36
39
YTerm Software Manual
NOTES:
40
YTerm Software Manual
41
YTerm Software Manual