Solid-state equipment has operational characteristics differing from those of electromechanical equipment. Safety
Guidelines for the Application, Installation and Maintenance of Solid State Controls (publication SGI-1.1
your local Rockwell Automation sales office or online at http://www.rockwellautomation.com/literature/
important differences between solid-state equipment and hard-wired electromechanical devices. Because of this difference,
and also because of the wide variety of uses for solid-state equipment, all persons responsible for applying this equipment
must satisfy themselves that each intended application of this equipment is acceptable.
In no event will Rockwell Automation, Inc. be responsible or liable for indirect or consequential damages resulting from the
use or application of this equipment.
The examples and diagrams in this manual are included solely for illustrative purposes. Because of the many variables and
requirements associated with any particular installation, Rockwell Automation, Inc. cannot assume responsibility or
liability for actual use based on the examples and diagrams.
No patent liability is assumed by Rockwell Automation, Inc. with respect to use of information, circuits, equipment, or
software described in this manual.
Reproduction of the contents of this manual, in whole or in part, without written permission of Rockwell Automation,
Inc., is prohibited.
Throughout this manual, when necessary, we use notes to make you aware of safety considerations.
available from
) describes some
WARNING: Identifies information about practices or circumstances that can cause an explosion in a hazardous environment,
which may lead to personal injury or death, property damage, or economic loss.
ATTENTION: Identifies information about practices or circumstances that can lead to personal injury or death, property
damage, or economic loss. Attentions help you identify a hazard, avoid a hazard, and recognize the consequence.
SHOCK HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that dangerous
voltage may be present.
BURN HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that surfaces may
reach dangerous temperatures.
Identifies information that is critical for successful application and understanding of the product.
Allen-Bradley, Kinetix, MicroLogix, Rockwell Software, Rockwell Automation, TechConnect, and Ultra3000 are trademarks of Rockwell Automation, Inc.
Trademarks not belonging to Rockwell Automation are property of their respective companies.
Summary of Changes
This manual contains new and updated information. Changes throughout this
revision are marked by change bars, as shown to the right of this paragraph.
New and Updated
Information
This table contains the changes made to this revision.
Top icPag e
Added the exception code Servo On Write Error
Renumbered the Modbus address and the Kinetix® 3 Parameters in Group 5 Supplemental Drive Control table
Updated Modbus address range of 600…4999 and bullets15
Updated Group 0 to Special Index15
Added Modbus 4009, Index 0 Next Index to the Indexing Parameters table15
Added Group 1 - Homing16
Added Important statement and parameter usage information23
Added descriptive text to Monitoring Parameter (Function Code 0x04)24
Updated the Special Symbols table29
Updated the [Pr - 0.00] parameter range48
Updated the [Pr - 0.01] parameter to reserved48
Updated the [Pr - 0.04] parameter units to %51
Updated the [Pr - 0.07] parameter range55
Updated the [Pr - 1.01] parameter range67
Updated the [Pr - 1.11] parameter range70
Updated the [Pr - 1.13] parameter range70
Updated the [Pr- 1.17] parameter default72
Updated the [Pr - 1.34] parameter range78
Updated the [Pr - 2.00] parameter range and default value81
Updated the Group 2 - Speed Control Modbus addresses81…84
Update the [Pr - 4.00] parameter units to 0.1% of rated continuous current/V90
Updated the Group 5 - Supplemental Drive Controls Modbus Addresses92 …96
Update the [Pr - 5.05] parameter range and default values93
Updated Group 0 - Indexing System Modbus addresses114…116
Update [IN01.09] range and default values122
Updated hex values in Variables table131
Updated Variable 15 digital outputs bit16 to D05133
Updated Variable 26 Digital Outputs 134
12
14
Rockwell Automation Publication 2071-RM001B-EN-P - April 20133
Summary of Changes
Notes:
4Rockwell Automation Publication 2071-RM001B-EN-P - April 2013
Rockwell Automation Publication 2071-RM001B-EN-P - April 20137
Table of Contents
Notes:
8Rockwell Automation Publication 2071-RM001B-EN-P - April 2013
Preface
About This Publication
Who Should Use This Manual
Conventions Used in This
Manual
This manual describes the host command set for end-user interface with a
Kinetix 3 drive via serial communication. Use this manual for designing,
programming, and troubleshooting host commands for serial communication
with the Kinetix 3 drives.
This manual is intended for engineers, programmers, or technicians directly
involved in the installation, operation, programming, and field maintenance of a
Kinetix 3 drive by using host mode commands.
If you do not have a basic understanding of the Kinetix 3 drive, contact your local
Rockwell Automation sales representative before using this product for the
availability of training courses.
The conventions starting below are used throughout this manual:
• Bulleted lists such as this one provide information, not procedural steps
• Numbered lists provide sequential steps or hierarchical information
Additional Resources
These documents contain additional information concerning related products
from Rockwell Automation.
Kinetix 3 Motor Feedback Breakout Board Installation
Instructions, publication 2071-IN003
Kinetix 3 Serial Communication Cables Installation
Instructions, publication 2090-IN019
Kinetix 3 Component Servo Drive User Manual,
publication 2071-UM001
Ultraware User Manual, publication 2098-UM001
Information on configuring and operating Ultraware
Mounting and wiring instructions, and mounting
dimensions.
Information on installing, configuring, starting up, and
troubleshooting for your Kinetix 3 servo drive system.
software with servo drives and motors.
You can view or download publications at
http://www.rockwellautomation.com/literature
. To order paper copies of
technical documentation, contact your local Allen-Bradley distributor or
Rockwell Automation sales representative.
Rockwell Automation Publication 2071-RM001B-EN-P - April 20139
Preface
Notes:
10Rockwell Automation Publication 2071-RM001B-EN-P - April 2013
Chapter 1
Modbus Protocol
This chapter defines the Modbus protocol as it applies to a Kinetix 3 drive.
Function Codes
The register number of Modbus devices may begin with 0 or 1, because this is
determined by the Modbus host you have selected. If your controller requires it, a
'1' must be added to the register number.
The maximum number of parameters that can be read or written at the same time
is the same as the number of Modbus addresses, which is the same as the number
of the parameters in each group. In other words, all the parameters in each group
can be read together or written together.
Function CodeDescription
03 (0x03)Read Holding Registers
04 (0x04)Read Input Registers
06 (0x06)Write Single Register
16 (0x10)Write Multiple Register
Rockwell Automation Publication 2071-RM001B-EN-P - April 201311
Chapter 1Modbus Protocol
Exception Codes
The Kinetix 3 Modbus protocol uses the following exception codes from the Modbus
specifications.
Exception Code Name Meaning
0x01Illegal FunctionThe function code received in the query is not an allowable action for the
0x02Illegal Data
(1)
0x03
0x06Slave Device BusyThe slave is engaged in processing Run command. The master should
0x07Illegal CRC ValueThe CRC value received in the query is wrong value.
0x0CIllegal FrameThe byte length of the Query Reception frame is out of the limit.
(2)
0x0D
(1)
0x0E
(3)
0x0F
(4)
0x10
0x1ESer vo On Write
0x1FServo Error FailWhen the slave is Servo Error condition, and receives a Servo ON command
0x21Drive Type FailWhen drive type of the slave is Indexing, slave receives run command 02,
slave.
Address
Illegal Data ValueThe length of query data field is not valid for the slave.
Illegal SequenceThe data sequence received in the query is not an allowable write command
Illegal Data Range The value of query data field is not valid for the slave.
Illegal CommandThe slave is in Run control and received an invalid command.
Illegal ControlThe slave is not in the Network mode, but received a net work control
Error
The data address received in the query is not an allowable address for the
slave.
retransmit the message later when the slave is free.
for the slave.
command.
Attempted to write to parameters that are inaccessible when the servo
drive is enabled.
from master.
03, 04.
(1) Exception code 0x03 indicates an Illegal Data Value. It means the length of data string is incorrect. Exception code 14(0x0E) indicates
an Illegal Data Range. It means that data range exceeds the limit of the minimum or maximum value.
(2) Exception code 0x0D is generated if the master accesses a 32-bit data address with function code 06 or either the high or low
address of 32-bit data with function code 10.
(3) Exception code 15(0x0F) indicates an Illegal Command was issued. It occurs when a received Run control cannot be executed at the
moment.
(4) Exception code 16(0x10) is an Illegal Control. It occurs when the Network Control Mode is not set, but the drive requests a Run
Control command or an I/O Control command through the network.
12Rockwell Automation Publication 2071-RM001B-EN-P - April 2013
Modbus ProtocolChapter 1
Address Maps
All standard and indexing parameters (Pr-x.xx or Inxx.xx) require a unique
register address. The host computer assigns the initial address number and
determines whether the register numbers begin with 0 or 1.
Standard Parameters
Group 0 - System Level
Modbus
Address
0 Pr-0.0010 Pr-0.0920 Pr-0.1930 Pr-0.29
1 Reserved11 Pr-0.1021 Pr-0.2031 Pr-0.30
2 Reserved 12 Pr-0.1122 Pr-0.2132 Pr-0.31
3 Pr-0.0213 Pr-0.1223 Pr-0.2233 Pr-0.32
4 Pr-0.0314 Pr-0.1324 Pr-0.2334…42 Reserved
5 Pr-0.0415 Pr-0.1425 Pr-0.2443…99 Reserved
6 Pr-0.0516 Pr-0.1526 Pr-0.25
7 Pr-0.0617 Pr-0.1627 Pr-0.26
8 Pr-0.0718 Pr-0.1728 Pr-0.27
9 Pr-0.0819 Pr-0.1829 Pr-0.28
Kinetix 3
Parameter
Modbus,
Address
Kinetix 3
Parameter
Modbus
Address
Kinetix 3
Parameter
Modbus
Address
Kinetix 3
Parameter
Group 1 - Gain Control
Modbus
Address
100 Pr-1.00 111 Pr-1.11122 Pr-1.22133 Pr-1.33
101 Pr-1.01 112 Pr-1.12123 Pr-1.23 134 Pr-1.34
102 Pr-1.02 113Pr-1.13 124Pr-1.24 135Pr-1.35
103 Pr-1.03 114Pr-1.14 125Pr-1.25 136Pr-1.36
104 Pr-1.04 115Pr-1.15 126Pr-1.26 137Pr-1.37
105 Pr-1.05 116Pr-1.16 127Pr-1.27 138Pr-1.38
106 Pr-1.06 117Pr-1.17 128Pr-1.28 139Pr-1.39
107 Pr-1.07 118Pr-1.18 129Pr-1.29 140Pr-1.40
108 Pr-1.08 119Pr-1.19 130Pr-1.30 141Pr-1.41
109 Pr-1.09 120Pr-1.20 131Pr-1.31142Pr-1.42
1 1 0P r - 1 . 1 0 1 2 1Pr - 1 . 2 11 3 2P r - 1 . 3 21 4 3 … 1 9 9R e s e r v e d
Kinetix 3
Parameter
Modbus
Address
Kinetix 3
Parameter
Modbus
Address
Kinetix 3
Parameter
Modbus
Address
Kinetix 3
Parameter
Rockwell Automation Publication 2071-RM001B-EN-P - April 201313
7231In11.15.Hi7263In11.31.Hi7295In11.47. Hi7327In11.63. Hi
Kinetix 3
Parameter
Modbus
Address
Kinetix 3
Parameter
Modbus
Address
Kinetix 3
Parame ter
Modbus
Address
7328 …7399Reserved
Kinetix 3
Parameter
Rockwell Automation Publication 2071-RM001B-EN-P - April 201321
Chapter 1Modbus Protocol
Group 12 – Next Index
Modbus
Address
7400In12.007416In12.167432In12.327448In12.48
7401In12.017417In12.177433In12.337449In12.49
7402In07.027418In12.187434In12.347450In12.50
7403In12.037419In12.197435In12.357451In12.51
7404In12.047420In12.207436In12.367452In12.52
7405In12.057421In12.217437In12.377453In12.53
7406In12.067422In12.227438In12.387454In12.54
7407In12.077423In12.237439In12.397455In12.55
7408In12.087424In12.247440In12.407456In12.56
7409In12.097425In12.257441In12.417457In12.57
7410In12.107426In12.267442In12.427458In12.58
7411In12.117427In12.277443In12.437459In12.59
7412In12.127428In12.287444In12.447460In12.60
7413In12.137429In12.297445In12.457461In12.61
7414In12.147430In12.307446In12.467462In12.62
7415In12.157431In12.317447In12.477463In12.63
Kinetix 3
Parameter
Modbus
Address
Kinetix 3
Parameter
Modbus
Address
Kinetix 3
Parameter
Modbus
Address
7464 …7599Reserved
Kinetix 3
Parameter
22Rockwell Automation Publication 2071-RM001B-EN-P - April 2013
Modbus ProtocolChapter 1
IMPORTANT
Save Parameters
When the Standard and Indexing parameters are written by using function code
0x06, their values are stored to the volatile RAM temporarily and are lost after
powering off. To permanently store the parameters values in the nonvolatile flash
memory, write a 1 to the address 9999, by using the function code 0x06, 0x10.
Nonvolatile memory is limited to 100,000 erase/program cycles.
Modbus Address Data Status Description
9999 (decimal)1Write data into nonvolatile memory
Rockwell Automation Publication 2071-RM001B-EN-P - April 201323
Chapter 1Modbus Protocol
Monitoring Parameter (Function Code 0x04)
The Read or Multi-read of monitoring variables are possible through function
code 04 Read Input Register. All display parameters of the drive are mapped to
function code 04 range. The default address is 0x00.
Display Parameter - Input Registers (Default = 0)
Modbus AddressDriveNameUnit
0dis-00Velocity Feedbackrpm
1dis-01Velocity Commandrpm
2dis-02Velocity Errorrpm
3dis-03Torque Command0.10%
4…5dis-04Position Feedbackcounts
6…7dis-05Position Commandcounts
8…9dis-06Position Errorcounts
10dis-07Pulse Command Frequency0.1pps
11dis-08Electrical Angle0.1'
12dis-09Mechanical Angle0.1'
13dis-10Regeneration Load Ratio%
14dis-11DC-Link VoltageV
15dis-12Multi-Turn DataTurn number
16…17dis-13Offset in Velocity Command0.1mV
18…19dis-14Torque Offset0.1mV
20…24dis-15Input/Output Signal Status?-
25…32dis-16Display Error History8Alarm
33dis-17Display Software Version1word
34…35dis-18Display Motor info2word
36dis-19Analog Velocity Command Voltage0.01V
37dis-20Analog Current Command Voltage0.01V
38dis-21Drive Rated Output Power1word
39…40dis-22Absolute Single Turn Data?-
41…42dis-23Encoder Feedback Countercounts
43…99Reserved--
Fault and Warning Status Parameter - Input Registers
Fault and Warning Status Parameter - Input Registers (Default = 0)
Modbus Address Function Name Unit
100 Error Ch eckSer vo Error CodeWord
101 Warni ng Ch eckSe rvo War ning CodeWo rd
102…199Reserved--
24Rockwell Automation Publication 2071-RM001B-EN-P - April 2013
Output Function Status Parameter
Modbus ProtocolChapter 1
Modbus
Address
200/S_ALMAlarmBit[0]
201/O_ISEL0Index Select 0 OutBit[0]
Output Function Description Unit Position
/P-COMWithin position window Bit[1]
/TG-ONUp to speedBit[2]
BKBrake controlBit[3]
/V-COMWithin Speed windowBit[4]
/A-VLDAbsolute position valid Bit[5]
/RDYDrive ReadyBit[6]
/T-LMT /NEARCurrent LimitedBit[7]
/V-LMT /WARNVelocity LimitedBit[8]
/NEARNear position Bit[9]
/WARNWarning Bit[10]
Reserved-Bit[11]
Reserved-Bit[12]
/IMOIn MotionBit[13]
/I-DWIn DwellBit[14]
/HOMCAxis HomedBit[15]
/O_ISEL1Index Select 1 OutBit[1]
/O_ISEL2Index Select 2 OutBit[2]
/O_ISEL3Index Select 3 OutBit[3]
/O_ISEL4Index Select 4 OutBit[4]
/O_ISEL5Index Select 5 OutBit[5]
/E_SEQUEnd of SequenceBit[6]
Reserved-Bit[7…15]
[bits]
Rockwell Automation Publication 2071-RM001B-EN-P - April 201325
Chapter 1Modbus Protocol
Running Parameter (Function Code 0x06 or 0x10)
Run Parameter - Holding Registers (Default = 2000)
Modbus
Address
2000User Openrun-00Jog Operation1-byte
2001run-01Off-Line Auto Tuning1 bit
2002 run-02 Reserved -
2003run-03Auto Adjustment of Speed Command
2004run-04Auto Adjustment of Current
2005…2007 run-05… run-07 Reserved -
2008 run-08Alarm Reset1 bit
2009 run-09 Reserved -
2010 run-10 Absolute Encoder Reset1 bit
2011 run-11 2-Group Gain Storing1 bit
2012 run-12Parameter Initialization1 bit
2013…2015 run-13…run-15 Reserved -
2016 run-16Hardware Reset1 bit
20 17 …2 09 9 ru n- 17 …ru n- 99 R ese r ved -
AttributeRUNNameAccess Unit
1 bit
Offset
1 bit
Command Offset
Input Function Parameter (Function Code 0x03, 0x06, or 0x10)
Input Function Control - Holding Registers
Modbus
Address
3000/SV-ONDrive Enablebit0
I/O Function Description UnitPosition
-Reserved -[1] and [2]
/P-CONIntegrator Inhibitbit[3]
/A-RSTFault Resetbit[4]
/N-CLNegative Current Limitbit[5]
/P-CLPositive Current Limitbit[6]
/C-SELOperation Mode Overridebit[7]
/C-DIRPreset Directionbit[8]
/C-SP1Preset Select 1bit[9]
/C-SP2Preset Select 2bit[10]
/C-SP3Preset Select 3bit[11]
/C-SP4Preset Select 4bit[12]
/INHIBPause Followerbit[13]
/G-SELAlternate Gain Selectbit[14]
/PCLRPosition clearbit[15]
Bit
26Rockwell Automation Publication 2071-RM001B-EN-P - April 2013
Modbus ProtocolChapter 1
Input Function Control - Holding Registers
Modbus
Address
3001/ABS-DTPosition Strobebit[0]
3002/START_IStart Indexbit[0]
I/O Function Description UnitPosition
/STARTMotor Moving Enablebit[1]
/Z-CLPZero Speed Clamp Enable bit[2]
/GEAR2nd Electronic Gear Bank Select ionbit[3]
/R-ABSReset multi-turn data of Absolute Encoderbit[4]
-Reserved -[5]
/SHOMEStart Homingbit[6]
/STOPStop Indexingbit[7]
/PAUSEPause Indexingbit[8]
/I-SEL0Index Select 0 Inputbit[9]
/I-SEL1Index Select 1 Inputbit[10]
/I-SEL2Index Select 2 Inputbit[11]
/I-SEL3Index Select 3 Inputbit[12]
/I-SEL4Index Select 4 Inputbit[13]
/I-SEL5Index Select 5 Inputbit[14]
/H_STOPStop Homingbit[15]
/BANK_SELGain Bank Selectbit[1]
-Reserved -[2…15]
Bit
Rockwell Automation Publication 2071-RM001B-EN-P - April 201327
Chapter 1Modbus Protocol
Notes:
28Rockwell Automation Publication 2071-RM001B-EN-P - April 2013
Communication Protocol (RS-232/ASCII)
Chapter 2
Introduction
Special Symbols
The drive command protocol is a client-server protocol. A host computer is the
server, and each drive is a client. This chapter provides details about the Special
Symbols, Packet Structure, and Checksum in the serial communication protocol.
Special symbols used in the host commands include the following.
SymbolValueDescription
STX0x02Start of text
ETX0x03End of text
ACK0x06A cknowle dged
BEL0x07Acknowledge alarm
NAK0x15Not acknowledged
CAN0x18Cancellation of command (For example, the drive sends CAN if the drive is already enabled,
but the JOG ON is requested.)
ETB0x17End of block
GS0x1DCannot save parameter
RS0x1ERange over
US0x1FUndefined
Packet Structure
StartIDHost/
SymbolSTXdd # or $SET or…d …d : c c ETX
Bytes1 2 1 3 0 - n 1 1 1
The packet structure is shown below.
CommandD ataSeparatorChecksumEnd
Response
Some simple commands might not have the Data field (for example, Fault Reset).
Maximum packet size is 400 bytes. Each letter and digit in Command and Data
fields represents a single ASCII character.
All commands begin with an STX
, and terminate with an ETX.
If the drive receives the command without a communication error, the response is
in the same format as the host command. Numeric parameters are encoded as
strings.
Rockwell Automation Publication 2071-RM001B-EN-P - April 201329
Chapter 2Communication Protocol (RS-232/ASCII)
If the drive receives the host's command with a communication error (for
example, parity or checksum errors), the drive sends an NAK
. The host should
assume a communication error occurred if a response from the drive does not
occur within a time-out period (generally 200 ms).
Checksum
If drive does not recognize the command, it sends a US
The checksum range consists of ID to Separator fields. Checksum is the ASCII
response.
hex code of the least significant digit from the sum of hexadecimal codes in the
checksum range.
For example, this VER command has a checksum of 42 (ASCII hex code of B).
Command STX01#VER: BETX
ASCII 2 3031235645523A423
30H+31H+23H+56H+45H+52H+3AH = 1ABH
The ASCII hex code of B is 42.
However, this VER command response also has a checksum of 35 (ASCII hex
code of 5).
Command STX01&VER9. 02: 5ETX
ASCII 2 30312456455220392E30323A353
30H+31H+24H+56H+45H+52H+20H+31H+2EH+30H+32H+3AH = 295H
The ASCII hex code of 5 is 35.
30Rockwell Automation Publication 2071-RM001B-EN-P - April 2013
Chapter 3
General Commands (ASCII)
This chapter defines the general ASCII commands available to control a
Kinetix 3 drive.
Read Parameter (SET)
Attribute Value
Command SET
Description Read parameter value
Format STX ID # SET PPP : BSS ETX
Data Argument Description
PPP Parameter #; for example, [Pr - 2.03]
Refer to this chapter, Appendix A
and Appendix B, Indexing Drive Parameters for a available
parameter descriptions.
Response Format STX ID $SET V : BSS ETX
Response Data Argument Description
V Bit-field type = 4-byte hexadecimal value.
Integer type = Signed integer of variable length
, PPP=203=0x0CB
, Standard Drive Parameters,
Rockwell Automation Publication 2071-RM001B-EN-P - April 201331
Chapter 3General Commands (ASCII)
Write Parameter (STR)
Attribute Value
Command STR
Description Write parameter value to RAM, and then save data from RAM to nonvolatile memory.
Format STX ID # STR PPP V : BSS ETX
Data ArgumentDescription
PPP Parameter #; for example, [Pr - 2.03]
Refer to Standard Drive Parameters
description of available parameters.
Group 7 - Manufacturing Settings are product settings that are
programmed during manufacturing.
V Bit-field type = 4-byte hexadecimal value.
Normal type = Signed integer o f variable length
Response Format ACK
Error Response If the drive is unable to change the variable because it is enabled, it sends GS. If the value
is out of range, RS is returned.
Next Command STX ID # STR : BSS ETX
Usage Note To determine whether task is complete, send STR without a rguments.
Response Format If task is not complete: STX ID $BSY : BSS ETX
or
If task is complete: STX ID $TOK : BSS ETX
, PPP=203=0x0CB
beginning on page 47 for a
Write Parameter (CHP)
Attribute Value
Command CHP
Description Write parameter value to RAM
Format STXID#CHP PPP V:BSS ETX
Data Argument Description
PPP Parameter #; for example, [Pr - 2.03]
Refer to Standard Drive Parameters
description of available parameters.
Group 7 - Manufacturing Settings are product settings that are
programmed during manufacturing.
V Bit-field type = 4-byte hexadecimal value.
Normal type =Signed integer of variable length
Response Format ACK
Error Response If unable to change the variable because drive is enabled, GS is sent. If value is out of
range, RS is return ed.
, PPP=203=0x0CB
beginning on page 47 for a
32Rockwell Automation Publication 2071-RM001B-EN-P - April 2013
General Commands (ASCII)Chapter 3
Indexing Command Extended (XCE)
Attribute Value
Command XCE
Description Execute Indexing Control Panel command
Format STX ID # XCE NNNNN & VVVVV: BSS ETX
Data ArgumentDescription
NNNNNIndex number. 0…63.
Data Format 16-bit unsigned integer
VVVVVVIndexing Function Command.
0 = Start Homing
1 = Stop Homing
2 = Start Indexing
Data Format 16-bit unsigned integer
Response Format ACK
If there is an error while executing the command, the GS
code s can be used for the response.
Usage Note This command executes only Indexing commands.
If the command to be executed is not specific to an Index number, the NNNNN field should
be 0.
, RS, US, NAK, CAN exception
Read Indexing Parameter (XET)
Attribute Value
Command XET
Description Read parameter value
Format STX ID # XET PPPP : BSS ETX
Data Argument Description
PPPP Parameter #; for example, in the case of [IN00.02]
PPPP=0200, the two initial arguments (PPxx) indicate the
indexing (Ix) group.
Refer to Indexing Drive Parameters
description of available indexing parameters.
Group 7 - Manufacturing Settings are product settings that are
programmed during manufacturing.
Response Format STX ID $XET V : BSS ETX
Response Data Argument Description
V Bit-field type = 4-byte hexadecimal value.
Integer type: Signed integer of variable length
,
beginning on page 113 for a
Rockwell Automation Publication 2071-RM001B-EN-P - April 201333
Chapter 3General Commands (ASCII)
Write Indexing Parameter (XHP)
Attribute Value
Command XHP
Description Write parameter value to RAM.
Format STX ID # XHP PPPP V : BSS ETX
Data ArgumentDescription
PPPP Parameter #; for example, in the case of [IN00.02]
V Bit-field type = 4-byte hexadecimal value.
Response Format ACK
Error Response If the drive is unable to change the variable because it is enabled, it sends GS. If the value
is out of range, RS is returned.
PPPP=0200, the two initial arguments (PPxx) indicate the
indexing (Ix) group.
Refer to Indexing Drive Parameters
description of available indexing parameters.
Normal type = Signed integer of variable length
beginning on page 113 for a
,
Write Indexing Parameter (XTR)
Attribute Value
Command XTR
Description Write parameter value to RAM, and then saves data from RAM to nonvolatile memory
Format STX ID # XTR PPPP V : BSS ETX
Data Argument Description
PPPP Parameter #; In the case of PPPP=0200, the two initial
V Bit-field type = 4-byte hexadecimal value.
Response Format ACK
Error Response If the drive is unable to change the variable because it is enabled, it sends GS. If the value
is out of range, RS is returned.
arguments (PPxx) indicate the indexing (Ix) group.
Refer to Indexing Drive Parameters
description of available indexing parameters.
Normal type = Signed integer of variable length
beginning on page 113 for a
34Rockwell Automation Publication 2071-RM001B-EN-P - April 2013
General Commands (ASCII)Chapter 3
Fault Reset (RST)
Attribute Value
Command RST
Description Clear fault
Format STX ID # RST : BSS ETX
Response ACK
Usage Note Fault Reset had no effect unless action was taken to resolve the fault.
Refer to Warnings and Fault Codes
warnings.
beginning on page 129 for a description of faults and
Monitor Variable (MDM)
Attribute Value
Command MDM
Description Monitor variables
Format STX ID # MDM P1 P2 P3 P4 P5 : BSS ETX
Data Argument Description
P1…P5 Variables to monitor.
Usage Note MDM command can monitor up to five variables. Refer to Monitor Variables on page 131
Response Format STX ID $ MDM V1&V2&V3&V4&V5 : BSS ETX
Response Data Argument Description
for the list of variables.
V1…V5 Variable values are 4 or 8-bytes signed
See tables below for descriptions of s pecific variables.
Rockwell Automation Publication 2071-RM001B-EN-P - April 201335
Chapter 3General Commands (ASCII)
Triggered Data Collection (MOT)
Attribute Value
Command MOT
Description Sets, watches, and reads trigger monitor
Format STX ID # MOT Ch1 Ch2 Src SP Num Mode Pos Level : BSS ETX
Data Argument Description
Ch1, Ch2 Input signals, See Appendix A
(variables 0x00…0x0F only)
Src Trigger Source (0x000…0x009, 0x101…0x112)
Refer to Monitor Variables on page 131 for the list of variables.
Num Number of data points *10, Range 0x01…0x1E (1…30)
Mode Trigger mode
1 = Positive Edge
2 = Negative Edge
Pos Tri gger Position (1…9)
The percentage of data to be received before the trigger point.
For example, if Pos = 3 then 30% of data received before the
trigger point and 70% of data received after the trigger point.
Level Trigger level/threshold; the value of the Trigger Source. Values
are 4 or 8-bytes signed.
Usage Note This command is sent to the drive prior to monitoring or reading the Triggered Data
Collection (MOT) command variants below. See Figure 1
Response ACK
Next Command MOT
Format STX ID # MOT: BSS ETX
Usage Note This command is sent to the drive to verify data is available.
Response If data is not ready: STX ID $ BSY : BSS ETX
If data is ready: STX ID $ TOK : BSS ETX
Next Command MOT
Format STX ID # MOT NumD : BSS ETX
Data Argument Description
NumD Data Point to retrieve the data from; Range 00…(Num-1)
Usage Note This command can be used when previous command returned TOK.
Send ESC to stop data collection.
Response Format STX ID $ MOT V1&V2&...V20 : BSS ETX
Response Data Argument Description
V1…V20 Data transmission is done in blocks of 10.
Because there are 2 channels, 20 values are returned, with values
alternating between the first channel and the second channel.
Values are a signed integer of variable length (4 or 8-bytes).
for command examples.
36Rockwell Automation Publication 2071-RM001B-EN-P - April 2013
General Commands (ASCII)Chapter 3
#MOR (setting)
ACK
#MOT
$BSY
#MOT
$TOK
#MOT00
$MOT
PCServo
Time <200 ms
.
.
.
#MOT29
$MOT
#ESC
ACK
.
.
.
Attribute Value
Next Command STX ID # ESC : BSS ETX
Response ACK
Figure 1 - Triggered Data Collection (MOT) Command String Example
Rockwell Automation Publication 2071-RM001B-EN-P - April 201337
Chapter 3General Commands (ASCII)
#MOR (setting)
ACK
#MOR
$MOR
#MOR
$MOR
#ESC
ACK
PCServo
Time <200 ms
.
.
.
Variable Roll Monitoring (MOR)
Attribute Value
Command MOR
Description Set up variable roll monitor
Form at
Data
Usage Note Sets up the variable roll monitoring. This command is sent to the drive prior to sending a
Response ACK
Next Command STX ID # MOR : BSS ETX
Usage Note Request to store data in the linear buffer (with a capacity of 100 data points). If the buffer
Response Format STXID$MORV1&V2&…Vn:BSSETX
Response Data ArgumentDescription
Next Command STX ID #ESC : BSS ETX
Usage Note Send ESC to stop monitoring of the data.
Response ACK
STX ID # MOR SP P1 P2 : BSS ETX
Argument Description
SP Sampling period range 0x01…0x64 (01…100 ms)
P1, P2Variables to monitor. Range 0x00…0x1D
Monitor Variable (MDM)
is full and data has not been retrieved, the buffer is emptied. If data is requested before
data is in the buffer, the drive sends ACK.
V1…VnSigned integer of variable length
command. See Figure 2 for command examples.
Figure 2 - Variable Roll Monitoring (MOR) Command String Example
38Rockwell Automation Publication 2071-RM001B-EN-P - April 2013
General Commands (ASCII)Chapter 3
#TAT (setting)
ACK
#TAT
$BSY
#TAT
$TOK
PCServo
Time <200 ms
.
.
.
Automatic Task (TAT)
Attribute Value
Command TAT
Format STX ID # TAT T1 : BSS ETX
Data Argument Description
T1Automatic task number. See the following Values and Task
Descriptions.
ValueTask Description
0x01 Auto Tuning
0x02 Move to Marker
0x03 Auto Adjustment of Velocity Command Offset
0x04 Auto Adjustment of Current Command Offset
0x07 Auto Adjustment of Current Feedback Offset
Response ACK
Usage NoteSend TAT command without arguments to find out if a task is completed. See Figure 3
command examples.
Next Command STX ID # TAT : BSS ETX
Response Format STX ID $ BSY : BSS ETX - if task is not complete
STX ID $ TOK : BSS ETX - task is complete
for
Figure 3 - Automatic Task (TAT) Command String Example
Rockwell Automation Publication 2071-RM001B-EN-P - April 201339
Chapter 3General Commands (ASCII)
#TMN (setting)
ACK
#TMN
$BSY
#TMN
$TOK
PCServo
Time <200 ms
.
.
.
Manual Task (TMN)
Attribute Value
Command TMN
Format STXID#TMN1: BSSETX
Data Argument Description
T1Manual task number. See the following Values and Task
Response ACK
Usage NoteMost manual tasks are complete by the time ACK is received. Commands 0x03 and 0x06
may take longer, because they save data to nonvolatile memory. Send TMN command
without arguments to find out if a task is completed. See Figure 4
Next Command STX ID # TAT : BSS ETX
Response Format STX ID $ BSY : BSS ETX - if task is not complete
STX ID $ TOK : BSS ETX - task is complete
Descriptions.
ValueTask Description
0x01 - Speed Command Offset - Decrement by
0.1 mV.
0x02 + Speed Command Offset - Increment by
0.1 mV.
0x03 Save Speed Command Offset change.
0x04 - Current Command Offset - Decrement by
0.1 mV.
0x05 + Current Command Offset - Increment by
0.1 mV.
0x06 Save Current Command Offset change.
0x07 Discard changes and exit.
for command examples.
Figure 4 - Manual Task (TMN) Command String Example
40Rockwell Automation Publication 2071-RM001B-EN-P - April 2013
General Commands (ASCII)Chapter 3
Read Fault Contents (EHY)
Attribute Value
Command EHY
Description Read faults
See Read Fault Detailed Data (DIE) on page 44
Format STX ID # EHY F1 : BSS ETX
Data Argument Description
F1 Fault Number. Range is 0x01…0x08
where latest fault status is stored in 0x01, and oldest fault is
stored in 0x08.
Response Format STX ID $ EHYE FCode FChars : BSS ETX
Data Data Description
FCode Fault Code. See Appendix C
FChars Fault Name Abbreviated. See Appendix C
Usage NoteUse this command to f ind out more about one of the eight faults.
To receive all fault statuses, use EHY * command below.
for alternative fault data.
for a list of fault codes.
.
Attribute Value
Command EHY *
Description Read all fault codes
Format STX ID # EHY * : BSS ETX
Data Argument Description
* Asterik (*) means all faults
Response Format STX ID $ EHY Fcode1&Fcode2&...Fcode8 : BSS ETX
Data Data Description
Fcode1…Fcode8 Fault Code. See Appendix C
for a list of fault codes.
Jog (JOG)
Attribute Value
Command JOG
Description Jog for ward or reverse
Format STX ID # JOG P1 : BSS ETX
Data Argument Description
P10 = prepare for jog operation
Response ACK
Usage Note To keep jogging, send JOG command more than once within 500 ms.
To end Jog mode, send SVROF
+ = jog forward
- (dash) = jog reverse
Rockwell Automation Publication 2071-RM001B-EN-P - April 201341
Chapter 3General Commands (ASCII)
Read Drive Status (STS)
Attribute Value
Command STS
Description Read status
Format STX ID # STS : BSS ETX
Response Format STX ID $ STS Mode S1 S2 S3 S4 S5 SS FChars : BSS ETX
Response Data Arguments Description
ModeOne of these operating modes
F = Follower mode
S = Analog Velocity mode
P = Preset Velocity mode
C = Analog Current mode
D = Dual Current Com mand mode
PF, PS, PC FS, FC, SC = Mixed modes
Refer to [Pr - 0.00], Operations Mode on page 48
information.
S1 S1 means:
In Follower mode:
1 = In Position
0 = Not In Position
In Analog Velocity or Preset Velocity modes:
1 = In Speed Window
0 = not In Speed Window
If position or speed data is not available S1= 0.
S2 One of the following:
1 = Up to Speed
0 = Not Up to Speed
If speed data is not available, S2=0.
S3 One of the following:
1 = Drive is Enabled
0 = Drive is Disabled
S4 One of the following:
1 = Positive Overtravel is active
0 = Positive Overtravel is inactive
S5 One of the following:
1 = Negative Overtravel is active
0 = Negative Overtravel is inactive
SS One of the following:
Edd = fault occurred (See Appendix C
dd = 2-byte error code, 0x00…0xFF
Wdd = warning occurred (See Appendix C
dd = 2-byte warning code
RDY = no errors or warnings
FCharsAbbreviation of the fault/warning name.
In the case of Estop fault, Fchars = ESTOP
FChars size is 5 bytes when fault occurs and 3 bytes when
warning occurs.
for additional
)
)
42Rockwell Automation Publication 2071-RM001B-EN-P - April 2013
General Commands (ASCII)Chapter 3
Other Functions (ETC)
Attribute Value
Command ETC
Format STXID#ETCF1: BSSETX
Data Argument Description
F1Manual task number. See the following Values and Task
Descriptions.
ValueTask Description
0x09 Clear Fault History
0x0A Reset Absolute Encoder
0x0B Store 2-Group Gain
0x0C Reset to Factory settings
0x0D Test Run
0x0E Upgrade Firmware
0x0F Erase Manufacturing Information
Response ACK
Usage NoteSend ETC command without arguments to find out if a task is completed.
Next Command STX ID # ETC : BSS ETX
Response Format STX ID $ BSY : BSS ETX - if task is not complete
or
STX ID $ TOK : BSS ETX - task is complete
(1)
(2)
(1) Resetting of an a bsolute (17-bit) encoder is possible on ly when the drive is disabled. The command Reset Absolute Encoder sets the
rotation data to 0, and clears all encoder related faults and warnings.
(2) Parameters in the table below are not affected by the Reset to Factory settings.
Parameter Number Description
6.00 Analog Velocity Command Offset
6.01 Analog Current Command Offset
6.02 U Phase Current Sensing Offset
6.03 W Phase Current Sensing Offset
7.00…7.07 Group 7 - Manufacturing Settings
Rockwell Automation Publication 2071-RM001B-EN-P - April 201343
Chapter 3General Commands (ASCII)
Verify Software Version (VER)
Attribute Value
Command VER
Description Verify software version
Format STX ID # VER : BSS ETX
Response Format STX ID $ VER V : BSS ETX
Response Data Argument Description
V: Firmware version
Size: 5 bytes, including a space
Example: STX01$VER 1.00:BSS ETX
Verify Servo Connection (LIV)
Attribute Value
Command LIV
Description Verify servo connection
Format STX ID # LIV : BSS ETX
Response Format ACK if there is a connection
Read Fault Detailed Data (DIE)
Attribute Value
Command DIE
Description Read detailed fault data stored in [Pr -6.07] Fault Detail Data Selection 1. Sample period
Format STX ID # DIE A1 A2 : BSS ETX
Data Argument Description
Usage Note Send DIE 02 00 to receive all the data for A1= 02.
Response Format STX ID $ DIE D1&D2&...DN : BSS ETX
Error Response STX ID $ DIE FFFF : BSS ETX
Response Data Argument Description
in μs = [Pr - 6.07]
See Read Fault Contents (EHY) on page 41
A1Channel to get the data for. Range 1…4
A2Data Number; Range 0…50
Send DIE 00 01 to receive data for data number 1 of 4 variables.
DIE 00 00 is invalid.
means data number is invalid.
D1…DnDetailed data, where n depends on A1 and A2
* 200.
for alternative fault data.
Channels are stored in [Pr - 6.07]…[Pr - 6.10], Fault Detail
Data Selection 4
0 means all data
If A1=00 and A2 = 01, then n = 4
If A1=01…04 and A2 = 01…50, then n=1
If A1=01…04 and A2 = 00, then n= 50
44Rockwell Automation Publication 2071-RM001B-EN-P - April 2013
Enable Drive (SVRON)
Attribute Value
Command SVRON
Description Enables the drive
Format STX ID # SVRON : BSS ETX
Response ACK
Disable Drive (SVROF)
Attribute Value
Command SVROF
Description Disables the drive
Format STX ID # SVROF : BSS ETX
Response ACK
General Commands (ASCII)Chapter 3
Reset Drive (HWR)
Attribute Value
Command HWR
Description Reset the drive by using watchdog counter.
Format STX ID # HWR : BSS ETX
Response ACK
Usage Note Stops the watchdog timer, allowing a hardware signal to reboot (reset) the drive.
Rockwell Automation Publication 2071-RM001B-EN-P - April 201345
Chapter 3General Commands (ASCII)
Notes:
46Rockwell Automation Publication 2071-RM001B-EN-P - April 2013
Appendix A
Standard Drive Parameters
Parameters control Kinetix 3 drive operations. They are grouped by the type of
drive, Standard or Indexing, and the settings they define.
Parameter Groupings
Descriptions of Indexing Drive Parameters begin on page 113
Standard drive parameters are grouped into these drive settings:
• Group 0 - Basic drive system and I/O settings
• Group 1 - Gain and gain tuning settings
• Group 2 - Velocity control settings
• Group 3 - Position control settings
• Group 4 - Torque control settings
• Group 5 - Supplementary drive system and I/O settings
• Group 6 - Supplementary gain settings and fault reports
• Group 7 - Factory default settings
• Group 8 - Parameters reserved
• Group 9 - Motor and drive operating mode parameters
.
Rockwell Automation Publication 2071-RM001B-EN-P - April 201347
Appendix AStandard Drive Parameters
Parameter Descriptions
Parameter descriptions list the size of each parameter and the data options within
the parameter.
Descriptions of Indexing Drive Parameters begin on page 113
.
Group 0 - System Level
[Pr - 0.00]Operations Mode
Ultraware Name Operation Modes (Main/Override)
Range 1…12
Display (Value) Normal operating modeOverride operating mode
F (1) FollowerFollower
S (2) Analog Velocity InputAnalog Velocity Input
C (3) Analog Current Input Analog Current Input
SF (4) Analog Velocity InputFollower
CF (5) Analog Current InputFollower
CS (6) Analog Current InputAnalog Velocity Input
P (7) Preset VelocityPreset Velocity
PF (8) Preset VelocityFollower
PS (9) Preset VelocityAnalog Velocity Input
PC (10) Preset VelocityAnalog Current Input
D (11) Reserved Reserved
I (12) IndexingIndexing
Default 1
When Enabled Ser vo-Off -> Setting -> After power cycle
Applicable Operating Mode All
Modbus Address 0
[Pr - 0.01]Reserved
Reserved for future use.
48Rockwell Automation Publication 2071-RM001B-EN-P - April 2013
Standard Drive ParametersAppendix A
55
[Pr - 0.02]Motor Basic Modes
Data Size 4 digits
Digit 0Fault and Disable Braking
Ultraware NameStopping Functions: Fault and Disable Braking
RangeValueDescription
0x0Brake and hold
0x1Brake and release
0x2Free stop
0x3Free stop and hold
Default0
Digit 1Overtravel stop method
Ultraware NameStopping Functions: Over Travel Stop Method
RangeValueDescription
0x0Stop by change of mode to Normal
0x1Dynamic Brake
Default0
Digit 2Motor Forward Dir
Ultraware NameCommand Polarity
RangeValueDescription
0x0The command signal is not inverted
0x1The command signal is inverted so
Default0
Digit 3Power input
Ultraware NameAC Line Loss Check
RangeValueDescription
0x0 Enables the following:
0x1 Disable
0x2 Single-phase input
Default0
When EnabledServo-Off -> Setting
Applicable Operating Mode All
Modbus Address3
Current. Set stopping current with
Overtravel Current Limit parameter
[Pr - 4.05]
.
so that a positive command value
results in clockwise rotation, as
viewed from shaft end.
that a positive command value results
in counter-clockwise rotation, as
viewed from shaft end.
• 50…400W drive: Enable singlephase open check
• 800…1.5kW drive: Enable threephase open check
Rockwell Automation Publication 2071-RM001B-EN-P - April 201349
Appendix AStandard Drive Parameters
[Pr - 0.03] Auto Tuning Functions
Data Size 4 digits
Digit 0Off-line Tuning Mode
Ultraware NameOff-line Tuning Mode
RangeValueDescription
0x0Inertia Moment Estimation
0x1Inertia Moment Estimation and
Resonant Frequency Detection
0x2Resonance frequency Detection
Default1
Digit 1Reserved
Digit 2Autotuning Speed
Ultraware NameAutotuning Speed
Range2…9
Default7
Unitsrpm/100
Digit 3Dynamic Tuning Response Speed
Ultraware NameOnline Tuning Response
RangeValueDescription
0x0Off
0x1Slowest
0x2Slower
0x3Slow
0x4Medium-Slow
0x5Medium
0x6Medium-Fast
0x7Fast
0x8Faster
0x9Fastest
Default0
Units-
When EnabledServo-Off -> Setting
Applicable Operating Mode All
Modbus Address4
50Rockwell Automation Publication 2071-RM001B-EN-P - April 2013
Standard Drive ParametersAppendix A
(1)Internal value used for Modbus reading/writing functions(1)Internal value used for Modbus reading/writing functions
(1) Internal value used for Modbus reading/writing functions
Rockwell Automation Publication 2071-RM001B-EN-P - April 201351
Appendix AStandard Drive Parameters
[Pr - 0.05] Auxiliary Function Selection 1
Applicable Operating ModeAll
Data Size 4 digits
Digit 0Encoder Back-up Battery
Ultraware NameEncoder Back-up Battery
RangeValueDescription
0x0Battery Installed
0x1Battery Not Installed
Default0
Digit 1Velocity Observer
Ultraware NameVelocity Observer
RangeValueDescription
0x0Disable
0x1Enable
Default0
Digit 2Alternative Gain Change Enable
Ultraware NameGain Change Enable
RangeValueDescription
0x0Disable
0x1Enable
Default0x0
Digit 3Emergency stop input
RangeValueDescription
0x0Disable
0x1Enable
Default0
When EnabledServo-Off -> Setting -> After power cycle
Applicable Operating Mode All
Modbus Address6
52Rockwell Automation Publication 2071-RM001B-EN-P - April 2013
Standard Drive ParametersAppendix A
[Pr - 0.06]Auxiliary Function Selection 2
Applicable Operating ModeAll
Data Size 3 digits
Digit 0Automatic Motor Identification
Ultraware NameAuto Motor Identificati on
Range ValueDescription
0x0Disabled
0x1Enabled
Default1
Digit 1Incremental Feedback Loss (Encoder Line Break Detection)
Ultraware NameIncremental Feedback Loss
RangeValueDescription
0x0Monitored
0x1Ignored
Default0
Digit 2Mode of Gain Switching
Rockwell Automation Publication 2071-RM001B-EN-P - April 201353
Appendix AStandard Drive Parameters
[Pr - 0.06]Auxiliary Function Selection 2 (continued)
RangeValueDescription
0Fixed to the 1st gain
1Fixed to 2nd gain
22nd gain selection when the gain
switching input is turned on.
32nd gain selection when the toque
command is larger than the set-up
levels of the gain control switching
and hysteresis of control switching.
42nd gain selection when the
command speed is larger than the
set-up levels of the gain control
switching and hysteresis of control
switching.
52nd gain selection when the
positional deviation is larger than the
setup set-up levels of the gain control
switching and hysteresis of control
switching.
62nd gain selection when more then
one command pulse exist between
200 μs.
72nd gain selection when the
positional deviation counter value
exceeds the set-up of the positioning
complete range.
82nd gain selection when the motor
actual speed exceeds the set-up
levels of the gain control switching
and hysteresis of control switching).
Switches to the 2nd gain while the
position command exists.
9Switches to the 1st gain when no -
position command status lasts for the
set up of delay time of gain switching
[x 200 μs] and the speed falls slower
than the set-up levels of the gain
control switching level and hysteresis
of control switching.
Default0
When Enabled Immediately
Applicable Operating Mode All
Modbus Address7
54Rockwell Automation Publication 2071-RM001B-EN-P - April 2013
[Pr - 0.07]Drive Address
Applicable Operating ModeAll
Ultraware NameDrive Address
Range1…248
Default248
When Enabled Immediately
Applicable Operating Mode All
Modbus Address8
[Pr - 0.08]Password
Applicable Operating ModeAll
Ultraware NameDrive Password
Range0…9999
Usage Note. Unprotected Code: 777
When Enabled Immediately
Applicable Operating Mode All
Modbus Address9
Standard Drive ParametersAppendix A
[Pr - 0.09]Serial Port Configuration
Applicable Operating ModeAll
Data Size 4 digits
Digit 0Baud Rate
Ultraware NameBaud Rate
RangeValueDescription
0x09600 bps
0x114400 bps
0x219200 bps
0x338400 bps
0x456000 bps
0x557600 bps
Default0x5 for Ultraware connection
0x2 for 1203-USB connection
Digit 1Data bits, Parity, Stop bit
Ultraware NameData bits, Parity, Stop bit
RangeValueDescription
0x08, No, 1
0x18, Even, 1
0x28, Odd, 1
0x38, No, 2
0x48, Even, 2
0x58, Odd, 2
Rockwell Automation Publication 2071-RM001B-EN-P - April 201355
Appendix AStandard Drive Parameters
[Pr - 0.09]Serial Port Configuration (continued)
Default0x0
Digit 2Protocol
Ultraware NameProtocol
RangeValueDescription
0x0ASCII
0x1Modbus-RTU
Default0 for Ultraware connection
1 for 1203-USB connection
Digit 3 Communication Method
Ultraware NameCommunication Method
RangeValueDescription
00x0RS232
1Ox1RS485
Default0 for Ultraware connection
1 for 1203-USB connection
When Enabled Immediately
Applicable Operating Mode All
Modbus Address10
[Pr - 0.10]Allocation of Input Signals 1
Range for all digits0…B, where 0 is Off, B is On and 1…A are digital inputs
Data Size4 digits
Digit DescriptionDefaultUnmapped IO
Status
0Drive enable (SV-ON)0x1ON
1Positive overtravel (P-OT)0xbON
2Negative overtravel (N-OT)0xbON
3Integrator inhibit (CON)0x4OFF
When Enabled Ser vo-Off -> Setting
(1)
Applicable Operating Mode All
Modbus Address11
(1) Refer to Setting Values for Parameters [Pr - 0.10]…[Pr - 0.21] on page 61.
56Rockwell Automation Publication 2071-RM001B-EN-P - April 2013
Standard Drive ParametersAppendix A
[Pr - 0.11]Allocation of Input Signals 2
Range for all digits0…B, where 0 is Off, B is On and 1…A are digital inputs
Data Size4 digits
DigitDescriptionDefaultUnmapped IO
Status
0Fault reset (A-RST)0x5OFF
1Negative current limit (N-TL)0x6OFF
2Positive current limit (P-TL)0x7OFF
3Operation mode override (C-SEL)0x0OFF
When Enabled Ser vo-Off -> Setting
(1)
Applicable Operating Mode All
Modbus Address12
(1) Refer to Setting Values for Parameters [Pr - 0.10]…[Pr - 0.21] on page 61.
[Pr - 0.12]Allocation of Input Signals 3
Range for all digits0…B, where 0 is Off, B is On and 1…A are digital inputs
Data Size4 digits
DigitDescriptionDefaultUnmapped IO
Status
0Preset direction (C-DIR)0x0OFF
1Preset select 1 (C-SP1)0x0OFF
2Preset select 2 (C-SP2)0x0OFF
3Preset select 3 (C-SP3)0x0OFF
When Enabled Ser vo-Off -> Setting
(1)
Applicable Operating Mode All
Modbus Address13
(1) Refer to Setting Values for Parameters [Pr - 0.10]…[Pr - 0.21] on page 61.
Rockwell Automation Publication 2071-RM001B-EN-P - April 201357
Appendix AStandard Drive Parameters
[Pr - 0.13]Allocation of Input Signals 4
Range for all digits0…B, where 0 is Off, B is On and 1…A are digital inputs
Data Size4 digits
DigitDescriptionDefaultUnmapped IO
Status
0Zero speed clamp enable (Z-CLP)0x0OFF
1Pause follower (INHIBIT)0x0OFF
2Alternate gain select (G-SEL)0x0OFF
3Position clear (PCLR)0x0OFF
When Enabled Ser vo-Off -> Setting
(1)
Applicable Operating Mode All
Modbus Address14
(1) Refer to Setting Values for Parameters [Pr - 0.10]…[Pr - 0.21] on page 61.
[Pr - 0.14]Allocation of Input Signals 5
Range for all digits0…B where 0 is Off, B is On, and 1…A are digital inputs
Data Size4 digits
DigitDescriptionDefaultUnmapped IO
Status
0Position strobe (ABS-DT)0x0OFF
1Motor moving enable (START) 0x0OFF
2Analog speed command select (C-
0x0OFF
SP4)
32nd electronic gear bank selection
0x0OFF
(GEAR )
When Enabled Servo-Off -> Setting
(1)
Applicable Operating Mode All
Modbus Address15
(1) Refer to Setting Values for Parameters [Pr - 0.10]…[Pr - 0.21] on page 61.
58Rockwell Automation Publication 2071-RM001B-EN-P - April 2013
Standard Drive ParametersAppendix A
[Pr - 0.15]Allocation of Input Signals 6
Data Size4 digits
DigitDescription DefaultUnmapped IO
Status
0Reset multi-turn data of absolute
0x0OFF
encoder (R_ABS)
1Gain bank select (BANK_SEL) 0x0OFF
2Reserved 0x0OFF
3Reserved 0x0OFF
When Enabled Servo-Off -> Setting
(1)
Applicable Operating Mode All
Modbus Address16
(1) Refer to Setting Values for Parameters [Pr - 0.10]…[Pr - 0.21] on page 61.
[Pr - 0.16]Allocation of Input Signals 7
Data Size4 digits
DigitDescriptionDefaultUnmapped IO
Status
0Home sensor (H_SENS)0x0OFF
1Start homing (SHOME)0x0OFF
2Stop indexing (STOP)0x0OFF
3Pause indexing (PAUSE)0x0OFF
When Enabled Ser vo-Off -> Setting
(1)
Applicable Operating Mode Indexing
Modbus Address17
(1) Refer to Setting Values for Parameters [Pr - 0.10]…[Pr - 0.21] on page 61.
[Pr - 0.17]Allocation of Input Signals 8
Data Size4 digits
DigitDescriptionDefaultUnmapped IO
Status
0Index select 0 input (I_SEL0)0x0OFF
1Index select 1 input (I_SEL1)0x0OFF
2Index select 2 input (I_SEL2)0x0OFF
3Index select 3 input (I_SEL3)0x0OFF
When Enabled Ser vo-Off -> Setting
(1)
Applicable Operating Mode Indexing
Modbus Address18
(1) Refer to Setting Values for Parameters [Pr - 0.10]…[Pr - 0.21] on page 61.
Rockwell Automation Publication 2071-RM001B-EN-P - April 201359
Appendix AStandard Drive Parameters
[Pr - 0.18] Allocation of Input Signals 9
Data Size 4 digits
Digit Description Default Unmapped IO
Status
0 Index select 4 input (I_SEL4) 0x0 OFF
1 Index select 5 input (I_SEL5) 0x0 OFF
2 Stop homing (H_STOP) 0x0 OFF
3 Start index (START_I) 0x0 OFF
When Enabled Servo-Off -> Setting
(1)
Applicable Operating Mode Indexing
Modbus Address19
(1) Refer to Setting Values for Parameters [Pr - 0.10]…[Pr - 0.21] on page 61.
[Pr - 0.19]Allocation of Input Signals 10
Data Size4 digits
DigitDescriptionDefaultUnmapped IO
Status
0Reserved 0x0OFF
1Reserved0x0OFF
2Reserved 0x0OFF
3Reserved0x0OFF
When EnabledReserved
Applicable Operating ModeIndexing
Modbus Address 20
[Pr - 0.20]Allocation of Input Signals 11
Data Size4 digits
DigitDescriptionDefaultUnmapped IO
0Reserved 0x0OFF
1Reserved0x0OFF
2Reserved 0x0OFF
3Reserved0x0OFF
When EnabledReserved
Applicable Operating ModeIndexing
Modbus Address 21
60Rockwell Automation Publication 2071-RM001B-EN-P - April 2013
Applicable Operating Mode Follower, Analog Speed, Preset
Modbus Address108
[Pr - 1.09] Position Command Lowpass Filter Bandwidth
Ultraware NameMain Position Regulator Gains: Low Pass Filter Bandwidth
Range0…1000
Default0
UnitsHz
When Enabled Immediately
Applicable Operating Mode Follower
Modbus Address109
[Pr - 1.10]1st Resonant Frequency Suppression Filter
Ultraware NameMain Current Regulator Gains: 1st Resonant Frequency
DescriptionSuppresses Vibration by cutting off Current Command in
Range0…10,000
Default10,000
UnitsHz
When Enabled Immediately
Applicable Operating Mode All
Modbus Address110
Suppression Filter
assigned frequency band
Rockwell Automation Publication 2071-RM001B-EN-P - April 201369
Appendix AStandard Drive Parameters
[Pr - 1.11]1st Resonant Frequency Suppression Filter Width
Ultraware NameMain Current Regulator Gains: 1st Resonant Frequency
Suppression Filter Width
DescriptionSet up the notch width of 1st resonance suppressing filter
in 20 steps. Higher the setup, larger the notch width you
can obtain.
Range1…20
Default10
Units
When Enabled Immediately
Applicable Operating Mode All
Modbus Address111
[Pr - 1.12]2nd Resonant Frequenc y Suppression Filter
Ultraware Name2nd Main Current Regulator Gains: 2nd Resonant
Frequency Suppression Filter
DescriptionSuppresses Vibration by cutting off Current Command in
assigned frequency band
Range0…10,000
Default10,000
UnitsHz
When Enabled Immediately
Applicable Operating Mode All
Modbus Address112
[Pr - 1.13]2nd Resonant Frequenc y Suppression Filter Width
Ultraware NameMain Current Regulator Gains: 2nd Resonant Frequency
DescriptionSet up the notch width of 2nd resonance suppressing
Range1…20
Default10
Units-
When Enabled Immediately
Applicable Operating Mode All
Modbus Address113
Suppression Filter Width
filter in 20 steps. The higher the setup, larger the notch
width you can obtain.
70Rockwell Automation Publication 2071-RM001B-EN-P - April 2013
Standard Drive ParametersAppendix A
[Pr - 1.14]2nd Resonant Frequenc y Suppression Filter Depth
Ultraware NameMain Current Regulator Gains: 2nd Resonant Frequency
DescriptionSet up the 2nd notch depth of the resonance suppressing
Range0…100
Default100
Units-
When Enabled Immediately
Applicable Operating Mode All
Modbus Address114
[Pr - 1.15]Position Regulator Kff gain
Ultraware NameMain Position Regulator Gains: Kff
Range0…100
Default0
Units%
When Enabled Immediately
Applicable Operating Mode Follower
Modbus Address115
Suppression Filter Depth
filter. The higher the setup, the shallower the notch depth
and the smaller the phase delay you can obtain.
[Pr - 1.16]Position Regulator Kff Bandwidth
Ultraware NameMain Position Regulator Gains: Kff Low Pass Filter
Range0…2500
Default200
UnitsHz
When Enabled Immediately
Applicable Operating Mode Follower
Modbus Address116
Bandwidth
Rockwell Automation Publication 2071-RM001B-EN-P - April 201371
Appendix AStandard Drive Parameters
[Pr - 1.17]Velocity Regulator I Gain Mode
Ultraware NameMain Velocity Regulator Gains: I Gain Mode
DescriptionDuring transient response, Speed Response Overshoot can
RangeValue Description
Default0
When Enabled Servo-Off -> Setting
Applicable Operating Mode All
Modbus Address117
be suppressed by a speed controller change from a
Proportional Integral (PI) controller into a Proportional (P)
controller. It reduces position completion time during
position control.
0x0Do not use P/PI Mode
0x1When Current Command
0x2When Speed Command
0x3When Position error
0x4Automatically velocity
Convers ion.
exceeds Current Value in
[Pr - 1.18], Speed
Controller is changed from
PI Controller to P Controller.
exceeds Speed Value in
[Pr - 1.18]
, Speed
Controller is changed from
PI Controller to P Controller.
exceeds Position error
Value in [Pr - 1.18]
Controller is changed from
PI Controller to P Controller.
controller is changed from
PI Controller to P Controller.
, Speed
72Rockwell Automation Publication 2071-RM001B-EN-P - April 2013
Standard Drive ParametersAppendix A
[Pr - 1.18]Velocity Regulator I Gain Disable Threshold
Ultraware NameMain Velocity Regulator Gains: I Gain Disable Threshold
Range0…3000
Default100
UnitsIf [Pr - 1.17] = 1, units are % of rated continuous current
If [Pr - 1.17] = 2, units are rotary motors: rpm; linear
motors: mm/s
If [Pr - 1.17] = 3, units are Counts
When Enabled Follower, Analog Velocity, Preset
Applicable Operating Mode Immediately
Modbus Address118
[Pr - 1.19]Position Regulator High Error Output Offset
Ultraware NameMain Position Regulator Gains: High Error Output Offset
Range0…450
Default0
UnitsRotary motors: rpm; Linear motors: mm/s
When Enabled All
Applicable Operating Mode Immediately
Modbus Address119
[Pr - 1.20]Position Regulator High Error Output Threshold
Ultraware NameMain Position Regulator Gains: High Error Output
Range0…50,000
Default1000
UnitsCounts
When Enabled All
Applicable Operating Mode Immediately
Modbus Address120
Threshol d
Rockwell Automation Publication 2071-RM001B-EN-P - April 201373