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
Loading...
+ 116 hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.