MMI User Guide
MMI User Guide
User Guide
September 2020
Document Revision: 3.02
SPiiPlus MMI Application Studio User Guide
COPYRIGHT
Changes are periodically made to the information in this document. Changes are published as release notes and later
incorporated into revisions of this document.
No part of this document may be reproduced in any form without prior written permission from ACS Motion Control.
TRADEMARKS
ACS Motion Control, SPiiPlus, PEG, MARK, ServoBoost, NetworkBoost and NanoPWN are trademarks of ACS Motion Control Ltd.
EtherCAT is registered trademark and patented technology, licensed by Beckhoff Automation GmbH, Germany.
Any other companies and product names mentioned herein may be the trademarks of their respective owners.
www.acsmotioncontrol.com
NOTICE
The information in this document is deemed to be correct at the time of publishing. ACS Motion Control reserves the right to
change specifications without notice. ACS Motion Control is not responsible for incidental, consequential, or special damages of
any kind in connection with using this document.
Version 3.02 2
SPiiPlus MMI Application Studio User Guide
Revision History
Date Revision Description
September
3.02 Corrections to SinCos Encoder Compensation section
2020
December
2.50 Updated Adjuster Wizard and Scope.
2017
Version 3.02 3
SPiiPlus MMI Application Studio User Guide
Version 3.02 4
SPiiPlus MMI Application Studio User Guide
Format Description
Monospace + grey
Code example
background
Blue Hyperlink
Flagged Text
Warning - describes a condition that may result in serious bodily injury or death.
Version 3.02 5
SPiiPlus MMI Application Studio User Guide
Related Documents
Documents listed in the following table provide additional information related to this document.
The most updated version of the documents can be downloaded by authorized users from
www.acsmotioncontrol.com/downloads.
Online versions for all ACS software manuals are available to authorized users at ACS Motion Control
Knowledge Center.
Document Description
SPiiPlus Setup Guide A complete guide for setting up the SPiiPlus system.
SPiiPlus Command & Variable Complete description of all variables and commands in
Reference Guide the ACSPL+ programming language.
Version 3.02 6
SPiiPlus MMI Application Studio User Guide
Table of Contents
1. SPiiPlus MMI Application Studio Overview 17
1.1 System Requirements 17
1.1.1 SPiiPlus MMI Application Studio 17
1.2 SPiiPlus MMI Application Startup Window 18
1.3 Menu Bar 20
1.4 Toolbars 22
1.5 Workspace Tree Tab 24
1.6 Toolbox Tab 24
1.7 Program Manager 25
1.8 Properties Window 26
1.9 Communication Terminal 26
1.10 Emergency Stop Button 27
1.11 Wizards 27
1.12 Graphic Monitors 28
1.13 Variables Monitoring Tools 28
1.14 Motion Manager 29
2. MMI Basics 30
2.1 Workspace Operations 30
2.1.1 Creating a New Workspace 30
2.1.2 Saving a New Workspace 31
2.1.3 Loading a New Workspace 32
2.1.4 Closing the Workspace 34
2.2 Handling Controllers 34
2.2.1 Adding a Controller 35
2.2.2 Disconnecting a Controller 40
2.2.3 Connecting a Controller 40
2.2.4 Setting Controller Properties 40
2.2.4.1 COMMFL 41
2.2.4.2 DISPCH 43
2.2.4.3 BAUD 43
2.2.4.4 TCPIP 44
2.2.4.5 SUBNET 44
Version 3.02 7
SPiiPlus MMI Application Studio User Guide
2.2.4.6 GATEWAY 44
2.2.4.7 TCPIP2 44
2.2.4.8 TCPPORT 45
2.2.4.9 Controller Parameters Function Buttons 45
2.2.5 Saving to Flash 45
2.2.6 Controller Reboot 46
2.2.7 Setting Factory Defaults 47
2.2.8 Removing a Controller 49
2.3 Handling Workspace Components 49
2.3.1 Opening a Component 49
2.3.2 Closing a Component 50
2.3.3 Removing a Component 50
2.4 Working with Workspace Tree 50
2.4.1 Workspace Right-Click Options 51
2.4.2 Controller Right-Click Options 52
2.4.3 Component Right-Click Options 53
2.5 Working with Properties Window 54
2.6 Workspace Tab Options 56
2.7 Panel Controls 57
2.8 Tool Tips 57
2.9 Printing Component Data 58
2.9.1 Print Report Preview Window 59
2.10 Working with Wizards 61
2.10.1 Starting a Wizard 61
2.10.2 Wizard Window Elements 63
3. Setup 66
3.1 Accessing Setup Tools 66
3.2 Adjuster Wizard 66
3.2.1 Starting Adjuster Wizard 67
3.2.2 Adjuster Wizard Select Task Window 68
3.2.3 Adjuster Wizard Task Steps 70
3.2.4 Component Database 72
3.2.5 Working in Adjuster Wizard Task Windows 72
3.2.6 Setup New System or Controller 74
Version 3.02 8
SPiiPlus MMI Application Studio User Guide
3.2.6.1 Initialization 74
3.2.6.2 Axis Architecture 75
3.2.6.3 Components 78
3.2.6.3.1 Motor 78
3.2.6.3.2 Drive 79
3.2.6.3.3 Feedback 80
3.2.6.3.4 Calculate Parameters 81
3.2.6.4 Safety and Protection 82
3.2.6.4.1 Motion Parameters Limits 83
3.2.6.4.2 Current Limits 84
3.2.6.4.3 Position Errors 85
3.2.6.4.4 Position Limits 87
3.2.6.5 Miscellaneous Definitions 87
3.2.6.5.1 Motion Completion 88
3.2.6.5.2 Enable/Disable/Brake 88
3.2.6.5.3 Dynamic Brake 89
3.2.6.5.4 Home Switch 90
3.2.6.6 Verification 91
3.2.6.6.1 Feedback 92
3.2.6.6.2 Switches 95
3.2.6.6.3 Stop, Alarm and Brake 96
3.2.6.7 Axis Setup and Tuning 97
3.2.6.7.1 Current Loop 97
3.2.6.7.2 Current Phase Offset 102
3.2.6.7.3 Commutation 104
3.2.6.7.4 Open Loop Verification 113
3.2.6.7.5 Position and Velocity Loops 115
3.2.6.7.6 Position Verification 122
3.2.6.8 Save to Flash 124
3.2.7 Adjust Tuning of Predefined System 125
3.2.8 Verify Correct Setup of Predefined System and Adjuster Tuning 128
3.2.9 Axis Duplication 132
3.3 System Setup 134
3.3.1 Automatic System Setup 134
Version 3.02 9
SPiiPlus MMI Application Studio User Guide
Version 3.02 10
SPiiPlus MMI Application Studio User Guide
Version 3.02 11
SPiiPlus MMI Application Studio User Guide
Version 3.02 12
SPiiPlus MMI Application Studio User Guide
Version 3.02 13
SPiiPlus MMI Application Studio User Guide
Version 3.02 14
SPiiPlus MMI Application Studio User Guide
Version 3.02 15
SPiiPlus MMI Application Studio User Guide
Version 3.02 16
SPiiPlus MMI Application Studio User Guide
1. SPiiPlus MMI Application Studio Overview
Version 3.02 17
SPiiPlus MMI Application Studio User Guide
1. SPiiPlus MMI Application Studio Overview
Workspace
The Workspace is where all data is entered. The contents of the Workspace depend on the MMI
option that is currently being used.
Workspace Tree
The Workspace Tree displays all MMI components associated with the Workspace that you have
activated.
The pod in which the Workspace Tree is displayed has two tabs:
> Workspace Tree Tab - clicking this tab displays the Workspace Tree.
> Toolbox Tab - clicking this tab displays the SPiiPlus MMI Application Studio tools.
Version 3.02 18
SPiiPlus MMI Application Studio User Guide
1. SPiiPlus MMI Application Studio Overview
Status Bar
This displays messages of the MMI status and the status of any component action you have
executed.
Version 3.02 19
SPiiPlus MMI Application Studio User Guide
1. SPiiPlus MMI Application Studio Overview
Close
Close the currently displayed Workspace.
Workspace
Save
Save the Workspace data.
Workspace
Save
Workspace Save the Workspace data to a different filename.
As
Toolbox
Toggle Toolbox display on and off.
Window
Properties
View Toggle Properties display on and off.
Window
Workspace
Toggle Workspace Tree display on and off.
Window
Add
Add a new controller to the Workspace.
Controller
Version 3.02 20
SPiiPlus MMI Application Studio User Guide
1. SPiiPlus MMI Application Studio Overview
Settings > Warnings - Errors & warnings are included in the log.
> Info - Errors, warnings and messages are included in
the log. Verbose - Everything is included in the log.
In addition you can set the display time for ToolTips in
seconds.
Knowledge
Open the Knowledge Center in the web browser.
Center
When you press Alt + the Underlined Letter, the selections for the Menu option are
displayed.
Version 3.02 21
SPiiPlus MMI Application Studio User Guide
1. SPiiPlus MMI Application Studio Overview
1.4 Toolbars
The SPiiPlus MMI Application Studio contains four built-in toolbars:
> Workspace
This toolbar contains function buttons for components in the Workspace tree. They are:
> Open - Displays the selected component in the Workspace
> Close - Closes the selected component in the Workspace
> Remove - Removes the selected component from the Workspace
Version 3.02 22
SPiiPlus MMI Application Studio User Guide
1. SPiiPlus MMI Application Studio Overview
> Style
Version 3.02 23
SPiiPlus MMI Application Studio User Guide
1. SPiiPlus MMI Application Studio Overview
When you initiate SPiiPlus MMI Application Studio, the following functions are loaded by default:
> Program Manager
> Motion Manager
> Communication Terminal
As you work within the MMI, each function that you employ is added to the list.
For details on the Workspace Tree operations, see Working with Workspace Tree.
Version 3.02 24
SPiiPlus MMI Application Studio User Guide
1. SPiiPlus MMI Application Studio Overview
> Setup
The Setup set of tools enables you to configure your SPiiPlus Motion Controller
> Application Development
The Application Development set of tools enables you to program your SPiiPlus Motion
Controller.
> Utilities
The Utilities enable you to upgrade the SPiiPlus Motion Control firmware and software.
Utilities also is your access point to Communication Terminal which enables you to send
commands directly to the SPiiPlus Motion Controller.
> Diagnostics and Monitoring
The Diagnostics and Monitoring set of tools enables you to monitor, graphically through
the Scope and the FRF Analyzer, and analyze the motion as well as keep abreast the
values of critical variables.
Version 3.02 25
SPiiPlus MMI Application Studio User Guide
1. SPiiPlus MMI Application Studio Overview
For details of the Properties window see Working with Workspace Tree.
Version 3.02 26
SPiiPlus MMI Application Studio User Guide
1. SPiiPlus MMI Application Studio Overview
Clicking this button immediately stops all Program Buffers along with halting all motors and sets all
axis offsets to 0.
By default, the button is always overlaid on top of the display. To change this, right-
click the button and uncheck Always On Top.
1.11 Wizards
Wizards are special tools where your operations have been bundled into a single tool. For each
option of a wizard there is a logical sequence of actions that need to be taken, and the wizard leads
through them step-by-step. The SPiiPlus MMI Application Studio has the following wizards:
> Adjuster Wizard
The Adjuster Wizard, one of the Setup tools, enables you to improve the system and
modify its behavior. The Adjuster Wizard provides tuning in terms of high-level
parameters, namely parameters that have a clear meaning for you. Once you have
assigned values to the high-level parameters, the Adjuster Wizard automatically
transforms them into values for the low-level parameters, that is, controller parameters.
> Application Wizard
The Application Wizard, one of the Application Development tools, enables you to manage
the controller program files, such as loading applications, saving applications, copying files
to the controller, as well as loading/saving system and axis parameters.
> Upgrade and Recovery Wizard
Version 3.02 27
SPiiPlus MMI Application Studio User Guide
1. SPiiPlus MMI Application Studio Overview
The Upgrade and Recovery Wizard, one of the Utilities tools, enables you to upgrade your
controller’s firmware as well as to recover the firmware data should you need to reinstall
the controller.
> Protection Wizard
The Protection Wizard, one of the Application Development tools, enables you to define
the controller program Protection mode parameters, modify the Protection mode
parameters, and view the Protection status. By applying Protection, you assure that your
ACSPL+ programs are protected from unauthorized changes to system and axis
parameters.
Version 3.02 28
SPiiPlus MMI Application Studio User Guide
1. SPiiPlus MMI Application Studio Overview
Version 3.02 29
SPiiPlus MMI Application Studio User Guide
2. MMI Basics
2. MMI Basics
This chapter presents the procedures used in performing the basic functions in the SPiiPlus MMI
Application Studio Workspace.
The basic functions covered by this chapter include:
> Workspace Operations
> Handling Controllers
> Handling Workspace Components
> Working with Workspace Tree
> Working with Wizards
Version 3.02 30
SPiiPlus MMI Application Studio User Guide
2. MMI Basics
You can also create a new Workspace by pressing Ctrl+N, or by clicking in the top
bar.
5. If you want to save the current Workspace, click Yes; otherwise click No. The new
Workspace is loaded.
6. To rename the Workspace click the Workspace folder and type in the new name.
Version 3.02 31
SPiiPlus MMI Application Studio User Guide
2. MMI Basics
You can also save the new Workspace by pressing CTRL+S, or by clicking in the
toolbar.
Version 3.02 32
SPiiPlus MMI Application Studio User Guide
2. MMI Basics
You can also open the new Workspace by pressing Ctrl+O, or by clicking toolbar.
4. Use the Open window to browse for the location of the file, select the file and click Open.
Version 3.02 33
SPiiPlus MMI Application Studio User Guide
2. MMI Basics
6. If you want to save the current Workspace, click Yes; otherwise click No. The new
Workspace is loaded.
4. If you want to save the current Workspace, click Yes; otherwise click No.
Version 3.02 34
SPiiPlus MMI Application Studio User Guide
2. MMI Basics
You can also click ADD CONTROLLER on the toolbar or press ALT+A.
Version 3.02 35
SPiiPlus MMI Application Studio User Guide
2. MMI Basics
Version 3.02 36
SPiiPlus MMI Application Studio User Guide
2. MMI Basics
Version 3.02 37
SPiiPlus MMI Application Studio User Guide
2. MMI Basics
> Select the IP Address from the Controller IP Address dropdown list.
Version 3.02 38
SPiiPlus MMI Application Studio User Guide
2. MMI Basics
> Enter the IP of the remote computer in the Remote Address field.
> Enter the port number of the remote computer in the Remote Port field.
> If the remote computer has login requirements, enter the Domain name, Username
and Password in the Login Details.
> Click Connect. The controller is automatically stored in the Workspace folder and
appears in the Workspace Tree.
Version 3.02 39
SPiiPlus MMI Application Studio User Guide
2. MMI Basics
To connect all the controllers that have been disconnected click Connect All (
).
Version 3.02 40
SPiiPlus MMI Application Studio User Guide
2. MMI Basics
2.2.4.1 COMMFL
COMMFL is a scalar variable containing a set of 9 bits that affect controller communication. To set
the bits:
Version 3.02 41
SPiiPlus MMI Application Studio User Guide
2. MMI Basics
2. You can either type the number in the Message Flags (COMMFL) field, or select the
bits you want to enable by clicking the appropriate checkbox. The meanings of the
bits are:
Bit
Description
No.
3. Click Close to save the settings. Or you can click Default to enter the default settings.
Version 3.02 42
SPiiPlus MMI Application Studio User Guide
2. MMI Basics
2.2.4.2 DISPCH
DISPCH is a scalar integer variable that defines the communication channel between the controller
and a host application, MMI or any device connected to the controller's communication ports.
DISPCH is relevant only to messages sent with DISP and SEND (referred to as “Unsolicited
Messages”). In order to view unsolicited messages in the window, select the check box in the lower
right corner of the Terminal window to enable Show Unsolicited Messages.
If DISPCH specifies a valid communication channel, all unsolicited messages (messages that are sent
with DISP and SEND from the program buffers) are sent to this channel irrespective of the channel
used for immediate commands.
To set DISPCH: Type the required number in the Default Channel (DISPCH) field. Your choices are:
Channel
Description
Number
1 Serial port 1
2 Serial port 2
12 PCI bus
2.2.4.3 BAUD
BAUD is an integer variable that defines the serial communication rate, given in bits per second.
Enter the required Baud rate from the dropdown menu by clicking the down arrow of the Serial
Baud Rate (BAUD) field. The options are:
> 300
> 1200
> 4800
> 9600
Version 3.02 43
SPiiPlus MMI Application Studio User Guide
2. MMI Basics
> 19200
> 57600
> 115200 (default)
2.2.4.4 TCPIP
TCPIP sets IP Address for the 1st Ethernet Port. If TCPIP has a non-zero value, the controller uses the
value as its TCP/IP address.
The default address is 10.0.0.100.
To set the IP Address enter the address in the TCP/IP Address (TCPIP) field.
If you set the TCPIP to: 0.0.0.0, the controller uses the DHCP protocol to retrieve the network
configuration from the DHCP server. The network configuration received from the DHCP server
includes the following parameters:
> Controller’s TCP/IP address
> Subnet mask
> Gateway address
2.2.4.5 SUBNET
SUBNET is used to determine to what subnet an IP address belongs.
The SUBNET value consists of four individual bytes, each being a decimal number between 0 and
255, separated by dot. The right most value is the least significant byte.
The default is 255.255.255.0.
To set the Subnet Mask enter the values in the Subnet Mask (SUBNET) fields.
If controller is configured to get network settings from DHCP server, that is, TCP/IP is set to 0.0.0.0,
SUBNET receives its value from the DHCP server subnet mask.
2.2.4.6 GATEWAY
GATEWAY is the address of a network router that serves accessing another network segments.
The GATEWAY value consists of four individual bytes, each being a decimal number between 0 and
255, separated by dot. The right most value is the least significant byte.
The default is 0.0.0.0.
To set the Gateway address enter the values in the Gateway (GATEWAY) fields.
If controller is configured to get network settings from DHCP server, that is, TCP/IP is set to 0.0.0.0,
GATEWAY receives its value from the DHCP server gateway address.
2.2.4.7 TCPIP2
TCPIP2 sets IP Address for the 2nd Ethernet Port. If TCPIP2 is zero, the address will be automatically
obtained at the controller start-up through the DHCP protocol.
The default address for second Ethernet port is 192.168.0.100.
To change the IP Address enter the address in the TCP/IP Address2 (TCPIP2) field.
Version 3.02 44
SPiiPlus MMI Application Studio User Guide
2. MMI Basics
2.2.4.8 TCPPORT
TCPPORT defines Ethernet ports in the controller for TCP. The value that can be set in TCPPORT
ranges between 0 and 65536. By default, this variable is set to 701.
In order to establish communication with the controller through a port different from default port
numbers, do the following:
1. Set TCPPORT to a value other than 701 (you can use the up and down arrows of the TCP/IP
Port (TCPPORT) field to increment/decrement the value).
Some of the ports are used by the controller OS and cannot be used. It's recommended
to use ports starting from 1024.
Removes any values you have entered and restores the previous
values.
Version 3.02 45
SPiiPlus MMI Application Studio User Guide
2. MMI Basics
Version 3.02 46
SPiiPlus MMI Application Studio User Guide
2. MMI Basics
5. Click OK.
While this option exists, it should be used with some care in that the factory defaults
may be inconsistent with your system, and may cause you to lose communication with
the controller.
Version 3.02 47
SPiiPlus MMI Application Studio User Guide
2. MMI Basics
Version 3.02 48
SPiiPlus MMI Application Studio User Guide
2. MMI Basics
5. Click OK.
3. Click Yes.
Version 3.02 49
SPiiPlus MMI Application Studio User Guide
2. MMI Basics
2. Click Close ( ) on the toolbar or press Alt+C. The component is no longer displayed in
the Workspace.
Version 3.02 50
SPiiPlus MMI Application Studio User Guide
2. MMI Basics
Only Program Manager and Variables Manager and Watch have sub-components, but
their right-click options are the same as level three components.
When you click the file, it is opened in the appropriate application. When you save the Workspace,
the shortcut is saved as part of the Workspace.
Version 3.02 51
SPiiPlus MMI Application Studio User Guide
2. MMI Basics
This function can also be selected from list in the Workspace option of the Main Menu.
A good use for this capability is to link ACS Motion Control documentation, such as the
SPiiPlus Command & Variable Reference Guide and the SPiiPlus ACSPL+ Programmer's
Guide for looking up information while working in the SPiiPlus MMI Application Studio.
Version 3.02 52
SPiiPlus MMI Application Studio User Guide
2. MMI Basics
The Add Component is a very handy option in that it saves you time navigating through
the SPiiPlus MMI Application Studio to activate a particular component.
For example, say you want to activate the HSSI Manager, rather than display Toolbox
and selecting Utilities, then selecting HSSI Manager, all you need to do is drill down
through this option:
> Properties - this activates the controller’s Properties window, see Working with Properties
Window.
Version 3.02 53
SPiiPlus MMI Application Studio User Guide
2. MMI Basics
Properties that are highlighted in bold can be changed in the pod by clicking the field to input-
focus it. Those properties that are grayed-out are for information only and cannot be changed
through the Properties pod.
There are three action buttons associated with the Properties window:
Version 3.02 54
SPiiPlus MMI Application Studio User Guide
2. MMI Basics
Version 3.02 55
SPiiPlus MMI Application Studio User Guide
2. MMI Basics
The Custom tab presents gradations of the most common colors. You select the color by clicking
the required box.
Version 3.02 56
SPiiPlus MMI Application Studio User Guide
2. MMI Basics
> New Horizontal Tab Group - the area of the tab group is split in half horizontally and the
tabbed window is moved to the lower area
> New Vertical Tab Group - the area of the tab group is split in half vertically and the tabbed
window is moved to the area on the right
The panel display can be restored by placing the mouse cursor over it. Then when you move the
mouse cursor outside the pod, it slides back to the side.
Version 3.02 57
SPiiPlus MMI Application Studio User Guide
2. MMI Basics
You can set the length of time, in seconds, that the Tool Tip remains displayed by
selecting ToolsèSettings from the Main Menu. This displays a dialog window:
Enter the display time (the default is 30 seconds) and click OK.
Version 3.02 58
SPiiPlus MMI Application Studio User Guide
2. MMI Basics
1. Select Print from the Main Menu File option. This displays the Print Manager:
2. Select the data you want to print. By default Print Manger selects all checkboxes. If there is
data you do not want to print, unselect the appropriate checkbox.
3. Click Print. The Print Report Preview window is displayed.
Version 3.02 59
SPiiPlus MMI Application Studio User Guide
2. MMI Basics
Toolbar
The Print Report Preview Toolbar contains the following buttons:
Version 3.02 60
SPiiPlus MMI Application Studio User Guide
2. MMI Basics
Resize Two Pages - resize report to fit two pages in display window
Version 3.02 61
SPiiPlus MMI Application Studio User Guide
2. MMI Basics
2. Click the required wizard in the list. The Select a Task window for the selected wizard is
displayed in the workspace, for example:
Version 3.02 62
SPiiPlus MMI Application Studio User Guide
2. MMI Basics
The wizard can also be selected directly by right-clicking the controller and selecting
Add componentè<Tool>è<Wizard>, from the dropdown menu, for example:
3. Select the Task by clicking the associated button and then click Next.
Version 3.02 63
SPiiPlus MMI Application Studio User Guide
2. MMI Basics
Displays the next task in the Task Workspace. It should be noted that this
button is not available until you have entered all of the data required by the
task step.
Version 3.02 64
SPiiPlus MMI Application Studio User Guide
2. MMI Basics
Aborts the wizard. When you click this button, you are prompted with, for
example:
There are other action buttons that are specific to particular tasks, such as Restart ( )
which, when clicked, reboots the SPiiPlus Motion Controller.
Version 3.02 65
SPiiPlus MMI Application Studio User Guide
3. Setup
3. Setup
Setup contains the following tools for setting up your controller and system:
> Adjuster Wizard for setting up your motion parameters and adjust them to maximize your
system’s motion performance.
> Safety and Faults Configurator - for selecting specific faults that you want monitored
during a program run.
> Automatic System Setup - for performing a manual or automatic system configuration.
The Adjuster Wizard is used to setup the system and tune the control loops. You use the Adjuster
Wizard to set the parameters for the:
> Axis architecture
> Drive
> Motor
> Feedback
The Adjuster Wizard provides tuning in terms of high-level parameters, namely parameters that
have a clear meaning for you. Once you have assigned high-level parameters, the Adjuster Wizard
automatically translates them into low-level parameters, that is, controller parameters.
Since the Adjuster Wizard works together with the Scope, the Adjuster provides interactive tuning.
The Adjuster Wizard sends a trial signal to the motor and automatically selects suitable Scope
settings and sends the low-level parameter values. The Scope displays the motor response and
you can immediately view the results.
Version 3.02 66
SPiiPlus MMI Application Studio User Guide
3. Setup
Some operations during the adjustment process may cause the motor to begin moving
unexpectedly. Some of the limits and safety features may be temporarily disabled. To
avoid personal injury or damage to the equipment, check the following before starting
the adjustment process:
> Verify that NOTHING (people, electrical cables, or other obstacles) is in the path
of the motor or objects connected to the motor.
> Verify that the motor is securely anchored and that proper safety barriers,
stops, and/or limits are installed.
You can also activate the Adjuster Wizard using the right-click Add Component option
of the Workspace Tree - see Controller Right-Click Options.
Version 3.02 67
SPiiPlus MMI Application Studio User Guide
3. Setup
Version 3.02 68
SPiiPlus MMI Application Studio User Guide
3. Setup
To view the Adjuster database default values click View Adjuster Parameters,
the View Adjuster Parameters window is displayed with the values for the
selected axis.
To view the controller parameter values click View Controller Parameters, the
View Controller Parameters window is displayed with the values for the
selected axis.
> Copy Values From Axis - using values that have previously been set for
another axis.
When you select this option, you choose the axis whose values
are to be used from the Select Axis To Copy From (which
becomes active when you select this option) dropdown list:
Version 3.02 69
SPiiPlus MMI Application Studio User Guide
3. Setup
You can view the Adjuster and Controller parameters values that will be copied.
If these are the values you want to copy, click Yes.
3. Select Task
There are four tasks that can be performed using the Adjuster Wizard:
> Setup New System or Controller
You perform this task when setting up a new controller, or if the controller has been
set to the factory default values.
When performing the task you not only set the control loop values, but you also set
system hardware values, that is, values for the Drive and Motor.
> Adjust Tuning of Predefined System
You perform this task to fine-tune the control loop values.
When you select this task, you are taken directly to the Axis Setup and Tuning step.
> Verify Correct Setup of Predefined System and Adjuster Tuning
You perform this task to verify the setup that was saved to the controller from the
Setup New System of Controller task.
When you select this task, you are taken directly to the Verification step and then to
the Axis Setup and Tuning step. Both of these steps are available only if you have first
setup the system.
> Axis Duplication
You perform this task to copy an axis set of parameters to any other axis in the
controller.
When you select this task, a window appears in which you can select the source axis
and the destination axis.
Version 3.02 70
SPiiPlus MMI Application Studio User Guide
3. Setup
In this step you provide information that serves to identify the database containing the
high-level parameter values.
> Axis Architecture
In this step you define the electro-mechanical structure of the controller’s working
application as well as the units for measuring feedback.
> Components
In this step you define the parameters governing the:
> Drive
> Motor
> Feedback
Once you have defined these, you trigger the Adjuster to calculate the optimal values for
the high-level parameters and you load them into the system.
> Safety and Protection
In this step you define the parameters for:
> Motion limits
> Current limits
> Position errors
> Position limits
> Miscellaneous Definitions
In this step you define the parameters for such things as:
> Motion completion
> Enable/Disable/Brake
> Dynamic brake
> Home switch
> Verification
In this step the AdjusterWizard runs various verification tests for such things as:
> Feedback
> Motor
> Switches
> Stop, Alarm and Brake
This enables you to see where you need to adjust the values of the parameters.
> Axis Setup and Tuning
In this step you are given the opportunity to refine your values and fine tune your system.
> Save to Flash
Once your high-level values are correct for your system, in this step you save the low-level
values to the controller flash.
Version 3.02 71
SPiiPlus MMI Application Studio User Guide
3. Setup
Many of task options are dependent on the nature of the three basic components you
have defined. That is, the type of motor, drive and required feedback signal defined in
the Axis Architecture and Components steps determine what you can define in the
subsequent steps.
If the controller is shut off during an adjustment session and the data has not been
saved to the controller’s flash memory, synchronization is lost and the adjustment
session must be repeated.
Incompatibility Symbol
The Incompatibility Symbol indicates that the value in the component field is incompatible with
what you have defined in previous windows.
You should return to a previous window and change the value with which it is in conflict, or, if
possible, change the value in the field in the current window. In any case you should resolve all
conflicts before continuing.
This symbol can be ignored when an element is not yet defined. For example, a Drive
has been defined but not the Motor.
Version 3.02 72
SPiiPlus MMI Application Studio User Guide
3. Setup
Drill down to the subdirectory containing database files and select the file, all
Adjuster database files have an awd file extension. Then click Open.
Drill down to the subdirectory containing database files and enter the filename, all
Adjuster database files have an awd file extension. Then click Save.
Version 3.02 73
SPiiPlus MMI Application Studio User Guide
3. Setup
3.2.6.1 Initialization
Initialization serves only for tracking purposes.
Version 3.02 74
SPiiPlus MMI Application Studio User Guide
3. Setup
1. Enter your name in the User Name field (optional - this field may be skipped).
2. Enter the name of your application or the ID of the machine for which the controller is
being employed in the Application/Machine field (optional - this field may be skipped).
You will note that Adjuster has extracted the controller’s firmware version, S/N and
P/N from the controller and filled in these fields.
3. Enter the date in the Date field - its format is: mm/dd/yyyy. Or you can click the down
arrow and select the date from the calendar.
4. Enter any remarks you want in the Remarks field (optional - this field may be skipped).
5. Click Next.
Version 3.02 75
SPiiPlus MMI Application Studio User Guide
3. Setup
Data must be entered in all the fields. The data is entered by selecting the appropriate value from
the dropdown list of each field.
Feedback Topology
The feedback topology choices are:
> Verification,
on motor
PDICL > Verification,
on load
> None
PDMNT None
Once you have entered all the values, click Next to go on to the next step.
User Units
Of particular import in this step is the setting of User Units to be used by Adjuster in measuring
feedback. The User Unit can be millimeters, microns, nanometers, degrees or any other unit that
defines a distance for a linear axis or an angle for a rotary axis.
The User Unit is defined per axis. By default, the User Unit is the Encoder Count. For example, for a
quadrature encoder with resolution of 500 lines per millimeter, each default User Unit equals
2mm/4 = 0.5mm.
Version 3.02 76
SPiiPlus MMI Application Studio User Guide
3. Setup
The User Unit is applied to the EFAC variable. EFAC is a 64 bits member (one for each possible axis)
real array used for defining a factor between the raw feedback in encoder counts and the FPOS
value calculated by the controller. See SPiiPlus Command & Variable Reference Guide for complete
details.
Advanced Parameters
Advanced Parameters enables you define your own feedback units.
The Advanced Parameters option should be used with caution. Badly defined units
may cause serious problems with measuring the actual feedback.
To access Advanced Parameters click in Units field and select User defined, for example:
Version 3.02 77
SPiiPlus MMI Application Studio User Guide
3. Setup
4. Enter a correction factor (if different than 1) in Correction Factor. The correction factor is
used to correct the difference between actual movement (as measured by a laser
interferometer) and the software commanded move (indicated in the user units).
3.2.6.3 Components
The Components step consists of defining the values for:
> Motor
> Drive
> Feedback
At the end of the step the Adjuster calculates the parameters that are to be used and inserts them
into the appropriate program variables.
For this step you will need the technical specifications for the motor and drive from
which to extract the correct values.
The screen shots presented in this step are for example only. The actual fields that
appear depend on the values set in the Axis Architecture step.
3.2.6.3.1 Motor
The first component for which you need to enter values is the Motor.
Data must be entered in all the fields. The data is entered by selecting the appropriate value from
the dropdown list of each field or entering the values taken from the motor’s technical data sheet.
Version 3.02 78
SPiiPlus MMI Application Studio User Guide
3. Setup
In entering the values the incompatibility icon ( ) may appear. Check the tool-tip. If it
states that there is incompatibility between components that have not been set yet,
ignore it. Continue to set component values.
However, do not forget to go back after all the components have been set up and
ensure that it no longer appears. If it still appears, then resolve it by changing the
component's values or changing the Axis Setup values.
Once you have entered all the values, click Next to define the Drive component.
3.2.6.3.2 Drive
The second component for which you need to enter values is the Drive.
The relevant drive parameters are:
> Step Motor
Data must be entered in all the fields. The data is entered by selecting the appropriate value from
the drop-down list of each field or entering the values taken from the drive’s technical data sheet.
In entering the values the incompatibility icon ( ) may appear. Check the tool-tip. If it
states that there is incompatibility between components that have not been set yet,
ignore it. Continue to set component values.
However, do not forget to go back after all the components have been set up and
ensure that it no longer appears. If it still appears, then resolve it by changing the
component's values or changing the Axis Setup values.
Version 3.02 79
SPiiPlus MMI Application Studio User Guide
3. Setup
Step Motor
Controller Drive
Feedback topology Window Behaviour
Interface
Verification, on motor
ACS PWM Verification, on load Available - as Stepper Motor
None
Once you have entered all the values, click Next to define the Feedback component.
3.2.6.3.3 Feedback
The Feedback component can be either the Motor, the Load, or both depending on
what you defined in Feedback Topology in the Axis Architecture step.
Data must be entered in all the fields that are active (many, you will note, have already been
selected by Adjuster from data that you have previously entered for the Drive and Motor
components). The data is entered by selecting the appropriate value from the dropdown list of
each field or entering the values directly in the fields.
In entering the values the incompatibility icon ( ) may appear. Check the tool-tip to
see what is causing the incompatibility. If it is a value of a previously set up component,
then return to the component and either change the component’s value, or make
changes in the Axis Setup.
Make sure that all component incompatibilities are resolved before continuing.
Version 3.02 80
SPiiPlus MMI Application Studio User Guide
3. Setup
Controller Drive
Feedback topology Window behavior
Interface
Single, on motor
Single, on load
ACS PWM Verification, on Available
motor
Verification, on load
Verification, on
PDICL motor Available
Verification, on load
At this stage, the Adjuster verifies that the Axis Architecture, Motor, Drive and Feedback definitions
are all compatible with each other.
If an inconsistency is detected, a prompt is displayed about it with recommended solutions.
Version 3.02 81
SPiiPlus MMI Application Studio User Guide
3. Setup
At this stage values are stored in the low-level parameters within the Adjuster. They
do not take effect until you have saved them into the controller's flash memory.
The actual number of parameter types and parameters available to you depends on
what you defined in the Axis Architecture and Components steps.
The Adjuster displays values it has calculated in the window of each type. You have the option of
changing these within the limits of valid values.
A complete explanation of each parameter is given in the Tool Tips associated with the
parameter.
Version 3.02 82
SPiiPlus MMI Application Studio User Guide
3. Setup
For the meanings of the variables see the SPiiPlus Command & Variable Reference
Guide.
This window is used for entering the Maximum Velocity and Maximum Acceleration Limits values.
> MAXIMUM VELOCITY (XVEL) [UNITS/SEC] - The maximum allowed value is automatically
calculated based on motor parameters that were defined in Components step. Letting the
mouse cursor linger on the field displays a tool-tip guiding you in permissible values.
> MAXIMUM ACCELERATION (XACC) [UNITS/SEC²] - The Adjuster puts in a value based on
motor parameters that were defined in Components step. Letting the mouse cursor linger
on the field displays a tool-tip guiding you in permissible values.
> KILL (Emergency Deceleration - KDEC)[deg/sec2]
Version 3.02 83
SPiiPlus MMI Application Studio User Guide
3. Setup
This window is used for defining motor and drive protection parameters:
> Maximum Current In Idle State (XCURI) - The Adjuster automatically calculates the value
from the maximum torque/force required during standstill to overcome gravitation,
friction, etc.
If the value cannot be automatically calculated, that is, you have not specified gravitation,
friction, etc., the parameter XCURI is set to default.
If you want to set values other than the value displayed, letting the mouse cursor linger on
the field displays a tool-tip guiding you in permissible values.
> Maximum Current In Moving State (XCURV) - The value is automatically calculated
according to minimum of either maximal acceleration (XACC) or motor peak current that
you have specified.
If you want to set values other than the calculated one, letting the mouse cursor linger on
the field displays a tool-tip providing guidance in changing maximal acceleration or motor
peak values.
> Overcurrent Fault detection - The following numeric controls defines Overcurrent Fault
detection criterion:
> RMS CURRENT LIMIT (XRMSD, XRMSM) - The value is automatically calculated based on
motor/drive parameters that were defined in the Components step.
If you want to set values other than the calculated ones, letting the mouse cursor
linger on the field displays a tool-tip guiding you in permissible values for the motor
and/or drive current limits.
> RMS CURRENT TIME CONSTANT (XRMSTD, XRMSTM) - This is the time interval for
checking whether an overcurrent fault has occurred (meaning that XRMSM or XRMSD
has been exceeded). The overcurrent fault activation time is according to the
following formula:
Version 3.02 84
SPiiPlus MMI Application Studio User Guide
3. Setup
When you change parameter values, you can see the effect on the graph.
Version 3.02 85
SPiiPlus MMI Application Studio User Guide
3. Setup
This enables you to set values for Non-critical Position Errors whereby excessive errors that
might affect the application are flagged:
> Non-critical Position Error Fault Detection
> Position Error In Idle (ERRI)
> Position Error While In Constant Velocity (ERRV)
> Position Error While Accelerating (ERRA)
> Motion Phase Transition Delay
> Moving-to-Idle Transition Delay (DELI)
> Accelerating-to-Moving Transition Delay (DELV)
> Kill-to-Idle Transition Delay (DELK)
Version 3.02 86
SPiiPlus MMI Application Studio User Guide
3. Setup
This window defines Software Position Limits and enables you to select:
> ALLOW SOFT UPPER POSITION DETECTION (SRLIMIT) - If Software Right Limit Mask is
selected, then the controller examines the fault and kills the motion that is beyond the
defined limit.
> ALLOW SOFT LOWER POSITION DETECTION (SLLIMIT) - If Software Left Limit Mask is selected,
then the controller examines the fault and kills the motion that is beyond the defined limit.
The actual number of parameter types and parameters available to you depends on
what you defined in the Axis Architecture and Components steps.
The Adjuster displays values it has calculated in the window of each type. You have the option of
changing these within the limits of valid values.
A complete explanation of each parameter is given in the Tool Tips associated with the
parameter.
For the meanings of the variables see the SPiiPlus Command & Variable Reference
Guide.
Version 3.02 87
SPiiPlus MMI Application Studio User Guide
3. Setup
Motion is considered completed once the position is within a window of TARGRAD user units and
has not exited this window for a period of SETTLE ms.
There are two variables, both optional, for which you can enter values:
> Target Radius (TARGRAD)
> Settling Time (SETTLE)
To aid your understanding a diagram is included showing the meaning of the two variables.
3.2.6.5.2 Enable/Disable/Brake
This window is used for defining the Enable operation and Mechanical Brake timing.
Version 3.02 88
SPiiPlus MMI Application Studio User Guide
3. Setup
You are also informed of the Digital Output variable (OUTx.x) that will contain the state
of brake. Make sure that you include it in your program to test the brake status.
To aid you in determining the values of BOFFTIME and BONTIME you can see diagrams of the effect
these values have by clicking the appropriate tab.
This window enables you to activate (or deactivate) the dynamic brake.
This option is active only for those axes having a built-in drive.
Version 3.02 89
SPiiPlus MMI Application Studio User Guide
3. Setup
This window enables you to specify a digital input (IN) to signal when the motor is in its home
position.
In a SPiiPlus motion controller there is no dedicated Home Switch. You use this Adjuster option to
check a value that you want to be the Home Switch. Once you have completed the Adjuster, and
tested the value (adjusting it as needed), you then have to incorporate the value into your motion
program.
Version 3.02 90
SPiiPlus MMI Application Studio User Guide
3. Setup
The Home Switch can be None or you can select the digital input variable from the Home Switch
dropdown list:
In addition, the user can chose the default homing method from the list shown below.
3.2.6.6 Verification
The Verification step examines the values you have entered and verifies that they are valid.
Verification is performed on the following:
> Feedback devices
> Limit switches
Version 3.02 91
SPiiPlus MMI Application Studio User Guide
3. Setup
3.2.6.6.1 Feedback
Depending on what you defined in Components, the window displays the values for:
> Load
> Motor
If you have defined both Load and Motor as feedback components, there is one page
for Load and one page for Motor.
On this page:
Version 3.02 92
SPiiPlus MMI Application Studio User Guide
3. Setup
The connection sequence of the three Hall Sensors is not important. You only have to verify that
the three Hall sensors are connected and the Hall counter counts 0,1,2,3,4,5 or vice versa. It does
not matter if the Hall counters count opposite to the encoder. This will be identified and taken care
of during Axis Setup and Tuning.
The diagram shows:
> Feedback Position (FPOS) - the position in user units.
Version 3.02 93
SPiiPlus MMI Application Studio User Guide
3. Setup
Those values that can be changed are displayed in bold face. Values that cannot be
changed are grayed out.
3. Click Update in Database and click Next. The Components:Calculate Parameters window is
displayed.
Version 3.02 94
SPiiPlus MMI Application Studio User Guide
3. Setup
3.2.6.6.2 Switches
This window is used for verifying the that actual limit switches are properly connected.
To verify that the switches are properly connected manually move the motor into the switch and
check if the Fault LED turns red.
If it does not turn red, this means that there is something wrong with the switch. Check its
connection and if it is operational.
Fault Detection Settings
You have the options of:
> Enable/disable fault detection (FMASK.#RL for upper limit, FMASK.#LL for lower limit) by
selecting the appropriate check box.
Version 3.02 95
SPiiPlus MMI Application Studio User Guide
3. Setup
If the bit is empty, the controller does not detect the fault.
> Inverting the detection logic (SAFINI.#RL for upper limit and SAFINI.#LL for lower limit) by
selecting the appropriate check box.
Feedback Setting
1. To set the feedback (FPOS) to a particular value:
2. Enter the value in the Set To field.
Click - this resets the position and the Adjuster starts counting from this position.
This window verifies the status of Hardware Emergency Stop and Mechanical Brake.
Version 3.02 96
SPiiPlus MMI Application Studio User Guide
3. Setup
If the bit is empty, the controller does not detect the fault.
> Inverting the detection logic (S_SAFINI.#ES for Hardware Emergency Stop and
SAFINI.#DRIVE for Drive Fault / Laser Fault) by selecting the appropriate checkbox.
The options that are available to you depend on the definitions you entered in
Components.
Version 3.02 97
SPiiPlus MMI Application Studio User Guide
3. Setup
> Manual tuning - The manual tuning process calculates the current loop parameters from a
step response with parameters you set. Manual tuning is optional.
Auto tuning
The calculated current loop parameters are:
> The Proportional Gain (SLIKP)
> The Integrator Gain (SLIKI)
1. To start the auto tuning process, click Start Auto Tuning.
> When the auto tuning process starts, the Start Auto Tuning button changes to
Stop Auto Tuning and the LED next to it flashes "green".
> When the auto tuning process is complete, the LED returns to "gray" and Done
shows to the right of it.
2. When the auto tuning is complete, click Next to go to the next adjustment.
Version 3.02 98
SPiiPlus MMI Application Studio User Guide
3. Setup
During current loop tuning, the motor is enabled and no position or velocity control is
executed. To remove the risk of motor motion due to gravity, do the following:
For motors with mechanical brake, it is necessary to:
1. Set MFLAGS.23 = 0
2. Tune the current loop.
3. When the current loop tuning is complete,set MFLAGS.23=1 to activate the
mechanical brake.
For products that do not have a dedicated mechanical brake output, it is necessary to:
1. Send setconf(29, 0, AANNOO) with an appropriate AANNOO value
2. Tune the current loop.
3. Send setconf(29, 0, AANNOO) with an appropriate AANNOO value.
4. When the auto tuning is complete, click Next to go to the next adjustment.
Fine Tuning
When Auto tuning is complete, a Fine Tuning process can be done. Auto fine tuning is only for
PWM drives with good linear properties. You can do fine tuning for three different types of drives :
> Weak (PWM drives with poor linear properties)
> Normal (PWM drives with good linear properties)
Version 3.02 99
SPiiPlus MMI Application Studio User Guide
3. Setup
4. When the fine tuning is complete, click Next to go to the next adjustment.
Manual Tuning (Optional)
If you select manual tuning, you can set the proportional gain (SLIKP) and the integrator gain (SLIKI).
1. Click the Manual Tuning check box.
2. Enter the values in the applicable field.
When the step response starts, the Check Step Respnse button changes to Stop and
the LED next to it flashes "green".
> Increase the Proportional Gain (SLIKP) until the response waveform approximates a
square and a small overshoot appears, for example:
> Increase the Integrator Gain (SLIKI) by hundreds, until you get a narrow overshoot of
10% to 20%.
6. When you achieve the optimal values, click Stop. Close the Scope.
7. Click Next to go to the next adjustment.
The Current Phase Offset window enables you to verify, and, if needed, adjust the values of the
current phase offset.
Current Phase Offset applies to Analog (±10V) controller-drive interfaces with two or three phase
DC brushless (AC servo) motor connected to an external drive with two drive command inputs (also
known as a UV drive).
Theoretically, the drive should produce zero voltage in the three phases when the controller drive
commands are zero. If, however, the drive outputs have a bias voltage when the controller
commands are zero, this can be corrected with the SLBIASA and SLBIASB variables.
If the external drive is a current drive, it must be connected to the motor while doing the bias
adjustment. If it is a voltage drive, it doesn’t have to be connected.
If the neutral point is not accessible, or the motor is connected in delta, you may create an
“artificial” neutral point by connecting three-phase resistors in parallel to the motor. The 3 resistors
should be identical, in the range of 4-10 kΩ. Then you should measure relative to the artificial
neutral as shown in the following drawing:
3.2.6.7.3 Commutation
The Commutation window enables you to adjust motor commutation and generate a commutation
startup program.
Commutation applies only for DC brushless (AC Servo) motors. It will appear in the
Adjuster tasks only if motors of this type have been defined as part of the system.
The Adjuster Commutation process creates a startup program that is loaded into the
controller which enables the controller to commutate the drive correctly based on the
motor and encoder electrical properties.
For this reason the Adjuster Commutation has to be performed for every new system.
Once it has been performed, whenever a new motor or encoder is introduced into
your system so long as you do not change the type of motor or encoder, you do not
have to perform it again.
SPiiPlus motion controllers support three types of drives for 3-phase DC brushless/AC servo
motors:
> Universal Internal Drive (such as SPiiPlus CM and MC4U drives). Commutation is performed
by the controller as part of its Field-Oriented Control algorithm.
> Two-Input Drive (such as SPiiPlus SA controller or SPiiPlus PCI card with a Sine Wave
Brushless Amplifier). The drive receives two current commands from the controller,
reflecting required current for two of the motor phases. In this case the controller is
responsible for commutation.
> One-Input External Drive (such as a SPiiPlus SA controller with an Analog Input Brushless
Amplifier). This drive receives a single current command from the controller (±10V),
reflecting the required current amplitude, and takes care of the commutation by itself.
Motor commutation requires an initial setup process in which an initial current vector is generated
and the magnetic field of the motor aligns with it (at what is called a detent point). Once the
magnetic field is aligned with the current vector, it is shifted 90o thereby achieving maximum
torque/current ratio.
Since the commutation angle depends on the motor position, the commutation process has to be
done only once for an absolute encoder but after every power-up for incremental quadrature and
Sin/Cos encoders – since the motor position is not known.
Therefore, when working with an incremental encoder and a DC brushless motor, commutation
setup must be executed after every powerup. For this reason you can use Adjuster to generate
and store a Commutation Startup Program.
The Adjuster executes a program that performs Commutation Adjustment setup. The program
supports several commutation schemes (procedures). You select the most appropriate scheme for
your application. In most cases, the commutation scheme will include the following steps:
1. Find a detent point.
2. Identify the phase sequence both of the motor and the encoder.
When the current vector is aligned with the magnetic field during commutation, the
motor can jump. The maximum jump is one magnetic pitch (180 electrical degrees) of
the motor in either direction. If the motor bumps into an obstacle, the commutation
setup algorithm will attempt recovery. The recovery may involve additional abrupt
moves.
When the page is first displayed, Preferences and Advanced Parameters are not
displayed. It is strongly recommended that you expand both and view all the options
available to you.
When initially setting Preferences, you should first use the default values (by clicking
). This will set the commutation parameters in accordance with the settings you
have entered in previous steps of the Adjuster.
Settling
Determines the time assigned to the motor for settling at detent points.
Window Time
In all the schemes except the powerup position scheme, the following
steps are performed:
> Settle at a first detent point.
> Move the current vector to identify the phase sequence.
Automatically correct for wrong polarity.
> If the feedback indicates that the motor has moved less than 50%
of the expected distance, it is assumed to have run into an
obstacle and the program tries to recover in the opposite
Retrieve direction.
Commutation > Retrieve the commutation phase according to the selected
Phase at scheme.
Considerations when selecting a Commutation Scheme:
1. Based on detent point: If the feedback device has no index, this is
the only scheme that can be used. If the feedback device does
have an index it is recommended to use one of the “index”
schemes so that the index can be used as an absolute reference
point for commutation phase retrieval at subsequent powerups.
2. Based on index: Saves the value of the commutation phase at the
index position. This value can be used at subsequent system
Advanced Parameters
Determines the initial value of the commutation phase, and, thereby, the
initial orientation of the current vector and the initial detent point.
Initial By properly setting this offset, you can avoid an initial jump in a system
Commutation with a predefined startup position. For other systems it can be used to
Offset determine a specific target position for the initial jump.
If no information is known about the relationship between the current
vector and the motor position, it should be set to 0 (the default).
Maximum Sets the maximum allowed distance for searching for targets (index or
Search limits). It is recommended to set the variable according to the operational
Distance distance.
Causes the system verify the encoder and motor variables during the
initial commutation process. If the variables seem to be configured wrong,
Verify Control
a general message will be displayed stating that improperly configured
and Feedback
variables are a possible reason for failure. Once corrected, you will be able
Parameters
to continue. In a case of more than 20% deviation between the defined
and measured pitch, the commutation process reports failure.
Display
Detailed
Displays commutation phase data (in electrical degrees).
Commutation
Results
Calculated Hall
Compensates for Improper hall alignment and optimizes torque/force
Alignment
production.
Offset*
Number of A word of caution: Deviation between defined and measured pitch does
Magnetic not necessarily indicate poor commutation quality. For example, incorrect
Pitches to definitions of feedback variables may be compensated for by high friction,
Measure thus the deviation may be low but the commutation will be poor.
*Only available when Hall Signals Transition is the selected option for "Retrieve
Commutation Phase at". This is the default condition if Hall sensors were selected.
2. Select the required buffer for storing the Commutation Startup program from the Run in
Buffer dropdown list (the controller supports up to 9 simultaneously executing program
buffers). Usually, you will want to select an empty buffer to avoid overwriting an existing
program.
3. Set your preferences (see Preferences and Advanced Parameters), or click Default which
will enter default values in the preferences.
4. At this point you have two choices:
The Buffer checkbox should be selected and the buffer number that you
entered in Step 2 should appear. If the program is to be generated from a
user file, select the File checkbox and click to browse for the file. If you
want to use automatic commutation, select the Use Auto-commutation
checkbox.
5. Click Generate. In the Program Manager pod, note that program appears in the specified
buffer, and a notification that the program was successfully generated is displayed.
6. Click Start Startup Program to run the Commutation Startup program.
7. Observe the motion of the motor and the messages that appear in the Commutation
Program Output panel. If errors appear or the motor does not respond as it should, make
adjustments to the parameters and run again - refer to Troubleshooting Commutation.
Commutation Program Output Panel
There are two buttons associated with the Commutation Program Output panel:
> Check the connections between the controller and the drive and motor.
> If a high friction or active load is applied, increase the Excitation Current and try again.
If Start Commutation Program or Start Startup Program execution displays a message about wrong
motor variables, return to Components and verify the following:
> Number of Poles or Magnetic Pitch are specified correctly.
> Encoder variables are specified correctly.
If the motion failed during Commutation Adjustment or Commutation Startup program execution,
probable causes are:
> The required Excitation Current is greater than the minimum of XRMSM value and XRMSD
value. If the motor and drive rating allow it, try to increase this value.
> There is an obstacle in the path of the motion.
Another problem that can arise is the case where Verify Control & Feedback Parameters is not
selected in the Advance Preferences. Inaccurate variables can cause the commutation process to
report successful completion even though the commutation is actually wrong. Therefore it is
recommended to select this field.
Possible reasons for failure of the commutation process:
> Hard stop: motor has bumped into a hard stop or an obstacle and is unable to move.
> Excitation current too low: results in poor field alignment.
> Inaccurate motor and feedback variables.
> Hardware problems, such as encoder or drive fault, wiring error, or bad grounding.
8. When you are done, click Next to go to the next window.
The Open Loop Verification window enables you to check if the motor responds correctly to the
drive command, that is, the motor velocity should be in the same direction as drive command.
Enabling the motor may cause it to jump. To avoid personal injury or damage to the
equipment, check the following before enabling the motor:
> Ensure that nothing (people, cables, or other obstacles) is in the path of the
motor or objects connected to the motor.
> Ensure that the motor is securely anchored and that proper safety barriers,
stops, and limits are installed.
4. Verify that the velocity gauge indicator moves to the right (same direction you moved the
slider). If the velocity arrow moves in the opposite direction, select Invert Drive Command.
If the direction of the velocity gauge is opposite to that of the Drive Output slider, it is
an indication of positive feedback. This is likely to cause a motor run away. If the
direction of the velocity gauge is opposite to that of the Drive Output slider, it is an
indication of positive feedback. This is likely to cause a motor run away.
5. For DC brush motor only: If there is bias (an offset) in the drive (motor moves while the
controller command is zero), then with Driver Output Range set to zero, use the DAC
Offset (SLIOFFFS) field to compensate.
6. When you are done, click Next to go to the next window.
The Position and Velocity Loops window enables you to tune the position and velocity loops in
order to optimize the servo system performance.
To tune the Position and Velocity Loops we recommend using One Parameter Based Tuning as
described below. One Parameter Based Tuning has been tested on several demanding applications
and achieved excellent results.
Experienced control engineers can make use of Manual Tuning or Advanced Tuning.
One Parameter Based Tuning
This feature enables you to tune the system based on a single parameter - the required bandwidth
of the Position loop.
The Adjuster Wizard measures and identifies the characteristics of the electro-mechanical system.
Once identified, you specify the required bandwidth and the Adjuster determines the relevant
servo parameters and gains required to achieve the specified bandwidth.
You can now verify that the system performs as required and is stable by activating a motion and
monitoring the response with the scope. You can modify the bandwidth parameter accordingly
and repeat the process until an optimal time response is achieved.
Afterwards, you can use the FRF to verify that the required bandwidth is achieved and that the
stability margins are adequate.
To perform one parameter tuning:
1. In the Settings and Identification window, select the characteristics of the system in the
System Characteristics section. If unknown, use the defaults.
2. Define start and end motion limits position in the Motion Limits section either by entering
values or by clicking the Read buttons. Ensure that the values are adequately distanced
from the actual travel limits.
In case of an encoder fault, the motion limits will be zeroed by default. After the fault is
cleared, entering new values may be required.
5. When the system identification is successful, click Next to continue to the next step.
If the system identification is not successful, follow the recommendations under System
Identification Results. If you were not able to identify the system, only Manual Tuning is
available in the Basic Tuning window.
9. When you achieve a satisfactory bandwidth, click Next to continue to the next step.
10. In the Bandwidth and Stability Verification window, click Start Verification.
11. Click Yes to the following warning messages.
The Bandwidth and stability verification is based on FRF closed loop measurement and comparing
the measured stability gains to the predefined thresholds. The measured bandwidth is also
compared to the required one.
> If the verification is unsuccessful, follow the recommendations under the Verification
Results section.
You may need to return to the Basic Tuning window and repeat the process described
in Step 6.
> If the verification is successful, you can click Next to Advanced Tuning.
Advanced tuning is optional and requires experience in Control field.
Manual Tuning
Manual tuning involves tuning controller parameters in the Basic Tuning window. You can modify
each parameter during a motion in both Velocity Loop mode and Position and Velocity Loop mode.
Available parameters are:
> Velocity loop Proportional gain (SLVKP) - in both servo loop modes
> Velocity loop Integrator gain (SLVKI) - in both servo loop modes
> Position loop Proportional gain (SLPKP) - only in Position and Velocity Loop
> Low pass filter bandwidth (SLVSOF) - in both servo loop modes
> Acceleration Feed-Forward (SLAFF) - only in Position and Velocity Loop
To perform manual tuning:
1. In the Basic Tuning page, click Motion Manager Autoset.
The Motion Manager is displayed.
2. Click Enable Motor(s) and then Start Motion.
3. Click Scope Autoset and monitor the scope:
Change the relevant controller parameters values as long as position error improves and
stability is maintained.
The ideal Scope display is a square wave indicating that the Position and Velocity Loop is
well adjusted.
4. When you achieve a satisfactory bandwidth, click Next to continue to the next step.
5. In the Bandwidth and Stability Verification page, click Start Verification.
The Bandwidth and stability verification is based on FRF closed loop measurement and
comparing the measured stability gains to the predefined thresholds.
> If the verification is unsuccessful, follow the recommendations under the Verification
Results section.
You may need to return to the Basic Tuning page and repeat the process described in
Step 3.
> If the verification is successful, you can click Next to Advanced Tuning.
Advanced tuning is optional and requires experience in Control field.
Advanced Tuning
Use the Advanced controller parameters tuning for further improvements.
1. To tune the filters (Notch, BiQuad or Low-Pass) select Filters.
If the verification measurement was successfully completed then the FRF component will
be opened with already existing measurement.
Otherwise, measure the FRF of the Position and Velocity loop; We recommend to move
the motor slowly in constant velocity during the measurement (1 revolution/sec for rotary
motor, or a few mm/sec for linear motor).
By default, Open Motion Manager is selected for that purpose.
2. Click Design to open the design mode and tune the filters.
When the Design FRF is satisfactory, click Finish and choose yes in the message asking to
save the design parameters to the controller.
Then, measure the FRF again to verify it is close to the design.
3. To tune other controller parameters, select Algorithms, then open the required servo
variables group and click Motion Manager & Scope to open the Motion Manager and Scope.
4. In the Motion Manager, apply a required motion, monitor the Scope and modify the
controller parameters as needed.
5. When you achieve satisfactory results, the tuning is finished. Click Next to continue to the
next step to finish the adjustment.
The Position Verification window is relevant only for open loop modes for step motors and enables
you to verify that the actual move corresponds to a commanded one, and make changes where
necessary.
The Motion Type dropdown list gives you the option of defining the type of motion, the options
are:
> One Direction Repeated Move
> Back and Forth Move (Default)
If you select One Direction Repeated Move, you specify how much movement by entering a value
in Move By.
If you select Back and Forth Move, the position is measured between two points:
> Point A
> Point B
Point A is the start position and Point B is the end position. The motion is then measured
from Point A to Point B.
You can set these points by manually moving the motor to Point A and clicking ,
and repeating this for Point B.
You can change the sign of the value by clicking
1. Click , this enables the motor of the axis you are working on.
If you do not save the data to the controller’s flash, all of the data will be lost.
Once you have saved the data, the Final Page is displayed. This marks the completion of the
Adjuster. Click Finish to exit.
Although you can perform this task before performing Setup New System or
Controller, it is not recommended.
1. In the Adjuster Select Task window, select Adjust Tuning of Predefined System.
The Axis Setup and Tuning step enables you to fine tune your system. There are a total of six
possible options:
1. Current Loop
2. Current Phase Offset
3. Commutation
4. Open Loop Verification
5. Position and Velocity Loops
6. Position Verification
The options that are available to you depend on the definitions that were entered in
Components during the performance of Setup New System or Controller
You can skip steps either by clicking Next, or by clicking the step in the Task Steps list
that you want to activate:
In the same manner you can return to previous task steps by clicking Back or clicking
the required step in the Task Steps list.
7. Once you have tuned your values to your satisfaction, you move to Save to Flash.
8. After saving the values to the controller’s flash, click Finish to exit the Adjuster Wizard.
In this task you verify that the settings are correct for:
> Motion Parameters Limits
> Current Limits
> Position Errors
> Position Limits
In the event that you find an incompatibility, this task provides you with the ability to make
changes.
You can skip steps either by clicking Next, or by clicking the step in the Task Steps list
that you want to activate:
In the same manner you can return to previous task steps by clicking Back, or clicking
the required step in the Task Steps list.
3. The next task is Miscellaneous Definitions. In this task you check the values for:
> Motion Completion
> Enable/Disable/Brake
> Dynamic Brake
> Home Switch
4. The next task is Verification. In this task you check the values for:
> Feedback
> Switches
> Stop, Alarm and Brake
5. The next task is Axis Setup and Tuning. In this task you check the values for:
> Current Loop
> Current Phase Offset
> Commutation
> Open Loop Verification
> Position and Velocity Loops
> Position Verification
The options that are available to you depend on the definitions that were entered in
Components when running Setup New System or Controller.
6. Once you have checked the values, and tuned them, if needed, you move to Save to Flash.
7. After saving the values to the controller’s flash, click Finish to exit the Adjuster Wizard.
2. Select the Source Axis. By default the source axis is the working axis.
3. Select the Target Axis and click Next.
The Wizard prompts you to Save to Flash the source axis (the Wizard copies only data that
is saved to the controller flash). When the duplication is completed, the Wizard presents
the results in the Progress and Results substep.
4. Click Next to complete the Adjuster Wizard and then click Finish to close the wizard.
You should run the automatic system setup on initialization and whenever the system
is changed.
The screen shown shows representative output of the automatic system configuration process:
5. When the Configuration Design Pad window appears, you can modify settings such as the
axes and I/O allocations:
9. To save the configuration to the controller or to the database, select the required option
under Save and click Save.
10. In the Configuration Details window, enter a name for the configuration and optionally
enter additional information.
7. In the CONFIGURATION DETAILS window, enter a name for the configuration and optionally
enter additional information.
8. Click OK.
9. When the configuration has been saved to the controller, click OK to close the progress
report window.
> A – DDM3U-2-60V-2A
> B – DDM3U-1-320V-5A
> C – DDM3U-1-320V-10A
> D – DDM3U-1-320V-20A
> E – DDM3U-1-560V-2A
> F – DDM3U-1-560V-5A
> G – DDM3U-1-560V-10A
> H – DDM3U-1-560V-15A
> K - DDM3U-1-320V-45
> M - DDM3U-1-320V-30
> S – DDM3U-2-680V-2A
> T – DDM3U-2-680V-5A
> U – DDM3U-2-680V-10A
> V – DDM3U-2-680V-15A
> W – DDM3U-4-60V-2A
> Wa - DDM3U-4-60V-4A
> W1 - DDM3U-4-320-1A
> W2 - DDM3U-4-320-2A
> W3 - DDM3U-4-320-3A
> X – DDM3U-2-320V-5A
> Y – DDM3U-2-320V-10A
> Z – DDM3U-2-320V-20A
> Pa – LDM3U-55V-8A (Analog)
> Pd – LDM3U-55V-8A (Digital)
> Ps – LDM3U-55V-8A (Space Vector Modulation)
> Ra – LDM3U-55V-16A (Analog)
> Rd – LDM3U-55V-16A (Digital)
> Rs – LDM3U-55V-16A (Space Vector Modulation)
E – Total number of Sin-Cos multipliers (optional), which can be:
> 1
> 2
> 3
> 4
> 5
> 6
> 7
> 8
F – Number of 2.5 MHz Sin-Cos multipliers (optional), which can be:
> 1
> 2
> 3
> 4
When included, E must also be included as F represents the number of 2.5 MHz Sin-Cos
multipliers out of the total number of Sin-Cos multipliers, for example, 63 which means
there is a total of 6 Sin-Cos multipliers, of which 3 are 2.5 MHz Sin-Cos multipliers.
The code string consists of a maximum of 15 characters, beginning with: MC4U. In the
event that the string exceeds 15 characters, the leading MC4U can be shortened or
omitted completely.
Properties
On the product property panel of each member of optional group the following information is
presented:
Included in group(s) [R/O] <i, j, k, … > where i, j, k are including groups’ IDs, i ϵ j ϵ k
To stop highlighting the optional group user selects either “Undo highlighting optional group” from
the right click menu, or highlights another optional group. Only one optional group can be
highlighted at the same time.
The initial state of the check box depends on the task you are performing:
> Modify Configuration Stored on Controller - the check box will be according to the
controller current activation state.
> Modify Configuration from Database and Load Configuration from Database to
Controller - the check box will be according to EtherCAT configuration file of the
selected configuration.
If Enhanced Network Failure Detection and Recovery is not enabled in the controller:
> Automatic Setup - the ring topology connection is deactivated in controller.
> Manual Setup - in the Configuration Design Pad, the relevant check box is not selected and
cannot be changed.
You can also activate the Safety and Faults Configurator using the right-click Add
Component option of the Workspace Tree - see Controller Right-Click Options .
The System and Faults Configurator window is divided into two sections:
Axis Faults
System Faults
3.4.2.1.1 SAFINI
SAFINI is a 64 member (one for each axis) integer array with a set of bits defining the active state of
the axis safety input variable (SAFIN) specifying inversion of the signal input logic, if required.
When a SAFINI bit=0, the corresponding signal is not inverted and the high voltage state is
considered active.
When a SAFINI bit=1, the bit is inverted and the low voltage state is considered active.
The SAFINI bits that can be inverted are:
Bit
Bit Description
Name
Bit
Bit Description
Name
3.4.2.1.2 FMASK
FMASK is an integer array with a set of bits (one set for each axis) used for enabling or disabling
each axis fault bit.
The default value of each bit is 1 and causes the controller to check for the fault associated with
that bit, as follows:
0 = the corresponding FAULT bit is disabled.
1 = the corresponding FAULT is enabled and examined each MPU cycle.
The FMASK bits are:
Network Error
2 #NT 1 = Network error is activated. This applies on to SPiiPlus NT Motion
Controllers.
Motor Overheat
4 #HOT
1 = Motor's temperature sensor indicates overheat.
Encoder Error
10 #ENC
1 = Primary encoder miscounts.
Encoder 2 Error
11 #ENC2
1 = Secondary encoder miscounts.
12 #PE ERRV - Maximum position error while the axis is moving with constant
velocity
ERRA - Maximum position error while the axis is accelerating or
decelerating
DELI - Delay on transition from ERRA to ERRI
DELV - Delay on transition from ERRRA to ERRV
Velocity Limit
14 #VL 1 = Absolute value of the reference velocity (RVEL) exceeds the limit
defined by the XVEL parameter.
Acceleration Limit
15 #AL 1 = Absolute value of the reference acceleration (RACC) exceeds the
limit defined by the XACC parameter.
Current Limit
16 #CL 1 = RMS current calculated in the Servo Processor exceeds the limit
value defined by the XRMSD or XRMSM parameter.
3.4.2.1.3 FDEF
FDEF is a 64 member (one for each axis) integer array with a set of bits used for setting default
responses to an axis faults.
The FDEF bits are:
Network Error
Disable all. Valid only for SPiiPlus NT Motion
2 #NT 1 = Network error is Controllers.
activated.
Motor Overheat
Encoder 2 Not
8 #ENC2NC No default response.
Connected
1 = Secondary encoder
(for digital encoder
type only) is not
connected.
Encoder 2 Error
11 #ENC2 1 = Secondary encoder Same as #ENC.
miscounts.
Non-Critical Position
Error
1 = Non-critical position
error has occurred.
PE is defined by the
following variables:
ERRI - Maximum
position error while the
axis is idle
12 #PE None.
ERRV - Maximum
position error while the
axis is moving with
constant velocity
ERRA - Maximum
position error while the
axis is accelerating or
decelerating
DELI - Delay on
transition from ERRA to
ERRI
DELV - Delay on
transition from ERRA to
ERRV
Velocity Limit
1 = Absolute value of
14 #VL the reference velocity The controller kills the violating axis.
(RVEL) exceeds the
limit defined by the
XVEL parameter.
Acceleration Limit
1 = Absolute value of
the reference
15 #AL acceleration (RACC) The controller kills the violating axis.
exceeds the limit
defined by the XACC
parameter.
Current Limit
1 = RMS current
calculated in the Servo
16 #CL Processor exceeds the The controller disables the violating axis.
limit value defined by
the XRMSD or XRMSM
parameter.
Safe Torque Off Blocks the PWM signals to the power stage
18 #STO
1 = STO is activated. of the drive.
3.4.2.1.4 FAULT
FAULT is a 64 member (one for each axis) integer array with a set of bits that stores axis-related
fault bits.
FAULT indicates axis-related fault bits as detected by the safety mechanism. When each of the
faults is active (such as Left Limit), the corresponding fault bit becomes = 1 while the fault is active,
and automatically reverts to 0 when the fault is no longer active.
Each fault can be masked by FMASK.
The logic of some faults can be inverted by SAFINI.
The default response of each fault can be disabled by FDEF. In this case, any customized default
response can be implemented by autoroutines.
The FAULT bits are:
Network Error
2 #NT 1 = Network error is activated. Valid only for SPiiPlus NT Motion
Controllers.
Motor Overheat
4 #HOT
1 = Motor's temperature sensor indicates overheat.
Encoder Error
10 #ENC
1 = Primary encoder miscounts.
Encoder 2 Error
11 #ENC2
1 = Secondary encoder miscounts.
#CPE errors occur outside normal range of operation and #CPE > #PE.
The critical limit depends on the axis state and is defined by the
13 #CPE following variables:
CERRI if the axis is idle (not moving)
CERRV if the axis is moving with constant velocity
CERRA if the axis is accelerating or decelerating
DELI - Delay on transition from ERRA to ERRI
DELV - Delay on transition from ERRA to ERRV
Velocity Limit
14 #VL 1 = Absolute value of the reference velocity (RVEL) exceeds the limit
defined by the XVEL parameter.
Acceleration Limit
15 #AL 1 = Absolute value of the reference acceleration (RACC) exceeds the
limit defined by the XACC parameter.
Current Limit
16 #CL 1 = RMS current calculated in the Servo Processor exceeds the limit
value defined by the XRMSD or XRMSM parameter.
3.4.2.2.1 S_SAFINI
S_SAFINI is a scalar integer variable used for defining the active state of the system safety input
variable (S_SAFIN) specifying inversion of the signal input logic, if required.
When an S_SAFINI bit=0, the corresponding signal is not inverted and the high voltage state is
considered active.
When an S_SAFINI bit=1, the bit is inverted and the low voltage state is considered active.
There is only one S_SAFINI bit that can be inverted:
3.4.2.2.2 S_FMASK
S_FMASK is scalar integer variable consisting of a set of bits for enabling or disabling the system
faults contained in S_FAULT. S_FMASK is connected to S_FAULT in the same way that FMASK is
connected withFAULT.
The S_FMASK bit default values are 1 which cause the controller to check for the fault associated
with that bit, as follows:
> 0: The corresponding S_FAULT bit is disabled
> 1: The corresponding S_FAULT is enabled and examined each MPU cycle.
The S_FMASK bits are:
Program Fault
25 #PROG
1 = Run time error occurs in one of the executing ACSPL+ programs.
Memory Overflow
26 #MEM
1 = User application requires too much memory.
MPU Overuse
27 #TIME
1 = User application consumes too much time in the controller cycle.
Servo Interrupt
29 #INT 1 = The servo interrupt that defines the controller cycle is not
generated. The fault indicates a fatal controller problem.
File Integrity
30 #INTGR 1 = The integrity of the user application in controller RAM is checked by
the controller at power-up and whenever an #IR command is issued.
Component Failure
31 #FAILURE 1 = An MC4U hardware component other than the drive, such as the
Power Supply, I/O card, or encoder card, has failed.
3.4.2.2.3 S_FDEF
S_FDEF is a scalar integer variable consisting of a set of bits for defining the default response for
the system faults contained in S_FAULT. S_FDEF is connected to S_FAULT in the same way that FDEF
is connected with FAULT.
The default value for all S_FDEF bits is 1, which enables the default response. If an S_FDEF bit = 0,
the default response is disabled.
The S_FDEF bits are:
Program Fault
The controller kills all
25 #PROG 1 = Run time error occurs in one of the axes.
executing ACSPL+ programs.
Memory Fault
The controller kills all
26 #MEM 1 = User application requires too much axes.
memory.
MPU Overuse
27 #TIME 1 = User application consumes too much No default response.
time in the controller cycle.
Servo Interrupt
1 = The servo interrupt that defines the The controller disables
29 #INT
controller cycle is not generated. The fault all axes.
indicates a fatal controller problem.
File Integrity
1 = The integrity of the user application in
30 #INTGR controller RAM is checked by the No default response
controller at power-up and whenever an
#IR command is issued.
No default response
Component Failure
You are responsible for
31 #FAILURE 1 = An MC4U hardware component other
incorporating a user-
than the drive, such as the Power Supply,
defined response into
I/O card, or encoder card, has failed.
your program.
3.4.2.2.4 S_FAULT
S_FAULT is a scalar integer variable consisting of a set of bits equating to the occurrence of System
Faults (faults that are not related to any specific axis).
The S_FAULT bits are:
The S_FAULT variable contains bits related to Axis Faults, but only the System Fault bits
are relevant to the Safety and Faults Configurator.
Program Fault
25 #PROG
1 = Run time error occurs in one of the executing ACSPL+ programs.
Memory Fault
26 #MEM
1 = User application requires too much memory.
MPU Overuse
27 #TIME
1 = User application consumes too much time in the controller cycle.
Servo Interrupt
29 #INT 1 = The servo interrupt that defines the controller cycle is not
generated. The fault indicates a fatal controller problem.
File Integrity
30 #INTGR 1 = The integrity of the user application in controller RAM is checked by
the controller at power-up and whenever an #IR command is issued.
Component Failure
31 #FAILURE 1 = An MC4U hardware component other than the drive, such as the
Power Supply, I/O card, or encoder card, has failed.
Some bit selections are dependent on your selecting other bits. For example, there is a
connection between FMASK and FDEF, when you select a bit in FMASK, this makes the
corresponding bit in FDEF available for selection.
Indication
The symbols in the Indication column act like LEDs and indicate:
No fault.
Fault detected.
Not applicable.
Action Buttons
The Safety and Faults Configurator has the following action buttons:
Saves the data to the controller’s flash memory and closes the
window.
4. Application Development
Application Development contains the following tools for use in programming your SPiiPlus Motion
Controller:
> Application Wizard - enables you to manage the controller program files, such as loading
applications parameters, saving the parameters, copying files to the controller, and the
like.
> Program Manager - your principal tool for programming your SPiiPlus Motion Controller.
> Protection Wizard - enables you to define the controller protection mode parameters,
modify the protection mode parameters, and view the protection status.
You can also activate the Application Wizard using the right-click Add Component
option of the Workspace Tree - see Controller Right-Click Options.
In the Configuration Parameters column you can see default axis assignment (which axis in
the loaded application is assigned each axis in the controller).
5. To change the default assignment, click next to the required axis or axes and clear the
destination axis.
This lets you assign the destination axis with a different source axis.
6. Click OK.
7. Click next to any axis and assign the axis that you unassigned in the previous step.
In this way, you can assign any axis from the loaded application to any axis or axes in the
controller.
8. You can preview the data loading from the file. Select Show preview of selected item.
9. To check or uncheck all options in the grid column, click the checkbox in the column
header.
> The wizard first saves the configuration data to the controller’s flash.
> It then saves the data from the controller’s flash to the selected file.
You have the option of saving some or all of the application data by selecting or
deselecting the checkbox ( ) in the column header.
4. Click Browse to select where the application data is to be saved. A browse window is
displayed:
5. Select the directory, and enter a file name in the File name field. Click Open. You are
returned to the Configure Saving window.
6. You can determine what data to be saved by selecting or deselecting the checkbox ( ) in
the column header.
By default the SP column is not selected. If you want to save the SP data as well, select
the column. You are advised:
Normally you will want to save SP data only if the SP programs have been customized;
however, you can save it in any case by clicking Yes.
7. You can view any data in the controller application by selecting the item and clicking Show
preview of selected item, for example:
9. To save the report click Save Report. The browser window is displayed:
3. Click Browse and select the file for importing from the list that is displayed. Then click
Open.
4. You may preview the data of the selected array file by selecting Show preview.
Once you have entered the variable name, the data type is automatically displayed.
You have the option of selecting only a portion of the array by entering the range using Row
Range and ColumnRange, as appropriate.
3. You have the option of saving the log to a file by clicking Save Report which opens a dialog
window:
4. Use the browse window to select the directory, and, if applicable, a file name.
5. Click Save.
You can type a name in the File name field to create a new file.
Once you have entered the variable name, the data type is automatically displayed.
> You have the option of selecting only a portion of the array by entering the range
using Row Range and ColumnRange, as appropriate.
> The current format of the output data is displayed in the Format field. You have the
option to change output format by clicking Change Format.
> Select the required notational format from the Format dropdown list. Where needed,
change the Width and/or Precision. Click Apply.
You can transpose the array elements by selecting Transpose, for example, if a matrix
has m rows and n columns, selecting Transpose causes it to be saved as a matrix having
n rows and m columns.
You also have the option of viewing the current values of the array elements by
clicking Show Preview.
3. You have the option of saving the log to a file by clicking Save Report which opens a dialog
window:
3. You select the required file(s) either by pressing Ctrl and clicking the files for selecting
individual files, or select a file and press Shift to select a range of files.
You can view the contents of a file by selecting the file and then clicking Show Preview.
4. To delete selected files, click Delete Selected. Or click Delete All to remove all of the files in
the controller flash.
You can also delete a file by clicking under the delete column in the file's row.
3. Click Browse and select the file for copying from the list that is displayed. Then click Open.
4. Select the controller’s path from the Destination Path dropdown list.
5. Click Next to start the copying process. You are prompted by:
6. Click OK to start the copying process and wait for the conclusion of the process as indicated
in the Copying window:
7. You have the option of saving the log to a file by clicking Save Report which opens a dialog
window:
3. Select the Destination Path of the file you want to delete from the dropdown list.
6. You have the option of saving the log to a file by clicking Save Report which opens a dialog
window:
Once your programs are running properly, it is highly recommended that you save the
contents of the buffers to the controller’s flash memory (see Saving to Flash). In the
event of a loss of electricity, your programs will be restored to the controller’s buffers
upon restart. Not doing this will result in the loss of your programs.
You can also activate the Program Manager using the right-click Add Component
option of the Workspace Tree - see Controller Right-Click Options .
> Buffer Functions - these functions are associated with various buffer actions.
> Buffer Program Functions - these functions are associated with various buffer program
actions.
4.3.2.1 Select
The Select column indicates:
You select a buffer by clicking the icon. You can select any and all buffers with the exception of
Unused buffers.
4.3.2.2 Open
The icons in the Open column indicate if a buffer is open or not:
Buffer is open.
Buffer is closed.
They also indicate if the buffer is in the Protected mode, for example:
Read-Only - the program in the buffer can be viewed, but cannot be changed.
4.3.2.3 Status
The Buffer Status column displays the current status of the buffer. There are four indications
associated with the Status:
When you click this option, the motors start to move. Also, some of the
limits and safety features may be temporarily disabled. To avoid personal
injury or damage to the equipment, check the following before clicking
the button:
> Ensure that nothing (people, cables, or other obstacles) is in the path of
the motor or objects connected to the motor.
> Ensure that the motor is securely anchored and that proper safety
barriers, stops, and limits are installed.
Step Buffer - executes the command where the cursor is currently sitting. Once
executed, the cursor moves down one line.
Pause Buffer - temporarily halts program running in the buffer. The program can be
restarted byRun Buffer.
Stop Buffer - halts the program running in the buffer. The program can be rerun
byRun Buffer.
Copy Buffer - puts contents of the buffer into the clipboard so they can be copied
into another buffer.
Disable Autorountine - disables any autoroutine that is in the buffer. When selected
it changes to Enable Autoroutine in Buffer, which you can select to reenable the
autoroutine in the buffer.
Apply changes - applies any changes you have made in the D-Buffer.
Load from File - loads the contents of a program file that has been
previously saved into the buffer.
The total number of buffers that you can select depends on the
controller. Once you have selected the number, it is stored as part of
the Workspace data.
Warning
When you click this button, the motors start to move. Also, some of the limits and
safety features may be temporarily disabled. To avoid personal injury or damage to
the equipment, check the following before clicking the button:
l Ensure that nothing (people, cables, or other obstacles) is in the path of the
motor or objects connected to the motor.
l Ensure that the motor is securely anchored and that proper safety barriers,
stops, and limits are installed.
Step Buffer(s) - executes the command where the cursor is currently sitting for
the selected buffers. Once executed, the cursor moves down one line.
Stop Buffer(s) - halts program(s) running in the selected buffers. The program(s)
can be rerun by clicking Run Buffer(s).
Stop All Buffer(s) - halts all running programs. The programs can be rerun by
clicking Run Buffer(s).
Remove All Breakpoints in Buffer(s) - removes all breakpoints that have been set
in the selected buffers.
Trigger Scope - triggers the display of the signals from the running program.
Toolbar
The Buffer Editor toolbar contains the following:
Undo - undoes any changes made and restores the previous contents.
Same as pressing Ctrl+Z.
Cut - deletes the selected contents and places it in the clipboard. Same as
pressing Ctrl+X.
Copy - places the selected contents into the clipboard. Same as pressing
Ctrl+C.
Paste - pastes the contents of the clipboard into the buffer at the cursor
position. Same as pressing Ctrl+V.
When you click this option, the motors start to move. Also,
some of the limits and safety features may be temporarily
disabled. To avoid personal injury or damage to the
equipment, check the following before clicking the button:
> Ensure that nothing (people, cables, or other obstacles) is in
the path of the motor or objects connected to the motor.
> Ensure that the motor is securely anchored and that proper
safety barriers, stops, and limits are installed.
Step - executes the command where the cursor is currently sitting. Once
executed, the cursor moves down one line. Same as pressing F9.
Run to Cursor - executes the program from the start of the program up
to the line where the cursor sits.
Start From - executes the program from the line where the cursor is
sitting.
Remove All Breakpoints - removes all breakpoints that have been set.
Find & Replace - activates a search for a user-entered string, and replaces
it with another user-entered string.
Workspace
Used for typing in the program commands.
Status Line
The Status Line provides the status of the program in the buffer. There are four colors associated
with the Status:
> White - the buffer is empty.
> Yellow - the program in the buffer has been successfully compiled but is not running.
> Green - the program in the buffer is running (the current line in the program that is being
executed is displayed as the program runs).
> Red - an error has been detected in the program in the buffer (the error number, line
number, and a brief description of the error of the first error to be detected is displayed).
Cursor Position
Informs you of exactly where in the program the cursor sits.
You can view the value of a variable in the program by letting the mouse pointer linger
on the variable. Variables of any type - ACSPL+, user-defined, scalar, arrays (the first 30
elements) - can be viewed.
3. Click Compile ( ) or press Ctrl+F5. Check the Status Line that the program compiled
successfully.
Any work made within a buffer window is stored locally within the MMI workspace. It is
only written to the controller upon compilation (even if compilation fails).
If there is an error in your program, the Status Line provides the error number, the line
number in which the error is detected, and a brief description of the error. Refer to
Chapter 6 of the SPiiPlus Command & Variable Reference Guide for details of errors.
Axes and global variables defined in D-Buffer are not required to be defined in other buffers
before use. However, such redefinition is not an error, if all the attributes of the definitions are
identical.
To program D-Buffer:
1. In Program Manager click Open Buffer ( ) of D-Buffer (or click its Status Line). The D-Buffer
is displayed:
D-Buffer differs from other buffers in that it contains default contents. Other buffers
are empty, by default, but the default contents of D-Buffer contain a set of definitions
that provides compatibility with previous Firmware versions.
Undo - undoes any changes made and restores the previous contents.
Same as pressing Ctrl+Z.
Cut - deletes the selected contents and places it in the clipboard. Same as
pressing Ctrl+X.
Copy - places the selected contents into the clipboard. Same as pressing
Ctrl+C.
Paste - pastes the contents of the clipboard into the buffer at the cursor
position. Same as pressing Ctrl+V.
Find & Replace - activates a search for a user-entered string, and replaces
it with another user-entered string.
2. Click Browse to search for the file (when found, select the file).
3. Click OK, the Load Program dialog window displays the default buffer location of each
program contained in the selected file, for example:
You can reassign the buffer location by clicking the Buffers field of the program and selecting the
buffer from the list:
You can load the same program into more than one buffer.
For controllers set to the Protected mode, if a buffer is tagged with (Hidden buffer)
or (Read-Only buffer), you cannot load a program into it.
You can load a program for the D-Buffer only into the D-Buffer.
4. Click OK.
1. In Program Manager click Save to File ( ), the Save Buffers dialog window is displayed:
3. Drill down to the directory into within which you want to save your program files, and
either select an existing file (for overwriting), or enter a new file in File name and click
Save. You return to the Save Buffers dialog window.
4. Select the buffers you want to save in Buffer Tree.
For controllers set to the Protected mode, if a buffer is tagged with (Hidden
buffer), you cannot save it to a file.
5. Click Save.
For controllers set to the Protected mode, if a buffer is tagged with (Hidden
buffer) or (Read-Only buffer), you cannot clear a program from it.
3. Click Clear.
You can also make use of the popup menu that appears when you right-click the
buffer Status Line (see Status Right-Click Menu).
1. In Program Manager click Copy buffers ( ), the Copy Buffers dialog window is displayed:
For controllers set to the Protected mode, if a buffer is tagged with (Hidden
buffer), you cannot copy the file. However if the buffer is tagged with (Read-Only
buffer), it can be copied into another buffer so long as the destination buffer is not
Read-Only.
You can also make use of the popup menu that appears when you right-click the
buffer Status Line (see Status Right-Click Menu).
The Status Line in the Buffer Editor Window indicates Suspend. If an error is detected, it
turns red.
3. Continue clicking Step Buffer until you have reached the end of the program.
You can stop the program at any point and reset it by clicking Stop ( ) or pressing
Shift+F5.
You can also make use of the popup menu that appears when you right-click the
buffer Status Line (see Status Right-Click Menu).
The Status for each selected buffer turns green (indicating that the program is running
in them) and the line number of the next command is displayed.
If an error is detected in any of the buffers, the buffer’s status turns red and the program
line number of the error is displayed.
3. Continue clicking Step Buffer(s) until you have reached the end of the programs.
You can stop the programs at any point and reset them by clicking Stop Buffer(s) ( ).
You can set as many breakpoints as you want. Once you have set the breakpoints, you can
run the program (see Running/Stopping Buffer Programs). It will run up to the line
containing the breakpoint, and then pause. When you execute it again, it will run from this
line to the next breakpoint.
Removing Breakpoints
To remove breakpoint:
4. In Program Manager click Open Buffer ( ).
5. Scroll down to the line where the breakpoint is set (indicated by the red ball).
Click Remove Breakpoint ( ). The red ball indicated that a breakpoint has been set for line is no
longer displayed.
You can remove all of the breakpoints by clicking Remove All Breakpoints in Buffer ( ).
For example, if PRATE is set to 1 for a buffer, but ONRATE is set to 4, the program in the
buffer will be executed one line per one controller cycle, and any autoroutine specified
in buffer that interrupts the program will be executed four lines per one controller
cycle. When the RET command that terminates the autoroutine is executed, the
controller switches back to the rate of one line per one cycle.
2. For each buffer enter the required PRATE and ONRATE values, as appropriate, and click
Close.
If you have changed any of the values, the following prompt appears:
If you want to save the changes to the SPiiPlus Motion Controller flash (recommended), click Yes.
The Save to Flash window is displayed (note that System is selected):
3. Enter:
4. Click Save.
Run Buffer(s) causes the motors to move. Also, some of the limits and safety features
may be temporarily disabled. To avoid personal injury or damage to the equipment,
check the following before running the program:
Ensure that nothing (people, cables, or other obstacles) is in the path of the
motor or objects connected to the motor.
Ensure that the motor is securely anchored and that proper safety barriers,
stops, and or limits are installed.
If you are working in the Buffer Editor, you can use Run or pressF5to run the
program.
To stop programs:
1. In Program Manager select the buffer in the Select column
2. Click Stop Buffer(s) ( ).
For Pause Buffer and Stop you can also make use of the popup menu that appears
when you right-click the buffer Status Line (see Status Right-Click Menu).
To stop all programs that are running click Stop All Buffer(s) ( ).
If you are working in the Buffer Editor, you can use Pause or pressCtrl+P to pause the
program, and Stop or press Shift+F5 to stop the program.
You can also activate the Protection Wizard using the right-click Add Component
option of the Workspace Tree - see Controller Right-Click Options.
3. Select the task you want to perform by clicking the appropriate button and then click Next.
If the controller is in the Not Protected mode, the only task available is Define
Protection.
If the controller is in the Protected mode, the tasks available are: Update Protection,
Remove Protection, and View Protection Status.
This task, and this task only, is available if the controller is in the Not Protected mode.
1. Since this is the only task available, click Next. The Set Protection Level window is
displayed.
There are three tasks that can be performed from the Select Protection Level window:
> Application Protection
> You perform this task to set the program in the specified buffers to Read Only, that is, it
can be viewed but cannot be modified.
> Intellectual Property Protection
> You perform this task to set the program in the specified buffers such that its contents
cannot be modified and cannot be seen.
> Custom Protection
> There are three tasks that can be performed from the Custom Protection window:
> You can set the program in the specified buffers such that its contents cannot be
modified and/or cannot be seen.
> You can set specified variables to Read Only, that is, it can be viewed but cannot be
modified.
> You allow the system to be reconfigured.
By selecting the Prevent from editing checkbox you set the program in the buffer to
Read Only, that is, it can be viewed but cannot be modified.
3. Check that the proper Protections are set. If they are, select Accept Changes. Click Next.
The Set Password window is displayed.
4. If you want to set a user password to prevent unauthorized personnel from removing
Protection, type it into the Enter password and Confirm password fields.
5. Click Next. The controller is rebooted. Wait for the notification of a successful restart.
The controller must be restarted, otherwise the protected programs can become
corrupted.
6. Click OK.
The Report window is displayed.
7. To save the report click Save report. The browser window is displayed:
By selecting the Prevent from editing and viewing checkbox, you set the program in
the specified buffers such that its contents cannot be modified and cannot be seen.
2. Click Next to preview changes and follow step 3 through step 10 in Setting Application
Protection to complete setting protection and to exit the Protection Wizard.
1. To set Custom Protection, select the button next to Custom Protection. Then click Next.
The Buffers Protection task is displayed.
By selecting the Custom Protection checkbox, you set the program in the specified
buffers such that its contents cannot be modified and/or cannot be seen.
1. Select the appropriate Read only box to prevent the variables from being edited.
You can either set all the variables in a group by selecting the Read only box, or expand
the groups by clicking the tree expansion button: and marking individual variables for
read only.
3. You have the option of changing the Protection by selecting the appropriate buttons:
> To change Application Protection settings, select the button next to Application
Protection. Then click Next and follow the procedure described in Setting Application
Protection.
> To change Intellectual Property Protection settings, select the button next to Intellectual
Property Protection. Then click Next and follow the procedure described in Setting
Intellectual Property Protection.
> To change Custom Protection settings, select the button next to Custom Protection. Then
click Next and follow the procedure described in Setting Custom Protection.
In the selected protection task, you enable protection or cancel an existing Protection
To remove Protection:
1. Select Remove Protection in the Select a Task window.
4. Enter the password and click Next. The following dialog appears
6. Click OK
7. Wait for the appearance of a successful restart message:
9. To save the report click Save report. The browser window is displayed:
You can view the settings of the individual variables by clicking the tree
expansion button: of the groups.
1. Acknowledge the message by clicking Continue. The task report informs the user that the
task has failed, for example:
5. Utilities
Utilities include the following tools:
> Upgrade and Recovery Wizard - upgrades your SPiiPlus Motion Controller software and
firmware.
> System Information Viewer - consolidates all the pertinent data about your system and
displays it in a single window.
> Communication Terminal - enables you to enter commands directly to your controller.
These commands are executed as soon as they are received through one of the
communication channels. The results of the command, once executed, appear in the
Communication Terminal window Output panel.
> Backup specific controller (machine) information to a location that you specify and create
MMC file for Smarter Motion Tools.
> Duplicate by copying the contents in the source directory created by the “Backup Machine”
feature to a SPiiPlus Motion controller.
You can also activate the Upgrade and Recovery Wizard using the right-click Add
Component option of the Workspace Tree - see Controller Right-Click Options.
Upgrading the controller firmware is a dangerous operation that may destroy the
controller if executed improperly. It is strongly recommended that you adhere strictly
to the directions presented by the wizard.
Upgrading from SPiiPlus NT v1.0 to SPiiPlus NT v2.0 is done through the Recovery Task
and not the Upgrade Controller Task.
2. Enter the pathname of the directory in which the firmware files are located if different
from what the Upgrade and Recovery has automatically entered, or click Browse and
search for the directory:
3. Click OK.
Normally when you install the firmware on the computer from the ACS Motion Control
Installation CD, by default, it is copied into the Firmware subdirectory of the same
directory in which the SPiiPlus MMI Application Studio is located. However, it may be
stored anywhere.
4. You can select to backup the old firmware by deselecting the No backup checkbox and
entering the pathname of the directory into which the data is to be saved in the Backup
6. Click OK.
7. Click Next. The Select User Application Options window is displayed:
8. You can either skip this task by clicking Next and go to Step 8, or, if you have saved your
application to the computer (see Application Saver), you can load it by selecting the Load
User Application checkbox.
9. Use the Browse button to locate and select the application data file:
10. Click Load. The application data is loaded into the window.
You can see the contents of any buffer program or variable by selecting it and clicking
Show preview of selected item checkbox. For example:
You can control what is loaded from the application data by unselecting the checkbox of
those items you do not want loaded.
11. Click Next. The Preview task window is displayed.
12. Review the Preview window contents, and if it is what you want to load, click Next.
The Preview window is for information only. In order to make any changes, you have to
use the Back button to return to previous windows and make your changes there.
The Upgrade Firmware window is displayed while the wizard loads the data.
13. When the upgrading is complete, you have the options of:
> Saving the Upgrade Report to a log file by clicking Copy Report. A browser window is
displayed:
Drill down to the directory in which you want to save the report and enter a name in the
Filename field.
14. Click Save.
> Print the Upgrade Report by clicking PRINT REPORT, a Print Preview window is
displayed - seePrint Report Preview Window.
15. Click Finish to exit the Upgrade and Recovery wizard.
The controller has to be disconnected before the Recovery task can be run.
2. Activate the Upgrade and Recovery wizard (see Starting Upgrade and Recovery Wizard).
3. Click Next. The Start Recovery window is displayed:
4. Select the SPiiPlus motion controller type from the dropdown list, for example:
The window display changes depending on the type of controller you have selected:
It is extremely important for the success of this task that you adhere to the instructions
and perform each step in its proper sequence.
> Connect a serial (RS-232) communication cable to the controller’s COM1 port and to any
available COM port on the host computer.
> Select the host’s COM port from the dropdown list.
> Select the current firmware version from the dropdown list.
> Switch the controller off.
> Connect a serial (RS-232) port loop-back adapter to the controller’s COM2 port (as shown in
the picture in the window).
With the serial port loop-back adapter installed in COM2, you then install the loop back
plug (shown below) on the adapter.
To make the loop back plug, the following pins need to be connected together:
Data Carrier Detect, Data Set Ready and Data Terminal Ready (Pins 1, 6 & 4)
Receive Data and Transmit Data (Pins 2 & 3)
Request To Send and Clear To Send (Pins 7 & 8)
as follows:
It is extremely important for the success of this task that you adhere to the instructions
and perform each step in its proper sequence.
1. Connect a serial (RS-232) communication cable to the controller’s COM1 port and to any
available COM port on the host computer.
2. Select host’s COM port from the dropdown list.
3. Turn the power off.
Power must be turned off to prevent the possibility of electric shock to personnel or
damage to the controller card when extracting the controller to install the jumper.
4. Extract the controller and install the jumper. Then reinstall the controller.
Note that the picture showing the jumper location has changed to match the controller
that you have selected.
5. Turn the power on.
6. Click Next. The controller is restarted:
The default path and filename (RUNEMB.exe) of the Recovery Monitor is in the same
directory as the SPiiPlus MMI Application Studio.
8. If for some reason it is somewhere else, click Browse and in the browser window look for
the file: RUNEMB.exe.
You can select one or more operations from the following list:
> Upgrade Firmware (with option to save the existing Firmware files in the backup
folder)
> Restore Factory Defaults
> Copy File to Controller
> Delete File from Controller
11. Normally, the firmware files reside in the Firmware subdirectory under the same directory
as the SPiiPlus MMI Application Studio.
If for some reason they are somewhere else, click Browse and search for the directory:
You also have the option of loading the factory default values by selecting the Restore
Factory Defaults checkbox.
Review the contents of the Preview window, and if it is what you want to load to the
controller, click Next.
The Preview window is for information only. In order to make any changes, you have to
use the Back button to return to previous windows and make your changes there.
15. The Upgrading Firmware window is displayed showing the progress of the Recovery.
16. Wait for the completion of the process. On completion you have two options.
> Saving the Upload Firmware Report to a log file by clicking Save report. A browser
window is displayed:
Drill down to the directory in which you want to save the report and enter a name in the
Filename field. Then click Save.
> Printing the Upload Firmware Report by clicking PRINT REPORT. A PRINT PREVIEW
window is displayed. See Print Report Preview Window
17. Click Finish.
In order for the changes to take effect you have to reboot the controller - see
Controller Reboot.
2. Click Browse to enter a path and filename where the upgrade routine will be saved.
Drill down to the directory in which you want to save the batch file, and enter a name in
the Filename field. Then click Save.
3. Click Next. The Select Upgrade Options window is displayed.
4. Enter the pathname of the directory in which the firmware files are located, or click
Browse and search for the directory:
Normally when you install the firmware on the computer from the ACS Motion Control
Installation CD, by default it is copied into the Firmware subdirectory of the SPiiPlus
<version number> directory as shown above. However, it may be stored anywhere.
5. You can select to backup the old firmware by deselecting the No backup checkbox and
entering the pathname of the directory into which the data is to be saved in the Backup
directory field (or use Browse to find it).
The default is not to backup the old firmware.
6. Enter the path to the Upgrader.exe utility or use Browse to find it.
8. You can either skip this task by clicking Next and go to Step 10, or, if you have saved your
application to the computer (see Application Saver), you can load it by selecting the LOAD
USER APPLICATION checkbox.
9. Use the Browse button to locate and select the application data file:
You can see the contents of any buffer program or variable by selecting it and clicking
Show preview of selected item checkbox. For example:
You can control what is loaded from the application data by unselecting the checkbox of
those items you do not want loaded. Click Next. The Preview task window is displayed.
10. Review the contents of the Preview window, and if it is what you want to load, click Next.
The Preview window is for information only. In order to make any changes, you have to
use the Back button to return to previous windows and make your changes there.
The Creating Shortcut is displayed while the wizard creates the batch file.
11. When the creation of the batch job is complete, you have the options of:
> Saving the Shortcut Creation Report to a log file by clicking Save report ( ).
A browser window is displayed:
Drill down to the directory in which you want to save the report and enter a name in the
Filename field. Then click Save.
> Clicking PRINT REPORT. A PRINT PREVIEW window is displayed. See Print Report
Preview Window
12. Click Finish.
2. Enter the backup directory path to save the backup machine files, or click Browse and
search for the directory.
3. Enter the path to the Upgrader.exe utility if different from what the Upgrade and
Recovery has automatically entered, or click Browse and search for the directory.
4. Click Next. The Preview window is displayed.
5. Veryify the Backup Directory and Upgrader Utility locations and make any necessary
changes, then Click Next. A warning message is displayed.
2. Enter the pathname of the source directory in which to save the duplicate machine files, or
click Browse and search for the directory.
3. Enter the path to the Upgrader.exe utility if different from what the Upgrade and
Recovery has automatically entered, or click Browse and search for the file path.
4. Click Next. The Preview window is displayed.
5. Verify the Source Directory and Upgrader Utility locations and make any necessary
changes, then Click Next. A warning message is displayed.
You can also activate the System Information Viewer using the right-click Add
Component option of the Workspace Tree.
Causes the System Information Viewer to re-read your system and update, if
necessary, the information that is displayed.
There are two cases when you use this:
Refresh A change has been made to one or more of the components during operation
and you want an updated version of the information.
You have loaded a previously saved snapshot of the System Information and you
want to restore the correct information.
Enables you to load the System Information snapshot that has been previously
Load
saved on your computer into the System Information Viewer.
When you select a sub-branch, the System Information Viewer displays only the information for the
sub-branch, for example:
> Axes - Displays a consolidated listing of all the axes that have been defined in the system,
including their numbers, types of drives, operating current (continuous and peak), etc.
> Network Units
For each unit in the network the following is provided:
> General - Displays the unit’s ID and DIP switch settings (if exists), part number, vendor
ID, controller part number, vendor ID, network system name ID, revision, controller
serial number, hardware ID, FPGA ID
> Axes Assignments - Displays the axes numbers as assigned to the unit
> Inputs/Outputs Assignments - Displays the values of the IN and OUT (Digital I/O), AIN
and AOUT (Analog I/O), and EXTIN and EXTOUT (External I/O) variables along with the
number of HSSI channels
> Integrated Components
> Lists all the components that make up the unit, such as power supply(s), controller(s),
and drivers, and displays the information for each component
> Servo Processors - Displays the Servo Processors (SP) contained in the unit
> Integrated Modules - Lists all the components that make up the unit, such as power supply
(s), controller, and drivers, and displays the information for each component, including such
things as type, axes associated with the component, voltage and amperage values, etc.
> Servo Processors - Displays the Servo Processors (SP) contained in the unit with a brief
description of the functionality of each SP.
2. Browse to the location where you want to save the information and click Save.
The System Information data is saved in a file having an .ini file extension.
2. Browse to the location where you saved the information and click Open. The System
Information stored in the file is then displayed in the System Information Viewer.
Only certain ACSPL+ commands may be strung together. The commands that you can
enter in this way must be fairly simple. You cannot, for example, enter ACSPL+ loops or
conditional commands.
> Terminal Commands - commands that are specific to the Communication Terminal and are
not part of the ACSPL+ commands and variables set.
You can also activate Communication Terminal using the right-click options of the
Workspace Tree (see Controller Right-Click Options).
Command Line
The Command Line is used for entering the commands. You can enter ASCPL+ commands or
Communication Terminal Commands.
Certain ACSPL+ commands may be strung together using the semicolon (;) as a
delimiter, for example:
In the example, the initial position of the X axis is set to 0, then the axis is enabled, and
a point-to-point command is executed. If you were to enter the Communication
Terminal query command, ?FPOS0 after sending the string, you would get a response
of 10000.
The commands that you can enter in this way must be fairly simple. You cannot, for
example, use loops or conditionals.
Once you have typed in the command(s), press Enter to send the command, or click Send.
You also have the option of sending the command(s) and seeing the system reaction on the by
clicking Send And Trigger Scope.
Output Window
The Output Window displays what you have sent and reactions to Communication Terminal
commands. For example;
3. Use the browser to select where you want to store the file, enter a File Name and click
Save.
If you select Continuous Save instead of Save, Communication Terminal displays the
same browser. Once you have designated a file to which Terminal is to write the
command output, Communication Terminal appends the output of each command you
enter to the file. When you close Communication Terminal, the file is closed.
Command &
Description
Syntax
?[ACSPL+ variable Returns the current value of a ACSPL+ variable. The ACSPL+ variable
name] name must be entered in all CAPs.
?[ACSPL+ variable
Returns the current value of listed standard variables. The ACSPL+
name], [ACSPL+
variable name must be entered in all CAPs.
variable name]...
??[ACSPL+ Returns a brief description of the ACSPL+ variable. The ACSPL+ variable
variable name] name must be entered in all CAPs.
?[buffer number]: Returns the current values of a local user variable or array defined in a
[local user- program buffer. The variable name must be entered exactly as it
defined variable] appears in the program.
Returns the current value of a specific element in the given array. The
?[array_variable
brackets enclosing the index are optional. If it is an ACSPL+ array
(index)]
variable, it must be entered in all CAPs.
?[global user Returns the current values of a global user variable or array.
array_variable
[(index)]] Or the value of an element in the array if index is included.
?[buffer number] Returns the current status and information about a program buffer
Returns the error code number. If the error code is included in the
??[error code]
query, returns error description.
By adding tags you can determine the format of the response to the Query.
Format Description
Decimal format.
?D/ This format is identical to the default format for integer variables. When applied
to a state variable, the format displays the decimal presentation of the variable.
Hexadecimal format.
?X/ When applied to an integer variable, this format displays the hexadecimal
presentation of the variable.
Binary format.
?B/ This format is identical to the default format for the IN and OUT variables. When
applied to an integer variable, the format displays the binary presentation of the
variable.
Extended format.
This format is useful for very large or small real values, when the default format
?E/ produces ambiguous results because the default does not provide enough
positions to display very large or very small numbers. When applied to a real
variable, the format displays each value in 20 positions.
You also have the option specifying a format using C notation. The specification is placed just
before the variable name in curly brackets. The specification applies only to the value of the name
that is included in the command. If an array is queried, the specification applies to each element of
the array.
C notation provides an unlimited number of possible formats. Some examples are:
Format Description
The motor feedback values for all axes are displayed in 12 digits, fixed
?
decimal point, 3 digits after the point. The same format applies to all 8
{%12.3f}FPOS
values.
?{%8.0f}X_
8 digits, no decimal point, no fraction digits.
FPOS
?{XFPOS =
%8.0f}X_ The response will look like XFPOS = 1234.
FPOS
?{%08X} X_
8 digits, hexadecimal format with leading zeros
MST
In those commands including a line designation, the line designation can appear in one
of the following forms:
These commands enable you to open buffers for entering program commands, searching the
buffer contents, deleting contents from the buffer, and the like. The buffer commands are:
> VGR - Display categories within which ACSPL+ variables are grouped
> VSD - Display brief description of ACSPL+ variables
> VG - Display list of all global variables
> VGF - Display all global variables and attributes
> VL - Display local variables
> VLF - Display local variables and attributes
> V - Display user-defined global and local variables
> VF - Display of user-defined global and local variables and attributes
> L - List program
> VST - Display ACSPL+ variables which can be protected using the Protection Wizard
> VSGT - Display ACSPL+ variables for ACSPL+ variable categories which can be protected
using the Protection Wizard
> VSTF - Display ACSPL+ variables which can be protected using the Protection Wizard and
their attributes
> VSGTF - Display ACSPL+ variables for ACSPL+ variable categories which can be protected
using the Protection Wizard and their attributes
> VSDT - Display ACSPL+ variables for ACSPL+ variable categories which can be protected
using the Protection Wizard and their attributes
> RESET - Reset program variables to factory defaults
> VGV - Remove global variables set through Terminal
#VSF Both the VSF and VSGF commands, in addition to the variable
VSF names, display the variable type, the number of elements
#VSGF (for arrays only), address of the variable in the controller
VSGF [group_ memory and the step between array elements (for arrays
name] only).
The VSTF, VSGTF, and VSDT commands all list the variable
names, the variable type, the number of elements (for arrays
only), address of the variable in the controller memory and
#VSTF the step between array elements (for arrays only) of those
VSTF
#VSGTF ACSPL+ variables to which Program Variables Handling can be
[group_ applied.
VSGTF name] However, when group_name, the name of the category
#VSDT within which ACSPL+ variables are grouped (for the
[group_ categories see VGR), is included with the VSGTF or VSDT
VSDT
name] command, the ACSPL+ variables within the specified category
are listed. group_name is case-sensitive and must be entered
exactly as given in the list displayed by VGR, for example,
#VSGTF Axis_State.
These commands are used for compiling, executing, pausing and halting the program. The
commands are:
The Debug commands enable you to run your program in the Debug Mode, set breakpoints and to
run sections of the program. The commands are:
U
#U The controller continuously measures the time taken
by real-time tasks. When the U command is received,
the controller analyzes the measured times during the
last 50 controller cycles and calculates minimal, maximal
and average time. The results are reported as a
percentage.
Do not perform FRF Measurement when the servo loop is not stable or with very
marginal tuning!
Sometimes it is preferable to do the measurement while the axis is moving. This is typically the
case, when it is required to overcome the non-linear effect of coulomb friction. In this case it is
recommended to write an ACSPL+ program in one of the buffers that takes care of the required
motion. The following types of motion can be used during FRF measurement:
> Axis is idle, no motion is executed
> Jog motion – when the travel is not limited
> PTP motion – when the travel is limited (i.e., linear motor)
In case of PTP or JOG, it is recommended moving at very low velocity, which is enough to overcome
the coulomb friction.
A disturbance in the FRFs may appear if PTP is used while the axis is changing its
direction. To minimize this effect, it is recommended performing cyclic motion
between two points without any dwell time between motions.
You may use Add Component from the right-click menu of the controller in the
Workspace Tree (Controller Right-Click Options ) to activate the FRF Analyzer.
Used for:
> Saving FRF data to a file
> Retrieving FRF data from a file
> Clearing FRF data from the display
See Tools.
Underneath the FRF graph there is a section for selecting what is displayed and for viewing the
measured values. This section is divided into the following tabs:
This tab enables the user to select the signals you want
displayed. See Signals Tab.
This tab enables the user to set cursors in the graph in order to
view the values at points of your choosing. See Cursors Tab.
You select the graphic format from the Graph dropdown list which you display by clicking .
FRF Signals
The FRF signals are based on the following diagram:
> Closed - the relation between the required position and the feedback position, when the
loop is closed, CL(s)= C(s)*P(s)/(1+C(s)*P(s)).
> Open - this is the loop transfer function, OL(s) = C(s)*P(s). This function has a major role in a
stability analysis of a system.
> Controller - the relation between the position error and the drive command, C(s). This is
the control algorithm that is implemented in the SPiiPlus controller.
> Plant - the relation between the drive command and the feedback position, P(s). The plant
constitutes of the mechanical stage, the motor, the feedback device and the drive.
The FRF gain is shown in absolute units or decibels (dB). A value in dB corresponds to 20log10
(value). The phase is typically shown in degrees.
Display Options
You can select which FRF signals (Closed, Open, Controller, Plant) to display by clicking the relevant
check boxes .
You can also select which graph sets (Measure, Design, Baseline) to display by clicking the relevant
check boxes.
To set the line color, type and width for each graph, see Setting FRF Analyzer Properties.
Controller Information
The following information is displayed for reference:
> Firmware - controller software version.
> Servo Loop - servo loop setting used during analysis.
> Dual Loop - state (yes/no) of DUALLOOP CONTROL variable for each axis. If state is yes, the
Position and Velocity option cannot be selected for Servo Loop.
You move the cursors by dragging them left or right. At each point you will notice that the values
of the graph at the cursor point are displayed in table in the tab.
You move the cursor either by dragging it to a new point on the graph, or just click the point you
are interested in and the cursor moves to the point. The values are displayed in the fields of the
tab.
For the meanings of the variables refer to the SPiiPlus Command & Variable Reference
Guide.
> Controller
This column displays the status of the servo-loop variable (ON/OFF) and its value(s) stored
in the motion controller. It is for information only and the values cannot be changed.
> Measure
This column displays the status of the servo-loop variable (ON/OFF) and its value(s) stored
in the Measure set. It is for information only and the values cannot be changed.
> Design
This column displays the status of the servo-loop variable (ON/OFF) and its value(s) stored
in the Design set.
When in the Design mode, if a value in this column is not greyed-out, it can be changed.
> Baseline
This column displays the status of the servo-loop variable (ON/OFF) and its value(s) stored
in the Baseline set. It is for information only and the values cannot be changed.
When working in the Design Mode, once you have found the proper values, you can
then use the Adjuster Wizard to set the values into the motion controller.
If you are in the Design Mode, you can change the status, for example, from ON to OFF, by clicking
the button.
You can check the meaning of a flag variable by using and the ? command, for
example:
You can use Measurement Analysis to adjust system identification parameters through the
Adjuster Wizard as follows:
1. Open the Adjuster Wizard.
2. Click Axis Setup and Tuning.
3. Click Position and Velocity Loops.
4. Under System Identification, click Start Identification and if it is safe to proceed, click Yes in
the Adjuster Wizard dialog box.
5. Wait for the message “System identification succeeded” to appear in the System
Identification results text box.
6. By using the Measure and Design sets, you can use the information displayed on the
Measurement Analysis tab to fine tune the Advanced Tuning parameters received during
the Axis Tuning and Setup.
The following information is displayed:
> Set - click Measure, Design or Baseline to display the required set.
> Bandwidth - displays the system bandwidth.
> Positive Gain Margin - how much the gain can be raised before instability results. The value
is the amount by which the open loop gain is higher than 0dB at the phase crossover
frequency.
> Acceleration Feedforward - reduces position errors during acceleration and deceleration.
> Phase Margin - how much delay can be added to the loop before instability results. The
value is the amount by which the open loop phase exceeds –180° at the gain crossover
frequencies.
> Negative Gain Margin - how much the gain can be reduced before instability results. The
value is the amount by which the open loop gain is lower than 0dB at the phase crossover
frequency.
> Open
Measures transmission function from current to motor velocity. The measurement is done
in an open loop.
You select Measure from the Mode dropdown list.
Your measurement data save options are:
> Save to Baseline - When you start the measurement, if there is previous data in the
Measure set, it is written to the Baseline prior to sampling new signals.
> Overwrite - When you start the measurement, whatever data was previously stored in the
Measure set is overwritten with the new data. The previous data is not saved.
You can set the following parameters:
> Minimal Frequency (Hz) and Maximal Frequency (Hz) - These set the sine sweep, specified
in Hz. These frequencies can range from 1 Hz to 5000 Hz. The FRF measurement itself is
executed at 20 kHz. This provides a reliable measurement at the specified frequencies.
> Frequencies per Decade - Adjacent frequency steps are uniformly distributed on a
logarithmic scale. You can set the required amount of points per one decade of
frequencies. Using a larger number of points results in finer resolution of the data, and a
longer measurement results. A smaller number of points results in coarser resolution of
that data, and a shorter measurement.
For each frequency, the FRF Analyzer waits 20 cycles for transients to decay and then
measures for additional 20 cycles. As the frequency gets higher, the measurement time
gets shorter.
> Excitation Current - The excitation current determines the amplitude of the sine sweep as
percentage of the maximum drive command. The excitation current should be
appropriately determined. It should be sufficient to provoke the system. If the excitation
current is too low, measurement results may be unreliable.
However, excessive excitation current is dangerous. If the current is too high, overcurrent
may occur. In certain cases, high excitation current can cause saturation s and lead to
unreliable measurement results.
The FRF Analyzer does not allow performing FRF measurements if the excitation
current is higher than the overcurrent parameter XRMSD, or XRMSM, or if it is higher
than 80% of the current limit parameters XCURI or XCURV. It also recommended setting
the excitation current lower than the integrator limit parameter, SLVLI.
Prior to running the FRF measurements, you can set which signals you want to view
from the Signals Tab.
1. Once you have entered the Measure mode settings, click Start ( ) to initiate the
FRF analysis.
2. The FRF Analyzer prompts you with:
The Start button changes to Stop. Normally you do not need to click this button. The
FRF Analyzer analyzes one cycle and then stops automatically. You use this button in
the event you need to stop the motion before completion of the measurement.
To view particular values you can use the cursors (see Cursors Tab) and markers (see
Markers).
Prior to running the FRF ANALYZER in DESIGN mode, you must first have run the
analyzer in Measure Mode so that the analyzer has data to compare your changes with.
Once you have run the analyzer in the DESIGN mode, you can use the data from this
mode for further designs.
Alternately, you can load the values from a previously saved file (see Tools).
Your options for using the source data for your design are:
> Current Design Set - Usually selected as a follow-on when making adjustments to the
design.
> Measure Set - The most commonly selected source.
> Baseline Set - Normally selected if you have saved your design to the Baseline.
To save previously collected data to the Baseline select the Save to Baseline checkbox.
The Start button changes to Finish and the Servo Parameters Tab is displayed.
2. Enter the required Servo Loop parameter values in the Design column and press Enter.
Note that the graph changes to reflect the new values.
To view particular values you can use the cursors (see Cursors Tab) and markers (see
Markers). If the values did not meet your requirements, you can set other values in the
Servo Parameters and press Enter again.
3. Once you are satisfied with the values, click the Finish button. Your are prompted with:
4. Click Yes. The new values are loaded into the controller.
The View options enable you to set certain graph display options. To display the options click .
The Phase Modulo and Amplitude options are relevant only in Bode Diagrams.
6.2.9 Markers
The level of stability is typically judged at certain frequencies, known as crossover frequencies:
> Gain crossover frequency - 0 dB crossing of the open-loop FRF gain.
> Phase crossover frequency - ±180o crossing of the open-loop FRF phase.
In order to quantify the level of stability, two criteria have been introduced:
> Gain margin (GM) is a measure of how much the gain can be raised or reduced before
instability results. It is the amount by which the open loop gain is lower (negative GM) or
higher (positive GM) than 0dB at the phase cross over frequency.
> Phase margin (PM) is a measure of how much delay can be added to the loop before
instability results. It is the amount by which the open loop phase exceeds –180o at the gain
cross over frequencies.
When you select Markers, phase crossover frequencies are marked by white squares, and gain
crossover frequencies are marked by white circles:
Clicking one of the markers shows details of the frequency, the gain, the phase and the
stability margin at that point, for example:
The markers are displayed in both the Bode and Nyquist Diagrams.
6.2.10 Tools
The Tools options are:
> SAVE - for saving data to a file, see Saving FRF Data to File
> LOAD - for loading data from a file, see Loading FRF Data from File
> CLEAR - for clearing data from the display, see Clearing FRF Data from Display
2. Enter the file path and filename in File Name (or click Browse to search for a directory, and
filename if required).
3. Enter your name in the User field.
4. Enter the controller ID in the Machine field.
5. You can add optional remarks in the Remarks field.
6. Select or deselect, as required, the FRF data you want to save by clicking the appropriate
checkbox.
7. Click Save.
2. Enter the path and filename in the File Name field (or click Browse to search for the file).
Once you have entered a filename, the contents of the saved file are displayed.
FRF Analyzer signal data is stored in files having an .frf file extensions. File data that has
been stored using an old version of the FRF Analyzer can be loaded.
3. You can change into what subset the data is loaded (for example, loading the Design data
into Measure) by clicking the appropriate checkbox.
4. Click Load.
The FRF Settings are used to set the colors in which the four signals: Closed, Controller, Open and
Plant are plotted for:
> Baseline
> Design
> Measure
To select a color click the color box and select a color from the dropdown list.
General Plot Settings are used to set the properties of the graph against which the data is to be
plotted. These include:
> Cursors Color - the color of the cursors when displayed
> Grid Visible - toggles between displaying the grid (checkbox selected) or not (checkbox
unselected)
> Major Grid Color - the color of the main grid, this marks the horizontal and vertical divisions
of the graph
> Markers Color - the color of the markers when displayed
> Minor Grid Color - the color of the secondary grid, this marks the horizontal and vertical
division is between the main grid points
> Plot Area Color - the background color of the graph
> Point Style - the style of the points being displayed
To select a color click the color box and select a color from the dropdown list.
Graph Settings are used to set the line width and style of graphic display for:
> Baseline
> Design
> Measure
To set the width click the value and enter a number, then press Enter.
To set the style click the field and select from the dropdown list.
Nyquist Graph Settings are used for the Nyquist graph when it is displayed.
The settings are for M-Circles, N-Circles, and Single Circle, which are:
> M-Circles – loci for constant gains of the total closed-loop FRF
> N-Circles - loci for constant phases of the total closed-loop FRF
> Single Circle - unity loop
The properties in this group are:
6.2.12 Troubleshooting
Because of non-linear effects in the system, for example, backlash, different results may be
achieved for various scenarios:
> Problem: Different results when the axis is idle or moving.
Solution: In case of static friction it is recommended to move the axis at low velocity during
the measurement.
> Problem: A disturbance in the FRFs may appear if PTP is used, while the axis is changing its
direction.
Solution: To minimize this effect, it is recommended to perform cyclic motion between
two points without any dwell time between motions.
> Problem: Different results for different excitation levels.
Solution: Always verify that the excitation current level is appropriate.
> Problem: Non-linearities because of saturation s in the system, the drive or the control
algorithm, such as, integrator windup, current limit, etc.
Solution: Always verify that nothing in the control algorithm and the system saturates.
> Problem: Cross coupling between axes can affect the measurement results, for example, if
one axis location affects the center of gravity of a second axis.
Solution: Always record the axes state and position while taking a measurements.
> Problem: Dual loop topology usually has two encoders and the FRF of each loop has to be
separately measured.
Solution: This is not supported by the FRF Analyzer. Still, the total Close loop FRF will be
measured correctly. Open-Loop and plant FRF will be only estimations.
> Problem: Resonances with very low attenuation (lower than 2%) may affect the coherence
of the measurement and its reliability.
Solution: After the resonance is identified, it is recommended to attenuate it using low-
pass or Notch filter. Afterward you should re-measure the system.
> Problem: Noise may effect the measurement results, especially at high frequencies when
the signal to noise ratio is low.
Solution: Make sure that the system is properly grounded and shielded, that is, ground the
controller, use twisted-pair shielded cables, etc.
Some strings will be connected if the device occupies more than one register.
You may use Add Component from the right-click menu of the controller in the
Workspace Tree (Controller Right-Click Options ) to activate the HSSI Manager.
4. Click Initialize to establish communication with the controller. The HSSI Manager reads the
HSSI Channel data and displays it.
Should you close the window and then reopen it, communication is cut off with the
controller. To reestablish communication, click Reconnect.
HSSI input is reported through the EXTIN (Extended In) variable which is a 16 member integer array
that reads the current state of the HSSI inputs. Each element of the array contains a 16 bit number,
each bit of which representing the state of one input; therefore, up to 256 inputs can be read. The
number of inputs depends on the HSSI module.
HSSI output is reported through the EXTOUT (Extended Out) variable which, like EXTIN, is a 16
member integer array that reads the current state of the HSSI outputs. Each element of the array
contains a 16 bit number, each bit of which representing the state of one output; therefore, up to
256 outputs can be read. The number of outputs depends on the HSSI module.
You may use Add Component from the right-click menu of the controller in the
Workspace Tree (Controller Right-Click Options ) to activate the Inputs/Outputs
Manager.
Some controllers have only 8 digital inputs and outputs instead of 16. In this case the
symbols in columns 8 through 31 are greyed-out indicating that they are not available.
Input
Output
Light Grey - indicates that it is not supported by the controller (for example, an
external device that has been included in the system).
The controller activates and deactivates the bits as it progresses through its program.
You can activate a bit manually by clicking it. To deactivate it manually you just click it
again.
You can use the Terminal to check the value or values of the bits, for example, if you
enter ?IN(0) in the Terminal command line, you will get the values for all 16 bits of the
variable.
Using this menu you can sort the columns from left to right (ascending order, that is, 0 to 31), or
from right to left (descending order - 31 to 0).
Cell Display
You hide the display of any cell by selecting it and clicking Hide Cell. To restore its display, select the
hidden cell and click Show Cell.
As an aid in identifying the specific inputs and outputs, you can give cells names:
1. Right-click the cell and select Properties. The Properties panel for the cell is activated.
You are not constrained as to the length of the name, if it is long, you can expand the
column width by dragging its boundaries to show the whole name:
Once the Properties panel is displayed, you can select it for each cell by selecting the
cell, then entering its identifying name in the Properties Name field.
To hide the names select Show Names either from Options, or by right-clicking the cell. You can also
toggle the display of names off by pressing Ctrl+C and then pressing N.
Once you have made your choice, additional rows are added to the selected Unit’s row showing the
status of the variables.
You can also activate the Motion Manager using the right-click Add Component option
of the Workspace Tree - see Controller Right-Click Options .
Absolute
- Used for moving the motor(s) to a specific target.
Move
Relative - Used for moving the motor(s) a specific distance from current
Move position.
One
Direction
- Used for repeatedly moving the motor(s) incrementally in
Incremental
one specified direction from current position.
Repeated
Move
Back and - Used for moving the motor(s) back and forth between two
Forth Move specified points.
The Motion Manager window enables you to set up and manage the motion of motors, both along
individual axes and along all axes.
>
This option enables you to create a new motion type. When you click the down arrow, a dropdown
menu appears from which you can select the motion type:
To select: click the required motion type, a new Axis Motion Parameters Form opens.
While the Axis Motion Parameters Form allows you to add as many axes as you need, their
parameters will all be of the same motion type. You use this option in the event that the motion
type of other axes is different.
>
This option enables you to import the parameter settings from a previously saved file. When you
select the option, a browser window opens:
>
This option enables you to save the parameter settings to a file. When you select the option, a
browser window opens:
Select the directory into which you want to save the file and enter a filename. Then click
OK.
When clicked, all motors are enabled. The button changes to Disable
Motor(s).
When clicked, all motors are disabled. The button changes to Enable
Motor(s).
Initiates motion for all enabled motors. The button changes to Stop
motion.
By default, the form displays only the 0 and 1 axes. Clicking this button
enables you to add additional axes. When you click this button, a list of
axes is displayed:
Select the required axis or axes by clicking the checkbox(es), and then
click OK. The axis(es) are displayed in the form.
In the upper right corner of the window there are two buttons:
Collapses all the Axis Parameters forms in the window. This is an aid when you need to
reduce the window to view other items.
When you click this button, it changes to , which when clicked, restores all the Axis
Parameters forms to the window.
The window contains one checkbox, Trigger Scope on Motion. When this is selected, upon the start
of motion, the is automatically displayed and set to the Single Trigger mode.
Each form has the same layout, it is divided into two sections:
> Axis - motion type specific settings and common parameters (motor states, feedback
position and position error). The section contains four motor status indicators:
> Moving - the motor is in motion
> Accelerating - the motor is accelerating
> In Position - the motor is in initial position
> Motor State - the motor is enabled
The indicators are gray (switched off) by default. When the motion is in progress, the
indicator of the corresponding status turns green.
> Motion Parameters - for viewing or setting values specifically applicable to the motor.
If one of these parameters is changed when a motion is in progress, the change affects
the currently executing motions, or motions that were created before the substitution.
Enables a single motor. When clicked, just the motor for the given axis is
enabled. The button changes to Disable.
Disables a single motor. When clicked, just the motor for the given axis is
disabled. The button changes to Enable.
If you let the mouse cursor linger on the name of a field, a Tool Tip appears informing
you of the name of the ACSPL+ variable with which the field is associated.
Changing Axis
When you first enter the Axis Motion Parameters Form, by default, the form displays fields for
Axis 0 and Axis 1. You can change the axis designation by clicking the down arrow of the Axis field.
A dropdown menu appears:
You can toggle the value of the Move By field between positive and negative by clicking .
Zeroing the Feedback Position Field
You can set the value of the Feedback Position field to zero (0) by clicking .
Expanding/Collapsing the Parameters List
You can collapse the Parameters list display by clicking . And you can expand its display by
clicking .
2. Click One Direction Incremental Repeated Move ( ). The One Direction Incremental
Repeated Move form is displayed.
2. Click Back and Forth Move ( ). The Back and Forth Move form is displayed.
You may use Add Component from the right-click menu of the controller in the
Workspace Tree (see Controller Right-Click Options ) to activate the Safety and Faults
Monitor.
Network Error
2 #NT 1 = Network error has occurred. Valid only for SPiiPlus NT
Motion Controllers.
Encoder Error
10 #ENC
1 = Primary encoder miscounts.
Encoder 2 Error
11 #ENC2
1 = Secondary encoder miscounts.
Velocity Limit
14 #VL 1 = Absolute value of the reference velocity (RVEL)
exceeds the limit defined by the XVEL parameter.
Acceleration Limit
15 #AL 1 = Absolute value of the reference acceleration (RACC)
exceeds the limit defined by the XACC parameter.
Current Limit
> Aggregated Faults - These show the status of the axis motion as gathered by the ACSPL+
S_FAULT variable and reflect the following bits of the variable:
Network Error
2 #NT 1 = Network error has occurred. Valid only for SPiiPlus NT Motion
Controllers.
Motor Overheat
4 #HOT
1 = Motor's temperature sensor indicates overheat.
Encoder Error
10 #ENC
1 = Primary encoder miscounts.
Encoder 2 Error
11 #ENC2
1 = Secondary encoder miscounts.
ERRV - Maximum position error while the axis is moving with constant
velocity
ERRA - Maximum position error while the axis is accelerating or
decelerating
DELI - Delay on transition from ERRA to ERRI
DELV - Delay on transition from ERRA to ERRV
Velocity Limit
14 #VL 1 = Absolute value of the reference velocity (RVEL) exceeds the limit
defined by the XVEL parameter.
Acceleration Limit
15 #AL 1 = Absolute value of the reference acceleration (RACC) exceeds the
limit defined by the XACC parameter.
Current Limit
16 #CL 1 = RMS current calculated in the Servo Processor exceeds the limit
value defined by the XRMSD or XRMSM parameter.
> Safety Inputs - These show the status of the axis motion as gathered by the ACSPL+ SAFIN
variable which indicates the raw state, before processing, of the axis safety inputs and
reflect the following bits of the variable:
> System Safety Inputs - These show the status of the controller program as gathered by
the ACSPL+ S_SAFIN variable which indicates the raw state, before processing, of the
inputs and reflect the following bits of the variable:
Component Failure
31 #FAILURE 1 = An MC4U hardware component other than the drive, such as Power
Supply, I/O card, or encoder card, has failed.
> System Faults - These show the status of the controller program as gathered by the
ACSPL+ S_FAULT variable and represent the following bits of the variable:
Program Fault
25 #PROG
1 = Run time error occurs in one of the executing ACSPL+ programs.
Memory Fault
26 #MEM
1 = User application requires too much memory.
MPU Overuse
27 #TIME
1 = User application consumes too much time in the controller cycle.
Servo Interrupt
29 #INT 1 = The servo interrupt that defines the controller cycle is not
generated. The fault indicates a fatal controller problem.
File Integrity
30 #INTGR 1 = The integrity of the user application in controller RAM is checked by
the controller at power-up and whenever an #IR command is issued.
Component Failure
31 #FAILURE 1 = An MC4U hardware component other than the drive, such as the
Power Supply, I/O card, or encoder card, has failed.
No fault.
Fault detected.
Not applicable.
> To sort a column by ascending order click Sort Axes Columns Ascending.
> To sort a column by descending order click Sort Axes Columns Descending.
6.7 Scope
The SPiiPlus MMI Application Studio Scope enables you to view a real-time graphic display of the
motion. It provides you with a wide diversity of display options that allow you to define the graph’s
display to meet your needs.
You can use Add Component from the right-click menu of the controller in the
Workspace Tree (see Controller Right-Click Options) to activate the Scope.
The Scope display can also be triggered from the Communication Terminal by the
clicking Send and Trigger Scope, and from the Program Manager by clicking or
pressing Ctrl+Alt+T, and from Motion Manager by selecting the Trigger Scope on
Motion checkbox.
You can set the graphic display parameters by clicking [Settings] on the right of the Scope
display.
There are four options for setting the graphic display parameters:
This tab enables you to set the number of channels to be sampled, how
they are to be sampled, and to set what is to be displayed. See Signals Tab.
This tab enables you to set cursors on the graph to view the values
between selected points on the graph. See Cursors Tab.
This tab enables you to see the specific values along the graph. You can
move the Riders along the graph and view the values at the intersection of
the Rider and the graph. See Riders Tab.
This tab displays all the measured statistics for the channels being sampled.
See Statistics Tab.
There are four display controls directly under the Scope. These are:
You use this to set how the graph is displayed. Your options are:
> Normal - The graph is displayed according to the Trigger setting.
If a signal is outside of the Trigger setting, it is not displayed -
only those signals within the Trigger.
> Auto - If the signals are all within the Trigger setting, this setting
acts the same as Normal; however, if a signal is outside of the
Trigger setting, after some delay it is also displayed.
> Single - The graph is displayed for a single frame, that is, the
data is displayed for the length of the time set in the Horizontal
scale and then stop. Each time you click Run, another frame is
displayed.
These options are connected to the definition of the Trigger.
This appears if the data collection for the graph is not running. To start
the data collection and the graph display, you click this button.
In some cases the graph may exceed the boundaries of the Scope
screen. Click for the Scope to resize the display so that all data is
displayed. You have four Autofit options:
> Full Screen - This option sets the Scope to resize the entire
screen, thus each time you click Autofit, the data is refreshed
and displayed in the Full Screen mode.
> Between Cursors - This option reduces the Scope display to the
area between the cursors. Each time you click Autofit, the data
is refreshed and displayed for the area between the cursors.
> Permanent Full Screen - This option sets the Scope display
permanently to the Autofit Full Screen display mode.
> Permanent Between Cursors - This option sets the Scope
display permanently to the Autofit Between the Cursors screen
display mode.
Whenever you have activated one of the above display functions, appears to
indicate that it is active.
You set the horizontal scale (the X axis) of the Scope graph using the
If you enter a value that not within range of the Scope algorithm, Scope will enter the
closest minimum value to the one you have entered.
> Scale
> Scale establishes the value of each division of the X axis. It ranges between 0.05
ms/division to 10 sec/division.
You can either select the value from the dropdown list, or use the dial button: .
To use the dial button, place the mouse cursor over the button and drag it left or right.
If the scale position for all scales select as "None", the Scope display is:
If the Scope display is set to the XY mode, then the Left/Right positions display as bottom position
as shown.
Scope display before setting the zoom factor Scope display after setting the zoom facor to 2.5.
graph using the options. If the options are not visible, click to expand.
It is recommended that you set the Trigger value broad enough to obtain a usable
graph, then slowly fine tune the results.
You can either enter the value directly into the field, or use the dial button: .
To use the dial button, place the mouse cursor over the dial and drag it left or right.
> Source
Select the triggering channel from the dropdown list.
> Mode
There are three possible modes (selected from the dropdown list):
> Normal - Samples when the triggering signal is within the settings in the Trigger dialog
box.
> Auto - If the triggering signal is within the Trigger setting, this mode is the same as
Normal. However, even if the triggering signal is outside the Trigger setting, after a
short delay, it will be sampled. The sampling period is proportional to the Horizontal
setting.
> Single - Samples the triggering signal only once over the length of the Horizontal
setting and then stops. It repeats this for the next frame each time you click Run.
> Slope
You can set the triggering to:
> Rising – Trigger on signal rising past trigger level.
> Falling – Trigger on signal falling past trigger level.
> Delay
Delay polling for trigger until a percentage of the X axis, selected from the dropdown list,
has passed.
The Triggers are displayed as follows:
Clicking sets the Y axis trigger point to 50% of the height of the Y axis.
the Reference axis using the options. If the options are not visible, click to
expand.
Once you have entered the your settings, click and the graph will be displayed
reflecting your choices.
You may use the Riders (see Riders Tab) to view the exact values at points along the
graph, like the maximum and minimum values.
To stop the display and return to the regular Scope display click .
You set the FFT display using the options. If the options are not visible, click
to expand.
6.7.9 Tools
The Scope Tools option enables you to save your signal data to a file for later retrieval.
To save or load your data use the options. If the options are not visible, click
to expand.
2. Select the file type desired. You have the options of:
> MMI signal file with .sgn file extension.
> Matlab data file with .m file extension.
> Xcel CSV file with .csv file extension.
3. Either enter a path and filename in the File field, or click Browse to find the path (and
filename, if needed).
4. Click to unselect those signals whose data you do not want to save.
5. Click Save.
To Load Signal Data
1. Click Load.
2. Either enter a path and filename in the File field, or click Browse to find the file.
Scope signal data is stored in files having .sgn file extensions. Files saved on older
versions of the MMI can be loaded.
3. The Scope file contains the signal data that was collected in a previous session, arranged
according the channels that were sampled. You have the option to change the assignment
of these signals if you desire.
When the signals are loaded, they are loaded in the Freeze state. Once loaded, you can
change the state to whatever you want. See State.
The following describes how you work with each field in the tab.
> Number
> Display
> State
> Variable
> Axis/Index
> Scale/Limits
> Shift
Number
You use the Number field to set the number of channels to be tracked.
If the XY-CH# display option is selected, then an option for a quadrature grid is
available.
> To enable the quadrature grid, select the Q grid check box.
When Q grid is enabled, the ratio of the X axis scaling to the Y axis scaling
remains constant as the display window is resized.
> FFT - Fast Fourier Transform display (also see FFT Setup)
2. Click the display option to activate it. For example:
This enables you to set the data collection time for measuring the value (in the same way as Setting
Horizontal Scale).
State
A signal can have one of three states:
> On - the signal is active
> Off - the signal is inactive
> Freeze - the signal is frozen at its current value
To set the signal’s state click the State field and select the state from the dropdown menu.
Variable
Signal values are tracked through various program variables, such as ACSPL+ variables, SP variables,
user-defined variables, and the like. You use this field to track the signal via a specific variable.
To select the variable you want to track:
1. Click the Variable field, the Variables tree appears:
The list is accumulative, it maintains a history of all variables you have selected in the
past.
2. Drill down to the variable you want by expanding the tree, where needed, and click the
variable.
You can view the variables list sorted alphabetically by clicking Sorted.
Item Description
Feedback
Motor position based on the FPOS variable.
Position
Feedback
Motor velocity based on the FVEL variable.
Velocity
Feedback
Motor acceleration based on the FACC variable.
Acceleration
Reference
Reference position based on the RPOS variable.
Position
Reference
Reference velocity based on the RVEL variable.
Velocity
This branch lists the built-in ACSPL+ variables. These variables are broken
down into:
> Axis_State
> Monitoring
> Motion
> Safety_Control
> Inputs_Outputs
Standard > Program_Execution_Control
Variables > System_Configuration
> Axis_Configuration
> Communication
> Commutation
> Data_Collection
> Servo_Loop
> Miscellaneous
> Obsolete
Global
Lists all global variables declared in any compiled buffer.
Variables
Local
Lists variables broken down by the buffers within which they are declared.
Variables
Lists variables stored in the SPiiPlus controller RAM as part of the controller’s
SP Variables
firmware. The variables are broken down by controller.
Refer to the SPiiPlus Command & Variable Reference Guide and the SPiiPlus ACSPL+
Programmer's Guide for details on all the variables.
Axis/Index
The Axis/Index field is used in three cases:
> Selecting an index for an array variable
> Selecting a bit for a variable that can be bit-accessed (including elements of an array
variable)
> Defining a mathematical operation for two channels
Selecting a Real Array Index
To select an index for a real array variable:
1. Click the Axis/Index field for the array variable. A Select Index dialog box appears, for
example:
2. Select the Show Bit checkbox. The dialog box expands to:
In this case you have to select both the array index, and the bit number.
> To set the Y axis (vertical) limits used for displaying of a selected signal in the graph
This is often useful for when the graph exceeds the borders of the Scope and you want to see the
complete graph.
Adjusting the Y axis units
1. Click the Scale/Limit field for the desired signal. A dialog box appears:
or
Click Autofit to center the signal by altering the scale so that the entire graph is visible.
4. You can apply it to all channels by selecting the Apply to all channels checkbox.
Setting the Y axis limits
1. Click the Scale/Limit field for the desired signal, and in the Set dropdown field select
Limits.
You can click Autofit to center the signal by altering the limits so that the entire graph
is visible.
3. You can apply it to all channels by selecting the Apply to all channels checkbox.
Shift
You use the Shift field to move the graph of a selected signal along the Y axis (vertical).
This is often useful for when the graph is cluttered and you want to see a particular signal on the
graph separated from the others.
1. Click the Shift field of the channel the display of which you want to move. A dialog box
appears:
2. Set the X Cursors by placing the mouse cursor on them and dragging them left or right
(depending on the cursor you are setting).
As you move the X Cursors the values in the following change:
> X1(sec) - the time on the X axis where the X1 Cursor is sitting.
> X2(sec) - the time on the X axis where the X2 Cursor is sitting.
> X2-X1(sec) - the time between the X2 Cursor and the X1 Cursor.
> 1/(X2_X1)(Hz) - the frequency of signal between the X2 Cursor and the X1
Cursor.
3. Set the Y Cursors by placing the mouse cursor on them and dragging them up or down
(depending on the cursor you are setting).
As you move the Y Cursors the values in the following change:>
> Y1(units) - the amplitude of the signal at the time where the Y1 Cursor is
sitting.
> Y2(units) - the amplitude of the signal at the time where the Y2 Cursor is
sitting.
> Y2-Y1(units) - the difference in signal amplitude between the Y2 Cursor and
the Y1 Cursor.
4. To view just the area of the Scope graph bounded by the Cursors select Between Cursors
or Permanent Between Cursors from the Autofit dropdown list.
5. To reset the cursors to their original position, click .
1. Click . The Riders tab is displayed and the Riders are displayed on the Scope.
2. Set the Riders by placing the mouse cursor on them and dragging them left or right.
As you move the Riders the values in the following change:
> R1(sec) - the time on the X axis where the R1 Rider is sitting.
> R2(sec) - the time on the X axis where the R2 Rider is sitting.
> R2-R1(sec) - the time between the R2 Rider and the R1 Rider.
> 1/(R2_R1)(Hz) - the frequency of signal between the R2 Rider and the R1 Rider.
> Y1(units) - the amplitude of the signal at the time where the R1 Rider is sitting.
> Y2(units) - the amplitude of the signal at the time where the R2 Rider is sitting.
> Y2-Y1(units) - the difference in signal amplitude between the R2 Rider and the R1
Rider.
3. To reset the cursors to their original position, click .
4. Checking the checkbox causes TBD.
Using the Range dropdown list you can obtain statistics for:
> Full Screen - Displays the statistics for all signals that appear within the Scope boundaries.
> Full Signal - Displays the statistics for all signals whether they appear within the Scope or
are beyond the Scope boundaries.
> Between Cursors - Displays the statistics for the signals within the boundaries of the X1
and X2 Cursors.
If you select Between Cursors, the X1 and X2 Cursors set using the appear. You can
change the locations of the X1 and X2 Cursors using the From(X1) and To(X2) fields, or
use the mouse to drag them to different positions.
To reset values to default clickReset .
> Line Style - this sets the line style of the plot of the selected channel, selected from a
dropdown list:
> Line Width - this sets the width (in points) of the plot of the selected channel.
> Plot Color - this sets the color of the plot of the selected channel which you select from a
dropdown list (see Setting Color Properties).
> Point Style - you have the option of displaying the plot as a smooth curve, in which case
there is no Point Style, or you can select the format that individual points on the plot are to
be displayed from the dropdown list:
View Settings
This property enables you to set the precision that the plot values are to be displayed.
You may use Add Component from the right-click menu of the controller in the
Workspace Tree (see Controller Right-Click Options ) to activate Sin Cos Encoder
Compensation.
The Lissajous plot displays the aspect ratio of the phase shift between the input and output, with
an aspect ratio of 1 (perfect circle) corresponding to a phase shift of +90o as well as amplitude
differences (ellipse).
As with the SPiiPlus MMI Application Studio , you can set cursors on the display through the Cursors
tab of the Parameter Selection panel (see Setting Cursors).
If you select an axis that is not connected to a Sin-Cos Encoder, it cannot be enabled.
Select the required axis from the dropdown list, for example:
> Compensation Status - this field displays messages associated with the Sin Cos Encoder
Compensation status. The messages that can be displayed are:
> Compensation Off - the Sin Cos Encoder Compensation has not been activated. (You
activate it by clicking the Run button).
> Compensation in Progress - the Sin Cos Encoder Compensation is performing its
measurements.
> Compensation Passed - the Sin Cos Encoder Compensation has completed its
measurements and the compensation is correct.
> Compensation Failed - the Sin Cos Encoder Compensation has completed its
measurements and the compensation is not correct.
> Compensation Cancelled - the Sin Cos Encoder Compensation has been stopped (when you
click the Stop button) before the measurements have been completed.
There is a LED associated with the status which can be:
> Grey - the Sin Cos Encoder Compensation has not been activated, or has completed its
measurements.
> Green/blinking - the Sin Cos Encoder Compensation has been activated and is working.
> Run/Stop button - activates or halts the Sin Cos Encoder Compensation measurements,
when clicked, the Run button changes to the Stop button for manually halting the
measurements in progress.
> ZoomIndicator - you have the following Zoom options:
When the display has been zoomed, the Zoom LED ( ) turns green.
> Zoom In - Hold Shift key and place the mouse cursor in the Scope display in area you
want to zoom into. Click the Left mouse button to display the Zoom icon. When the
icon appears, click the Left mouse button. Without releasing the Shift key, each time
you click the Left mouse button, you increase the zoomed display.
> Zoom In Area - While holding the Shift key, press the Left mouse button and drag to
mark the area you want to zoom, then release the mouse button.
> Zoom Out - While holding the Shift key, place the mouse cursor in the zoomed area
and click the Right mouse button. Without releasing the Shift key, each time you click
the Right mouse button, you zoom out one level.
> Move Graph - Hold Ctrl key and Left mouse button - a hand is displayed. Drag the
graph to where you want.
> Undo - To undo all zooms, press Shift + Backspace keys. (You can also undo the zoom
by clicking the Zoom LED ).
The Measurement tab is used for defining the required input measurement parameters and to
control the output results.
You can change the Target values in Monitoring and Compensation modes.
Once you are in compensation mode, pressing the run button will start the compensation
algorithm. Based on the value in Mode (Automatic or Manual) - motion will be performed either by
MMI commands or the user phsically moving the motor.
If Automatic mode is selected then the user may change the velocity of the stage commanded by
the MMI from its default value, as determined by the algorithm.
If Manual mode is selected the user may either move the stage by hand or write a program that will
execute a motion.
Alternatively, the user can choose automatic mode, and set the velocity, as illustrated below.
Motion
When Automatic mode is selected the velocity field appears and can be set.
Compensation Criteria
This section displays the target criteria used by the Sin Cos Encoder Compensation when making
the calculations and current values of calculated parameters along with a set of LEDs. If the current
value of any parameter is equal to or less than the target value, the associated LED is Green
(otherwise it is Red if the value fails, or Grey if the parameter is not relevant).
The criteria are:
> Iterations - the number of iterations that the Sin Cos Encoder Compensation is to perform
during the measurements.
> Asymmetries - Max(dx,dy) - Min(dx,dy), where dx is Xfinal point - Xstart point, and dy is Y final
point - Y start point. If this is zero, the graph is a perfect circle.
Parameters
This section lists the ACSPL+ variables that are connected with managing Sin-Cos encoders. These
are:
> SCGAIN - Modify the amplitude of the COS signal, to compensate amplitude difference
between the SIN/COS signals
> SCPHASE - Modify the phase of the COS signal, to compensate phase difference between
the SIN/COS signals (phase should be 90 degrees)
> SCSOFFS - Compensating SIN signal offset
> SCCOFFS - Compensating COS signal offset
> SLEBIASA
> SLEBIASB
The SLEBIASA and SLEBIASB variables, on the other hand, are hardware-
based. Hardware compensation has some advantages over software
compensation: possibility to get analog signals out of saturation, and making
hardware based features like PEG more accurate.
In principle these variables have similar functionality as SCSOFFS and SCCOFFS;
however, they are only supported by the following controller models:
You have the option of changing the values by inputting new values in the appropriate fields.
Details of these variables are provided in the SPiiPlus Command & Variable Reference Guide.
There are three action buttons associated with this section:
Sin Cos Encoder Compensation reads the current variable values from the
controller.
Sin Cos Encoder Compensation writes the variable values into the controller.
Sin Cos Encoder Compensation sets the default values into the controller.
The Cursors tab enables you to mark points on the display where you are interested in seeing
exactly what the values at the points are.
There are two cursors, X1 and X2, for delimiting the Cos voltage values, and two cursors, Y1 and Y2,
for delimiting the Sin voltage. As the Sin Cos Encoder Compensation performs its routines, the
values at the cursor settings are displayed in the field below the graph. For setting the cursors see
Setting Cursors.
For each run, the Sin Cos Encoder Compensation builds a statistics table consisting of compensation
calculation measurements in the Statistics tab:
The rows are color-coded, Green for those values that passed the compensation measurements,
and Red for those that failed.
At the bottom of the table the Sin Cos Encoder Compensation adds a line containing the average
values of the variables. There is a separate line for each axis that was checked.
Right-clicking on any row displays a menu with the following options:
> Set Parameters - selecting this option causes the Sin Cos Encoder Compensation to use
these variable values for purposes of making the measurement.
> Save to Flash - selecting this option causes Sin Cos Encoder Compensation to save the
values to the controller’s flash memory.
> Delete - selecting this option deletes the row from the Statistics.
> Clear All - selecting this option removes all the values from the Statistics.
If the motor associated with the encoder is a brushless motor, it has to be commutated
before encoder compensation. In the event that it has not been commutated, the
following is displayed:
The easiest way to commutate the motor at this point is to enter the COMMUT
command via the Communication Terminal, for example:
If the compensation is successful, go to the Measurement Tab of the Parameter Selection panel
and save the values to the controller’s flash memory by clicking Set in Measurement Tab.
The Sin Cos Encoder Compensation properties are divided into two sections:
General_Plot_Settings
This section enables you to set the background properties of the graph:
> Cursors Color - for setting the color of the cursors.
> Grid Color - for setting the color of the background grid.
> Grid Visible - a checkbox for toggling between the display (default)/non-display of the grid.
> Plot Area Color - for setting the color of the background of the graph.
Plot Settings
This section enables you to set the properties of the graph:
> Plot - there are four possible plots: Measure, Initial, Reference, Limits, each with its own set
of properties. You select the plot for which you want to set the properties from the
dropdown list:
> Once you have select the plot, you can set:
> Plot Color - for setting the color of the selected plot.
> Point Style - for setting the style of the points used in displaying the graph of the
selected plot.
> Line Style - for setting the style of the line used in displaying the graph of the selected
plot.
> Line Width - for setting the thickness of line used in displaying the graph of the
selected plot.
> High Limit Diameter - for setting the diameter of the outside limit (maximum) that is
displayed.
> Low Limit Diameter - for setting the diameter of the inside limit (minimum) that is
displayed.
You may use Add Component from the right-click menu of the controller in the
Workspace Tree (see Controller Right-Click Options ) to activate the Variables Manager
and Watch.
When you first activate Variables Manager and Watch, it opens in the Quick View mode.
As you add watches, these are displayed in their own tabs.
> The Variables Tree for selecting the variable for display
> Index Selector for selecting the index of the variable
> Quick Viewer window displaying the values of the selected variable
If no Index Selection button has been selected, then all of the variable values are
displayed in one column, labeled Value.
When you click an Index button, the value for that Index replaces whatever was previously
displayed.
To cancel the display click the button again.
The Index Selector has an additional button: , which enables you to select multiple axes for
display.
2. Select the required axes by clicking the checkbox associated with the Index (or select
Select All for all of the axes) and close the dialog window.
To cancel the display of a particular Index click and deselect the Index checkbox.
To select a group click the variable name with [All] in the Variables Selector Watch Type column:
All arrays have Watch Type = array. To expand the list of elements, click . After you have
expanded the list, click any of its elements.
If a single variable or an array element is an integer, then to the right of its name you see .
Clicking this expands the integer to reveal the bits.
After you have expanded the list of bits, click of them.
6.9.3 Watch
The Watch, unlike the Quick Viewer, is used for real-time monitoring of selected variables.
The file handling functions enable you to save and retrieve Watch data.
The Watch Parameters Matrix shows the parameters of each cell displayed in the Watch window.
The Matrix has the following columns:
> Name - The name of the variable
> Alias - Enables you to enter a more meaningful name of the variable
> From1 - Starting index of an array
The Watch Parameter Matrix enables you to modify what is displayed in the Watch window.
Depending on the variable, you can select what is displayed by clicking the field in the matrix and
click the down arrow ( ) to select from the dropdown list.
For example, you may want to see a different variable momentarily. You click the Name field and
select the required variable:
This variable and its values are now displayed in the Watch window. To return to the original
variable, you repeat this process and select the original variable.
Another modification you can make is change the To or From indices of the variable by:
If the variable that’s being watched is a bit, you can select whether to show its numeric value, or as
a Boolean display (True/False).
When you select Boolean, instead of 0 or 1, you get a graphic display in the Watch window, for
example:
You can also display it from the Workspace Tree by right-clicking its symbol and
selecting Open from the dropdown menu:
When you right-click the Watch window, you are presented with the following menu:
When you right-click a Row, you are presented with a number of options:
When you right-click a Column, you are presented with a number of options:
When you select a Watch window, you activate the Watch’s Properties.
It can also be displayed by selecting Watch properties from any of the right-click menus.
If you enter a number greater than the number of variables being watched, empty
rows/columns are inserted.
> Font
> Font - for selecting the display font
The font section allows the user to select the the required font, size, and attributes:
from which you can select the required font, size and attributes.
> Misc
By default, when you create a Watch, it is given the name Watch# (where # is the number
of the Watch window). if you have several Watch windows running, you can use this field
to give them each a unique identifying name.
> Show/Hide
You can use these buttons to toggle between displaying or hiding the Row, Column and
Variable labels.
You can display the Row Properties panel either by selecting a Row, or from the right-click menu.
Type can also be set in the Watch Parameter Matrix - see Modifying Watch Parameter
Matrix Fields.
You can display the Column Properties panel either by selecting a Column, or from the right-click
menu.
Type can also be set in the Watch Parameter Matrix - see Modifying Watch Parameter
Matrix Fields.
You can display the Cell Properties panel either by selecting a Cell, or from the right-click menu.
1. From the Toolbox, click Diagnostics and Monitoring to display the Diagnostics and
Monitoring tools list.
2. Click System Viewer and Diagnostics.
You can use Add Component from the right-click menu of the controller in the
Workspace Tree (see Controller Right-Click Options) to open System Viewer and
Diagnostics.
3. Click Retrieve :
5. If the system contains inconsistent information, the following dialog box will be displayed:
7. If the user clicks Cancel rather than Diagnostics, a window such as the following will be
displayed: