Motion Rm003 en P
Motion Rm003 en P
Motion Rm003 en P
EtherNet/IP Network
ControlLogix, CompactLogix, Kinetix 350, Kinetix 5500,
Kinetix 5700, Kinetix 6500, PowerFlex 527, PowerFlex 755
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.
IMPORTANT Identifies information that is critical for successful application and understanding of the product.
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.
ARC FLASH HAZARD: Labels may be on or inside the equipment, for example, a motor control center, to alert people to potential Arc Flash. Arc Flash
will cause severe injury or death. Wear proper Personal Protective Equipment (PPE). Follow ALL Regulatory requirements for safe work practices and
for Personal Protective Equipment (PPE).
Global changes
This table identifies changes that apply to all information about a subject
in the manual and the reason for the change. For example, the addition
of new supported hardware, a software design change, or additional
reference material would result in changes to all of the topics that deal
with that subject.
Subject Reason
Updated branding Throughout
Current Control Configuration Attributes on page 265 Updated Current Vector Limit, Kqp, Kqi, Kdp, Kdi, Flux Up
Control, Flux Up Time, Commutation Offset, Commutation
Self-Sensing Current, Commutation Polarity, Commutation
Alignment, Commutation Offset Compensation.
Frequency Control Signal Attribute on page 284 Updated Access Rule column.
Drive Output Attributes on page 368 Updated Output Frequency, Output Current, Output
Voltage, Output Power, and PWM Frequency.
Stopping Sequences on page 606 Updated Category 0 Sequence steps and diagram.
Converter AC Line Configuration Attributes on page 634 Added Demonstration Mode Select attribute.
Kinetix 6500 Drive Module Optional Attributes on page 187 Updated the Conditional Implementation column for
attributes 590, 608, and 609. Added attributes 836, 844,
876, 987, 985, 984, 2359, 617, 850, 2353, 2356, 618, 381, 281,
1351, 1348, 694, 1355, 2315, 1357, 590, 843, 591, and 609.
Replaced Y values with N values.
Converter Current Reference Configuration Attributes on Added Kc attribute. Updated Active Current Command,
page 649 Reactive Current Command, Active Current Trim, Active
Current Low Pass Filter Bandwidth, Active Current Notch
Filter Frequency, Active Current Rate Limit, and Reactive
Current Rate Limit.
Chapter 2
Behavior models used in CIP Acceleration Control Behavior.................................................... 31
Acceleration Limiter............................................................... 32
Motion Load Observer ...................................................................... 32
Command Generation Behavior ................................................. 34
Command Data Sources ....................................................... 34
Command Fine Interpolation ................................................. 35
Command Ramp Generator .................................................. 38
Feedforward Signal Selection ............................................... 39
Command Notch Filter .......................................................... 40
Current Control Behavior ............................................................ 40
Current Vector Limiter ........................................................... 41
Voltage Output ...................................................................... 42
Current Feedback ................................................................. 42
Motor Commutation............................................................... 42
Event Capture Behavior ............................................................. 43
Event Input Sources .............................................................. 44
Event Latches ....................................................................... 44
Event Time Stamps ............................................................... 44
Fault and Alarm Behavior ........................................................... 45
Exceptions ............................................................................ 45
Absolute Position Recovery .................................................. 47
Absolute Position Loss without APR Faults ..................... 48
APR Fault Conditions ...................................................... 48
APR Fault Generation...................................................... 49
APR Fault Examples........................................................ 50
APR Recovery Scenarios ................................................ 51
Reset an APR Fault ......................................................... 54
Motion Control Axis Behavior Model .......................................... 54
Active Control Axis Behavior Model ...................................... 55
Feedback Only Axis Behavior Model .................................... 57
CIP Motion Non-regenerative Converter Axis Behavior Model
.............................................................................................. 58
Motor Attributes Model .......................................................... 60
Position Control Behavior...................................................... 60
Rockwell Automation Publication MOTION-RM003L-EN-P - September 2020 11
Table of Contents
Position Feedback Selection ........................................... 61
Position PI Gains ............................................................. 62
Velocity Feedforward ....................................................... 62
Position Loop Output Filters ............................................ 63
State Behavior ...................................................................... 63
Torque Control Behavior ....................................................... 73
Torque Input Sources ...................................................... 74
Inertia Compensation....................................................... 75
Friction Compensation ..................................................... 77
Torque filters .................................................................... 79
Torque Limiter ................................................................. 81
Torque to Current Scaling................................................ 81
Velocity Control Behavior ...................................................... 82
Closed Loop Velocity Control .......................................... 83
Open Loop Frequency Control ........................................ 86
Chapter 3
Interpret the Attribute Tables Attribute Units ............................................................................ 92
CIP Data Types.......................................................................... 93
Device Function Codes .............................................................. 93
Required vs. Optional Axis Attributes ......................................... 94
Identify Motion Axis Attributes Based on Device Function Codes
................................................................................................... 97
Attribute Conversion from SERCOS to Integrated Motion on the
Ethernet/IP Network ................................................................. 114
Drive Supported Optional Attributes ......................................... 117
Kinetix 350 Drive Module Optional Attributes ...................... 118
Kinetix 5500 Hardwired STO Drive Module Optional Attributes
............................................................................................ 125
Kinetix 5500 Integrated STO Drive Module Optional Attributes
............................................................................................ 133
Kinetix 5700 Safety Drive Module Optional Attributes ......... 140
Kinetix 5700 Advanced Safety Drive Module Optional
Attributes ............................................................................. 148
Kinetix 5700 CIP Safety (EtherNet/IP) Module Optional
Attributes ............................................................................. 156
Kinetix 5700 CIP Advanced Safety (EtherNet/IP) Module
Optional Attributes .............................................................. 166
Kinetix 5700 Regenerative Bus Supply Module Optional
Attributes ............................................................................. 177
Kinetix 6500 Drive Module Optional Attributes .................... 187
PowerFlex 527 Axis Instance Optional Attributes ............... 195
PowerFlex 755 Standard Drive Module Optional Attributes 200
PowerFlex 755 High Power, Standard Drive Module Optional
Attributes ............................................................................. 206
PowerFlex 755 Low Power, Non-Network Safety Drive Module
Optional Attributes .............................................................. 212
PowerFlex 755 High Power, Non-Network Safety Drive
Module Optional Attributes .................................................. 218
Chapter 4
CIP Axis Attributes Control Mode Attributes ........................................................... 246
Acceleration Control Attributes............................................ 246
Acceleration Control Configuration Attributes ..................... 247
Command Reference Generation Attributes ....................... 249
Command Generator Configuration Attributes ............... 249
Command Generator Signal Attributes .......................... 253
Current Control Configuration Attributes ............................. 265
Current Control Signal Attributes ........................................ 270
Frequency Control Configuration Attributes ........................ 280
Frequency Control Signal Attribute ..................................... 284
Position Loop Signal Attributes ........................................... 285
Position Loop Configuration Attributes ................................ 287
Torque/Force Control Configuration Attributes.................... 291
Motor Adaptation Attributes................................................. 312
Torque/Force Control Signal Attributes ............................... 317
Velocity Loop Configuration Attributes ................................ 318
Velocity Loop Signal Attributes ........................................... 325
Data Attributes.......................................................................... 330
Axis Info Attributes .............................................................. 330
Frequency Analysis Attributes............................................. 332
Data Logging Attributes....................................................... 335
Axis Statistical Attributes ..................................................... 338
CIP Axis Status Attributes ................................................... 339
Event Capture Attributes ..................................................... 356
Drive Attributes ......................................................................... 361
Drive General Purpose I/O Attributes .................................. 361
Drive Output Attributes ........................................................ 368
Power and Thermal Management Configuration Attributes. 370
Power and Thermal Management Status Attributes............ 371
Drive Commissioning and Tuning Attributes............................. 383
Auto-Tune Configuration Attributes ..................................... 383
Hookup Test Configuration Attributes ................................. 391
Hookup Test Result Attributes ............................................ 392
Inertia Test Configuration Attributes .................................... 395
Inertia Test Result Attributes ............................................... 398
Motor Test Result Attributes................................................ 401
Motor Test Configuration Attributes..................................... 404
Faults and Alarms Attributes .................................................... 405
APR Fault Attributes............................................................ 405
Axis Exception Action Configuration Attributes ................... 407
Axis Exception Action .................................................... 411
Configuration Fault Attributes.............................................. 415
Chapter 5
Module Configuration Attributes Module Configuration Block Attributes ..................................... 677
Module Class Attributes ........................................................... 678
Module Axis Attributes .............................................................. 680
Module Feedback Port Attributes ............................................. 695
Module Timing Attributes .......................................................... 696
Module Support Attributes ........................................................ 698
Index
Additional Resources Use the following resources to get additional information concerning
related products and technologies:
Publication Title Description
CompactLogix™ 5370 Controllers User Manual, Describes the necessary tasks to install, configure,
publication 1769-UM021 program, and operate a CompactLogix 5370
controller.
ControlLogix® System User Manual, publication 1756- Describes the necessary tasks to install, configure,
UM001 program, and operate a ControlLogix system.
EtherNet/IP Network Configuration User Manual, Describes Ethernet network considerations,
publication ENET-UM001 networks, and setting IP addresses.
Integrated Architecture® and CIP Sync Configuration Provides detailed configuration information on CIP
Application Technique, publication IA-AT003 Sync Technology and time synchronization.
Integrated Motion on the EtherNet/IP Network Describes how to configure an integrated motion
Configuration and Startup User Manual, publication application and to start up your motion solution by
MOTION-UM003 using the ControlLogix system.
Kinetix® 6200 and Kinetix 6500 Modular Mutli-axis Provides information on how to install, configure, and
Servo Drives User Manual, publication 2094-UM002 troubleshoot applications for your Kinetix 6200 and
Kinetix 6500 servo drive systems.
Kinetix 6200 and Kinetix 6500 Safe Speed Monitoring Provides information on wiring, configuring, and
Safety Reference Manual, publication 2094-RM001 troubleshooting the safe-speed features of your
Kinetix 6200 and Kinetix 6500 drives.
Kinetix 6200 and Kinetix 6500 Safe Torque Off Safety Provides information on wiring, configuring, and
Reference Manual, publication 2094-RM002 troubleshooting the safe torque-off features of your
Kinetix 6200 and Kinetix 6500 drives.
Kinetix 5500 Servo Drives User Manual, publication Provides information on install, configure, and
2198-UM001 troubleshoot applications for your Kinetix 5500 drive.
Kinetix 5700 Servo Drives User Manual, publication Provides information on install, configure, and
2198-UM002 troubleshoot applications for your Kinetix 5700 drive.
Kinetix 350 Single-axis EtherNet/IP Servo Drives User Provides information on install, configure, and
Manual, publication 2097-UM002 troubleshoot applications for your Kinetix 350 Single-
axis EtherNet/IP Servo drive.
Kinetix Safe-off Feature Safety Reference Manual, Provides information on wiring and troubleshooting
publication GMC-RM002 your Kinetix 6000 and Kinetix 7000 servo drives with
the safe torque-off feature.
Logix5000™ Motion Controllers Motion Instructions Provides a programmer with details about motion
Manual, publication MOTION-RM002 instructions for motion control.
Logix5000 Controllers Common Procedures, Provides detailed and comprehensive information
publication 1756-PM001 about how to program a Logix5000 controller.
Logix5000 Controllers General Instructions Reference Provides a programmer with details about general
Manual, publication 1756-RM003 instructions for a Logix-based controller.
Logix5000 Controllers Advanced Process Control and Provides a programmer with details about process
Drives Instructions Reference Manual, publication and drives instructions for a Logix-based controller.
1756-RM006
Motion Coordinate System User Manual, publication Provides details on how to create and configure a
MOTION-UM002 coordinate motion system.
Legal Notices Rockwell Automation publishes legal notices, such as privacy policies,
license agreements, trademark disclosures, and other terms and
conditions on the Legal Notices page of the Rockwell Automation
website.
Integrated Motion Axis The Motion Control Axis Object covers the behavior of various motion
control system devices that includes feedback devices, drive devices,
Control Modes and Methods standalone regenerative and non-regenerative converters, and motion
I/O devices. For drive devices, the Motion Control Axis Object covers a
wide range of drive types from simple variable frequency (V/Hz) drives,
to sophisticated position control servo drives, with or without integral
converters. Many commercial drive products have axes that can be
configured with instructions to operate in any one of these different
motion control modes depending on the specific application
requirements.
See also
Motion Control Modes on page 22
Motion Control Methods on page 27
Motion Instruction Compatibility on page 28
Device Function Codes on page 93
Identify Motion Axis Attributes Based on Device Function Codes
on page 97
Motion Control Modes Motion control modes are organized around the general philosophy that
position control is the highest form of dynamic control. That is, position
control implies velocity control, and velocity control implies acceleration
control.
Acceleration is related to torque or force by the inertia or mass of the
load; respectively, acceleration control implies torque control. Because
motor torque or force is generally related to motor current by a torque or
force constant, respectively, torque control implies current control. The
torque or force constant can be a function of the motor magnets as in a
Permanent Magnet motor, or the induced flux of an Induction motor.
Because acceleration, torque/force, and current are generally related by
a constant, these terms are sometimes used interchangeably in the
industry. For example, a torque control loop rather than a current control
loop. Motion Control Axis Attributes let you differentiate between these
control properties. This is useful when the relationship between them is
not static, such as when inertia/mass changes with position or time, or
when the torque/force constant changes due to temperature change or
motor flux variation.
The Control Modes are:
• B - Bus Power Converters (No Control Mode, No Control
Method)
• E - Encoder, Feedback Only (No Control Mode, No Control
Method)
• P - Position Control Mode
• V - Velocity Control Mode
• T - Torque Control Mode
• F - Velocity Control Mode
See also
Position Control Mode on page 23
Velocity Control Mode on page 24
Torque Control Mode on page 25
No Control Mode on page 26
Position Control Mode In Position Control application mode either the application control
program (command execution function) or the motion planner (move
trajectory control function) provide a setpoint value to the CIP Motion
device using the cyclic data connection. The Position Control method
can be either open loop or closed loop.
See also
Motion Control Modes on page 22
Velocity Control Mode In Velocity Control application mode the application control program
and motion planner provide a setpoint value to the CIP Motion device
using the cyclic data connection. The velocity control method can be
either open loop or closed loop.
See also
Motion Control Modes on page 22
Torque Control Mode In Torque Control application mode, the application control program or
the motion planner provide torque setpoint values to the device using
the cyclic data connection. Because motor current and motor torque are
See also
Motion Control Modes on page 22
No Control Mode The Motion Control Axis Object supports a No Control application mode
where there is no dynamic motor control function. This mode is often
used to support Feedback Only or Master Feedback functionality where
a feedback channel in a CIP Motion Drive device is serving as a master
feedback source to the rest of the control system. This mode could also
be applied to integrated CIP Motion Encoder device types where the
CIP Motion interface is applied directly to an Encoder.
In this No Control mode of operation, no command value is supplied to
the CIP Motion device using the cyclic data connection, but actual
position, velocity, and acceleration can be produced by the device to
the controller using the cyclic data channel, if applicable. The No
Control mode for Feedback Only functionality is illustrated in the
following diagram:
No Control mode also applies to other CIP Motion device types, such as
standalone Bus Power Converters and dedicated Motion I/O device
types. Since there is no feedback channel that is associated with these
device types, no actual position is returned to the controller.
See also
Motion Control Modes on page 22
Motion Control Methods Within this basic motion control paradigm, there is latitude for different
control methods, both closed loop and open loop. By closed loop, it is
implied that there is a feedback signal that is used to drive the actual
dynamics of the motor to match the commanded dynamics by servo
action.
In most cases, there is a literal feedback device to provide this signal,
and in some cases the signal is derived from the motor excitation, for
example, sensorless/encoderless operation.
By open loop, it is implied that there is no application of feedback to
force the actual dynamics to match the commanded dynamics. While
precision and performance are the hallmarks of closed loop control,
simplicity and economy are the hallmarks of open loop control.
The Control Method attribute is an 8-bit enumerated code that
determines the basic control algorithm. The device applies the algorithm
to control the dynamic behavior of the motor that is associated with an
axis. The Control Methods related to the Control Modes are listed in the
following table.
Axis configuration
The Control Mode and Control Method are derived by the Axis
Configuration according to the following table.
See also
Motion Control Modes on page 22
Motion Instruction The following table correlates the motion instructions with the
compatible control modes. The compatibility with integrated motion is
Compatibility based on the Axis Configuration and feedback type settings. The
motion instructions tables are divided by type.
Use the following key to interpret the column entries:
Symbol Meaning
x Control mode is compatible.
MSO and MDS execution initiate mutually exclusive modes of operation and execution is
#
conditional on mode.
* Axis may be used as a master axis reference only for this instruction.
Axis may conditionally use Motion Planner instructions if enabled with MSO instruction,
c
otherwise, it errors.
Shaded areas denote that Multi-Axis Coordination Motion is designed and tested for position
mode operation but not specifically restricted to that axis configuration.
Category Motion Instruction Name Abbr. Feedback Freq.Cntrl Pos. Vel. Loop Vel. Loop Torque
Only No Feedback Loop Feedback No Feedback Loop
State Control Motion Direct Drive On MDO
Motion Direct Drive Off MDF
Motion Servo On MSO # x # # #
Motion Servo Off MSF x x x x x
Motion Axis Fault Reset MAFR x x x x x x
Motion Axis Shutdown MASD x x x x x x
Motion Axis Shutdown Reset MASR x x x x x x
Motion Drive Start MDS # # # #
Event Control Motion Arm Watch Position MAW x x x x
Motion Disarm Watch Position MDW x x x x
Motion Arm Registration MAR x x x x
See also
Control Modes on page 22
Control Methods on page 27
Control systems and algorithms are used to discuss the CIP motion
attributes. Conceptual diagrams and feature descriptions are provided
to help orient you to the various components of CIP motion.
Behavior models
Acceleration Control Behavior on page 31 Motor Attributes Model on page 60
Command Generation Behavior on page 34 Position Control Behavior on page 60
Current Control Behavior on page 40 State Behavior on page 63
Event Capture Behavior on page 43 Torque Control Behavior on page 73
Fault and Alarm Behavior on page 45 Velocity Control Behavior on page 82
Motion Control Axis Behavior Model on page 54
See also
Standard Exceptions on page 662
Interpret the Attribute Tables on page 89
Acceleration Control While dynamic motor control through an acceleration command is not
common in the industry, Acceleration Control completes the dynamic
Behavior progression from Velocity Control to Torque Control. The output of the
velocity loop, Velocity Loop Output, also has units of acceleration. The
sum the contributions of the Acceleration Command, Acceleration Trim,
and Velocity Loop Output to form the Acceleration Reference signal that
serves as one of the primary inputs to Torque Control behavior.
Acceleration Control can optionally include a Load Observer to
compensate for mechanical backlash, mechanical compliance, and
various load disturbances.
The following diagram provides an overview of the Acceleration Control
behavior model, including the Load Observer.
See also
Acceleration Limiter on page 32
Load Observer on page 32
Acceleration Limiter The output of the acceleration command summing junction signal
passes through a limiter to produce the Acceleration Reference signal.
The Accel Limiter applies a directional acceleration limit, either the
Acceleration Limit or the Deceleration Limit, to the input command
signal based on the sign of the signal.
The following diagram illustrates this process.
See also
Load Observer on page 32
Acceleration Control Behavior on page 31
Load Observer Acceleration Control can optionally include a Load Observer. Feeding
the Acceleration Reference into a Load Observer, along with the
velocity feedback signal, has been found to be effective in
compensating for mechanical backlash, mechanical compliance, and
various load disturbances.
The Load Observer's effectiveness in this regard can be thought of as a
result of the observer adding virtual inertia to the motor. When the
observer is enabled, it functions as an inner feedback loop, like the
current loop, but unlike the current loop in that the observer's control
loop includes the motor mechanics.
Due to the work of the Load Observer, variations in load inertia, mass,
and even the motor's torque/force constant can be nearly eliminated as
seen by the velocity loop. In fact, because the Load Observer includes
the Acceleration Reference signal as an input, it can provide a velocity
estimate signal that has less delay than the velocity feedback estimate
generated by the actual feedback device. Thus, applying the Load
Observer's velocity estimate to the velocity loop can be used to improve
the performance of the velocity loop.
See also
Acceleration Control Behavior on page 31
Torque Control Behavior on page 73
Velocity Control Behavior on page 82
See also
Command Data Sources on page 34
Command Fine Interpolation on page 35
Command Ramp Generator on page 38
Feedforward Signal Selection on page 39
Command Notch Filter on page 40
Command Data Sources Command data that impacts axis motion can come from a variety of
sources. The most common command data source is from a controller-
based Motion Planner using the CIP Motion C-to-D Connection. In this
context, command data can take the form of Controller Position,
Velocity, Acceleration, and Torque Commands generated by the Motion
Planner. The command data elements provided are specified by the
See also
Command Generation Behavior on page 34
Command Fine Interpolation For synchronized, high-performance applications using CIP Motion,
command data is received from the CIP Motion C-to-D Connection or
the device's local Motion Planner, and based on the connection's
Command Target Update element being set to 'Interpolate', processed
by the Fine Interpolator functionality of the Command Generator.
The job of the Fine Interpolator is to compute coefficients to a trajectory
polynomial that is designed to reach the command data at its
associated Command Target Time. Depending on the specific
command data element, the trajectory can follow a 1st, 2nd, or 3rd order
polynomial trajectory with initial conditions based on current axis
dynamics.
Because the polynomial is a function of time, a new fine command
value can be calculated any time the CIP Motion device needs to
perform a control calculation. As a result, it is not necessary that the
device's control calculation period be integrally divisible into the
Controller Update Period.
In these equations, time (t0), represents the Command Target Time for
the previous Motion Planner update such that when t = t0, the position
(P), velocity (V), acceleration (A), and torque (T) command values are
equal to the values sent in the previous Motion Planner update, for
example, P–1, V–1, A–1, and T–1. This establishes the 0th order
coefficients of the polynomials.
• P(t0) = P–1 = a0
• V(t0) = V–1 = b0
• A(t0) = A–1 = c0
• T(t0) = T–1 = d0
The higher order polynomial coefficients are calculated such that by the
next Motion Planner update, corresponding to Command Target Time,
t1, the position, velocity, acceleration, and torque command values are
the values sent in the latest Motion Planner update, for example, P0, V0,
A0, and T0.
• P(t1) = P0
• V(t1) = V0
• A(t1) = A0
• T(t1) = T0
Using the above polynomial interpolation equations, the CIP Motion
device can compute position, velocity, acceleration, and torque
command values at any time by plugging in the current System Time
value of the device into the variable, t. This allows the device's control
calculation to be performed according to a schedule that is independent
of the controller's update schedule.
One thing that must be done, however, is to adjust the Command
Target Time, t0, if there is a shift in the System Time Offset for the
device; t0 and t are always based on the same System Time reference
system. For example, assume the device's System Time Offset when
the control command timestamp, t0, was received as Offset0. If the
command interpolation equation is to be applied at t= t1 and the current
System Time Offset is defined as Offset1, then t0 is adjusted as follows
before executing the polynomial:
See also
Command Generation Behavior on page 34
Command Ramp Generator When operating in Closed Loop Velocity mode, the Ramp Generator
feature of the Velocity Fine Command Generator block is applied to the
Controller Velocity Command value sent by the controller when the
Command Target Update element of the connection is set to
‘Immediate’ mode. In Immediate mode, Command Data is applied
immediately to the devices’ control structure without fine interpolation or
extrapolation. Since there is generally no motion planner generating the
Command Data in this mode, the Command Data value from the
controller can change drastically from one update to the next. To
address this condition, a Ramp Generator function is needed to ramp
the motor to the new Controller Velocity Command Data value within
the dynamic limitations of system. For example, if the Controller Velocity
Command value suddenly changed from 0 to 30 revolutions per second
in Immediate Mode, the Ramp Generator would produce a Fine Velocity
Command signal that accelerates the motor to the Controller Velocity
Command value based on the configured Ramp Acceleration and Jerk
Control attribute values. The Ramp Jerk Control attribute determines
what percentage of the acceleration or deceleration ramps is S-Curve
with the remaining portion of the ramp governed by the fixed Ramp
Acceleration or Deceleration attribute values.
When operating in Closed Loop Velocity mode, the Ramp Generator
feature of the Velocity Fine Command Generator block allows the motor
to ramp to zero speed, as part of a Ramped Decel stopping action,
regardless of the value of the Command Target Update element.
Likewise, when operating in Closed Loop Position mode, the Ramp
See also
Command Generation Behavior on page 34
Feedforward Signal The Fine Command Generators can generate higher derivatives of the
command data input to serve as feedforward signals. The units for the
Selection velocity and acceleration feedforward signals are generally different
than the derivative units, hence the derivative signals are scaled
appropriately. Superior signal quality, however, can be provided by the
Motion Planner trajectory generators. The feedforward selection blocks
pick the best feedforward signal to apply based on the bits set in the
Command Data Set attribute. The best signal is defined as the signal
derived by using the fewest differencing operations.
The Fine command position is applied directly to the Position Control
loop without any of the typical de-referencing and offsets. It is assumed
that these operations are performed by the controller or device based
Motion Planner.
Feedforward signals are only applicable for Closed Loop Position and
Closed Loop Velocity Control Modes.
See also
Command Generation Behavior on page 34
Command Notch Filter Position command and feedforward signals pass through one or more
command notch filters. These filters reduces anti-resonance behavior of
a compliant motor load by filtering out any commanded motion around
the anti-resonance frequencies.
See also
Command Generation Behavior on page 34
Current Control Behavior In general, motor torque is controlled by controlling the orientation and
magnitude of the motor stator current vector with respect to the rotor
magnetic flux vector. The Current control loop is responsible for
providing this control and is actually composed of two PI loops, one that
controls the torque producing current, Iq, and one that controls the flux
producing current, Id. It is the quadrature component of current, Iq, that
is used for dynamic Torque Control.
In the case of an induction motor, the flux producing current, Id, is solely
responsible for generating rotor flux. In the case of permanent magnet
motors, rotor flux is generated by the rotor magnets and Id is used only
in some cases to extend the speed range of the motor by changing the
angle of the stator field relative to the rotor field. In this case, the angle
of Iq relative to the rotor field remains the same, for example, at
quadrature. However, because the vector combination of Iq and Id
determines the stator flux angle relative to the rotor, increasing amounts
of Id can shift the stator flux away from quadrature to extend the speed
range of the motor at the expense of torque.
See also
Current Vector Limiter on page 41
Voltage Output on page 42
Current Feedback on page 42
Motor Commutation on page 42
Current Vector Limiter The Iq Current Command passes through a Current Vector Limiter
before becoming the Iq Current Reference signal. This limiter computes
the combined vector magnitude of the Iq Current Reference and the Id
Current Reference signals. The resultant current vector magnitude is
compared to the Operative Current Limit that represents the minimum
current limit from among a set of potential current limits of the drive
device and motor.
If the vector magnitude exceeds the Operative Current Limit, the Iq
Current Reference is reduced so the vector magnitude equals the
Operative Current Limit. Potential current limit sources can be the Peak
Current Limit ratings as well as the Thermal Limits for the Motor and
Drive Inverter. Another possible limit source is the user-configurable
Current Vector Limit attribute.
Some of these limits are conditional and dynamic, such as the Motor
and Inverter Thermal Current Limits derived from the thermal models for
these devices. These limits are active only when the corresponding
See also
Current Control Behavior on page 40
Voltage Output The output of each current loop is scaled by the motor inductance to
generate a voltage command to the vector transformation block. It is
the job of the vector transformation block to transform the torque
producing, Vq, and flux producing, Vd, command signals from the
rotating synchronous reference frame to the stationary stator reference
frame. The resultant U, V, and W Output Voltage values are then
applied to the motor by Pulse Width Modulation (PWM). The PWM
Frequency is also a configurable attribute.
The magnitude of the Vq, Vd vector is calculated in real time as the total
Output Voltage signal. The maximum Output Voltage signal that can be
applied to the motor is ultimately limited by the DC Bus Voltage and
enforced by the Voltage Vector Limiter. Any attempt to exceed this
value results in an Inverter Voltage Limit condition.
See also
Current Control Behavior on page 40
Current Feedback Current feedback signals to the current loop are provided by two or
three current sensors. The signals from these sensors are conditioned
and corrected for device specific offsets to become the U, V, and W
Current Feedback signals associated with the stationary motor stator
frame. These three signals are transformed back to the synchronous
reference frame to generate the Iq and Id Current Feedback signals.
The magnitude of the Iq, Id current vector is calculated in real-time and
used as an input to the thermal models for the inverter and motor.
See also
Current Control Behavior on page 40
Motor Commutation Motor commutation is critical to closed loop motor control. The
orientation of the motor rotor can be determined from a feedback
source mounted to the motor. The actual commutation source is the
motor feedback device assigned to Feedback 1 or, possibly, the
redundant feedback channel assigned to Feedback 1. Once the
feedback device is calibrated to the absolute orientation of the rotor by
using the Commutation Offset attribute, the commutation block can then
See also
Current Control Behavior on page 40
Event Capture Behavior Event capture behavior captures both the feedback position and time
stamp associated with specific state transitions of selected event input
sources.
The following diagram provides an overview of the event capture
behavior model.
See also
Event Input Sources on page 44
Event Latches on page 44
Event Time Stamps on page 44
Event Input Sources The Motion Device Axis Object defines a mechanism to capture both
the feedback position and time stamp associated with specific state
transitions of selected event input sources. Event input sources
currently supported by the object are:
• Registration 1
• Registration 2
• Marker
• Home Switch.
These event input sources apply to each supported feedback channel.
See also
Event Capture Behavior on page 43
Event Latches To facilitate accurate capture of both feedback position and time,
hardware event latches are typically implemented.
Two independent latches are defined for each registration input, one
latch to capture positive edge transition events and one to capture
negative edge transition events. This design enables capture of both
registration events in applications with narrow registration pulses where
the rising and falling edges occur nearly simultaneously.
In addition to the registration latches, a separate latch is also defined for
the home event capture. The home input event that triggers the Home
Event Latch can be any of a number of different combinations of home
switch and marker input events, for example, marker transitions, switch
transitions, or switch transitions followed by a marker transition.
With hardware-based event latches, event capture accuracy is, in
general, only limited by the latency of the associated event input.
Registration and Marker event inputs are lightly filtered so event capture
accuracy is on the order of 1 microsecond (µsec). In terms of position
capture accuracy, that would be calculated as the product of the event
capture accuracy and the speed of the axis. Home switch inputs are
heavily filtered, in general, and therefore limited to an event capture
accuracy of 1 to 10 millisecond (msec). Thus, to get an accurate
position capture based on a home switch input transition, a homing
sequence with a slow homing speed is required.
See also
Event Capture Behavior on page 43
Event Time Stamps Because the registration time stamp is passed to the controller as part
of the Event Notification data, the controller can apply the event time
See also
Event Capture Behavior on page 43
Fault and Alarm Behavior The fault and alarm handling functionality addresses both the need for
a large and ever-expanding number of specific faults and alarms, the
need for programmable actions, and the need for timely reporting of
those faults and alarms to the controller. Additionally, no compromises
are made to restrict the resolution of the reported faults and alarms, so
that the controller always has access to the unique axis condition and a
meaningful diagnosis. Numerous Fault and Alarm related attributes can
be included in the fixed portion of the cyclic Device-to-Controller
Connection so the controller can monitor the condition of the axis in
real-time, without cumbersome polling.
The CIP Axis Status attribute contains bits to indicate whether an alarm
condition is present. The CIP Axis State enumeration indicates when
the axis has a major fault, which could be a regular runtime CIP Axis
Fault, Safety Fault, or an Initialization Fault. The Axis Fault Code and
related attributes are used to report the specific fault condition, time
stamp, and fault action to the controller for the purposes of building a
fault log.
See also
State Behavior on page 63
Exceptions on page 45
Absolute Position Recovery on page 47
CIP Axis Status Attributes on page 339
Exception, Fault and Alarm Attributes on page 429
Exceptions Exceptions are runtime conditions that the device continually checks
that might indicate improper behavior of the axis or operation outside of
an allowable range. An exception can result in an alarm, a minor fault,
or a major fault, depending on how the associated Axis Exception
Action has been configured – an exception can even be configured to
be ignored. Exceptions are automatically cleared by the device when
the underlying exception condition is no longer present.
Exception Actions
For each exception, the motion axis can be programmed for a variety of
actions using the Exception Action attribute. Exception Actions range
from generating a major fault that results in the stopping of the axis all
Rockwell Automation Publication MOTION-RM003L-EN-P - September 2020 45
Chapter 2 Behavior models used in CIP Motion
the way to taking no action at all. The CIP Axis Faults attribute allows
the controller to have immediate access to any exceptions that have
been configured to generate a major or minor fault. The CIP Axis
Alarms attribute allows the controller to have immediate access to any
exceptions that have been configured to be reported as alarms.
Alarms
Alarms are runtime exception conditions for which the device is to take
no action other than to report as an alarm. Alarms and warnings,
therefore, are basically synonymous. On a given device product, some
exception conditions may not be able to simply be reported as an alarm
without any associated action; for example an IPM fault in which the
power module automatically shuts off without software intervention.
Alarm conditions are automatically cleared when the underlying
exception condition is no longer present.
Faults
Faults can be initialization faults, configuration faults, safety faults,
module faults, group faults, motion faults, or runtime exception
conditions that the axis has been configured to regard as a fault. Fault
conditions can occur in either the controller or motion device. If a
runtime fault occurs during an operational state, for example, Running
or Testing, it will result in the device stopping (or aborting) all axis
motion, either automatically or programmatically. Fault conditions
ultimately transition the axis state to the Faulted state. A Fault that
results from an exception condition is latched, and does not clear when
the exception condition clears. A fault can only be cleared with a Fault
Reset. If the fault condition is classified as an 'unrecoverable fault', only
a power cycle or a device reset can clear the fault condition.
See also
Motion Control Axis Behavior Model on page 54
Absolute Position Recovery Absolute Position Recovery (APR) provides support for establishing
and maintaining absolute position referenced to a specific machine,
commonly called the machine referenced absolute position or just
absolute position.
Absolute position is established by a homing procedure initiated by
successful execution of an MAH instruction. Once the homing
procedure has successfully established a machine reference, the Axis
Homed bit is set in the Motion Status attribute, indicating that actual
position and command position now have meaning with respect to the
associated machine.
It is good application programming practice to qualify dynamic machine
operation with the Axis Homed bit being set. Otherwise, absolute moves
to a specific position may not have any relationship to the position of the
axis on the actual machine.
Since the homing procedure usually requires the machine to be taken
offline and placed in a manual operating mode, for example, not making
product, anything that would require you to rehome one or more axes
on the machine is undesirable. This is downtime and costs money. The
APR feature maintains the machine reference or absolute position
through power cycles, program downloads, and even firmware updates.
See also
APR Fault Conditions on page 48
APR Fault Examples on page 50
APR Fault Generation on page 49
APR Fault Attributes on page 405
Absolute Position Loss The Absolute Position Recovery is not retained after the following:
• A project is exported, saved as a .L5K or .L5X, and imported
without APR Faults (downloaded).
• A major non-recoverable fault (MNRF).
• A power loss.
• On a Control Logix 5570 controller without an ESM
Tip: The APR can potentially be restored from a Secure Digital Card on a
ControlLogix 5570 Controller (if a 1756-ESM is not present).
• A download of an axis that does not have its home bit set.
• Power cycling of an incremental encoder.
See also
Absolute Position Recovery on page 47
APR Recovery Scenarios on page 51
APR Fault Examples on page 50
APR Fault Conditions Absolute Position Recovery (APR) faults are generated during these
events and when one of the conditions defined below occurs.
In order for an APR Fault to occur, the axis must be in the homed state.
The Axis Homed Status Bit must be set.
Attribute Changes
A Motion Resolution or an Axis Feedback Polarity attribute has been
changed and downloaded to the controller. This can also happen during
the execution of an SSV.
See also
APR Fault Generation on page 49
APR Fault Attributes on page 405
See also
APR Fault Attributes on page 405
APR Fault Examples on page 50
Online Scaling
Any change or SSV message that results in a motion resolution change
will generate an APR fault.
See also
Resetting APR Faults on page 54
Absolute Position Loss without APR Faults on page 48
APR Recovery Scenarios on page 51
APR Recovery Scenarios The following tables provide detailed information on when the APR
feature recovers absolute position. The following assumptions need to
be taken into consideration. In each of these cases, the APR feature
restores absolute position and preserves the state of the Axis Homed
bit, indicating that the axis has a machine referenced absolute position.
See also
APR Fault Examples on page 50
Absolute Position Loss without APR Faults on page 48
APR Fault Conditions on page 48
Reset an APR Fault There are three ways to reset an APR Fault.
• Instruction Execution
Executing an MAFR
Executing an MGSR
Executing an MASR
Executing a MCSR
• From the Controller Organizer:
Clear the group fault, the Logix Designer application executes an
MGSR
Clear the axis fault, the application executes an MASR
• Downloading the same project a second time
See also
APR Fault Examples on page 50
APR Fault Conditions on page 48
APR Fault Generation on page 49
Motion Control Axis The Motion Control Axis Behavior Model is based on elements of the
S88 and Pack/ML standard state models. The current state of the
Behavior Model Motion Control Axis is indicated by the CIP Axis State attribute. State
transitions can be initiated either directly using the Axis Control request
mechanism or by conditions that occur in either the controller or motion
device during operation.
Review the diagram for the behavior model to see how the axis state
maps to identity object states.
• Active Control Axis Behavior Model on page 55
• Feedback Only Axis Behavior Model on page 57
• CIP Motion Converter Axis Behavior Model on page 58
• Motor Attributes Model on page 60
See also
State Behavior on page 63
Fault and Alarm Behavior on page 45
Exceptions on page 45
Active Control Axis The Motion Control Axis Object State Model is based on elements of
the S88 and Pack/ML standard state models. The current state of the
Behavior Model Motion Control Axis Object instance is indicated by the CIP Axis State
attribute (Attribute ID = 650). State transitions can be initiated either
directly using the Axis Control request mechanism or by conditions that
occur in either the controller or motion device during operation.
The diagram shows the basic operating states of the Motion Control
Axis Object when actively controlling axis motion (Control Mode != No
Control) or, in the case of a regenerative converter (G), when actively
controlling power, or in the case of a track section (X), when actively
controlling current for resident movers. Shaded regions show mapping
of Axis States to corresponding Identity Object states. State transitions
terminating on shaded boxes can transition to any axis state within the
box.
Tip: * Specific Standby State after a Fault Reset is determined by applying the
Fault Reset State Transition Precedence Rules.
** When an axis is in the Stopped or Major Faulted states with Holding
torque (as a result of a Category 2 Stop), a Start Inhibit condition, Disable
Request, or Shutdown Request is used to execute the configured Stopping
Action.
Valid transitions for the Axis State Model are defined in the following
table:
See also
State Behavior on page 63
Fault and Alarm Behavior on page 45
Exceptions on page 45
Stopping Sequences on page 606
CIP Axis Status Attributes on page 339
Feedback Only Axis When the Motion Control Axis is not actively controlling axis motion
(Control Mode = No Control), the state diagram reduces to the following
Behavior Model for a Feedback Only axis or CIP Motion Encoder device type. Shaded
regions show mapping of Axis States to corresponding Identity Object
states. State transitions terminating on shaded boxes can transition to
any axis state within the box.
Valid transitions for the Axis State Model of a Feedback Only axis or
CIP Motion Encoder are defined in the following table:
Current State Event Conditions Next State
See also
State Behavior on page 63
Fault and Alarm Behavior on page 45
Exceptions on page 45
CIP Axis Status Attributes on page 339
CIP Motion Non- When the Motion Device Axis Object is associated with a CIP Motion
Non-regenerative Converter, the Active Control state diagram reduces
regenerative Converter to the following diagram. Shaded regions show mapping of Axis States
Tip: *Specific Standby state after a fault reset is determined by applying Fault Reset
State Transition Precedence rules.
Valid transitions for the Axis State Model of a CIP Motion Non-
regenerative Converter axis are explicitly defined in the following table:
Current State Event Conditions Next State
See also
State Behavior on page 63
Fault and Alarm Behavior on page 45
Exceptions on page 45
Motor Attributes Model The Motor Attributes define the minimal set of required attributes to
support CIP Motion device interchangeability. This guarantees that
there is sufficient parametric data provided by the controller for any CIP
Motion compliant device, for example, a drive, to effectively control a
given motor.
The Usage category for an attribute is based on the Motor Type. Where
needed, Required versus Optional is further differentiated by
abbreviations for PM (Permanent Magnet) and IM (Induction Motors). It
is implied that these motor attributes are applicable to all drive modes,
F, P, V, and T, but not applicable for the No Control axis configurations
where there is no active motor control function.
For induction motors, the Motion Control Axis leverages the IEEE
recommended phase-neutral equivalent circuit motor model based on
"Wye" configuration. Reactance values, X, are related to their
corresponding Inductance values, L, by X = ωL, where ω is the rated
frequency of the motor. The prime notation, for example, X2', R2',
indicates that the actual rotor component values X2, and R2 are
referenced to the stator side of the stator-to-rotor winding ratio.
For permanent magnet motors, the Motion Control Axis assumes all
motor parameters are defined in the context of a phase-to-phase motor
model.
See also
General Motor Attributes on page 550
General Permanent Magnet Motor Attributes on page 556
General Rotary Motor Attributes on page 559
General Linear Motor Attributes on page 548
Induction Motor Attributes on page 561
Linear PM Motor Attributes on page 563
Load Transmission and Actuator Attributes on page 568
Rotary PM Motor Attributes on page 570
Position Control Behavior In Position Control mode, the only operative Control Method supported
is Closed Loop servo control. When performing closed loop Position
Control, the device applies the Position Command signal output of the
60 Rockwell Automation Publication MOTION-RM003L-EN-P - September 2020
Chapter 2 Behavior models used in CIP Motion
Command Generator to the position loop summing junction. In addition
to the Position Command, a Position Trim input is provided that can be
used to provide an offset to the position loop. The classic PI control loop
generates a Position Loop Output signal to an inner velocity loop.
The following diagram provides an overview of the closed loop position
control behavior model.
See also
Position Feedback Selection on page 61
Position PI Gains on page 62
Velocity Feedforward on page 62
Position Loop Output Filters on page 63
Position Feedback Selection Feedback to the PI regulator can be derived from two different
feedback channels. This flexibility allows the position loop to operate
with either a motor based feedback device that is typically attached to
the Feedback 1 channel or a load-side feedback device that is
connected to the Feedback 2 channel. Which feedback source is used
by the loop is governed by the Feedback Mode attribute.
When the Feedback Mode calls for Dual Feedback operation, the
position loop utilizes the Feedback 2 channel and the velocity loop uses
the Feedback 1 channel. Since the two feedback channels may not
have the same feedback resolution, it is necessary to convert position
loop output from Feedback 1 units to Feedback 2 units prior to applying
See also
Position Control Behavior on page 60
Position PI Gains The Proportional Gain of the classic proportional-integral (PI) controller
sets the unity gain bandwidth of the position loop in radians/second,
while the Integral Gain is used to devise the Position Error signal to
zero to compensate for the effect of any static and quasi-static torque or
forces applied to the load.
See also
Position Control Behavior on page 60
Velocity Feedforward The inner velocity loop requires a non-zero command input to generate
steady-state axis motor velocity. To provide the non-zero output from
the device to the motor, a non-zero position loop output is required,
which translates to a non-zero position error.
This dynamic error between command position and actual position while
moving is often called "following error". Most closed loop motion control
applications require zero following error all of the time. This could be
achieved to some extent through use of the position integral gain
control, but typically the response time of the integrator action is too
slow to be effective in high-performance motion control applications. An
alternative approach that has superior dynamic response is to use
Velocity Feedforward.
The Velocity Feedforward feature is used in Position Control mode to
provide the bulk of the Velocity Reference input necessary to generate
the desired motor velocity. It does this by scaling the Fine Velocity
Command signal output of the Command Generator by the Velocity
Feedforward Gain and adding the resultant Velocity Feedforward
Command signal to the Position Loop Output generated by the position
loop to form the Velocity Reference signal. With this feature, the
position loop does not need to generate much effort to produce the
required velocity command level, hence the Position Error value is
significantly reduced. The Velocity Feedforward Command signal allows
the following error of the position control loop to be reduced to nearly
zero when running at a constant velocity. This is important in
applications such as electronic gearing and synchronization applications
where it is necessary that the actual axis position not significantly lag
behind the commanded position at any time.
Theoretically, the optimal value for Velocity Feedforward Gain is 100%.
In reality, however, the value may need to be adjusted to accommodate
velocity loops with finite loop gain. One thing that may force a smaller
Velocity Feedforward value is that increasing amounts of feedforward
tend to exacerbate axis overshoot. For this reason feedforward is not
recommended for point-to-point positioning applications.
See also
Position Control Behavior on page 60
Position Loop Output Filters on page 63
Position Loop Output Filters A lead-lag filter is provided at the output of the position loop forward
path. This filter can be used in the lead configuration to boost position
loop bandwidth and increase the stiffness, for example, the ability to
resist dynamic load disturbances.
See also
Position Control Behavior on page 60
State Behavior The Motion Control Axis state model includes the following the states
and state transitions.
Off State
This is the state of the Motion Control Axis with power off.
Initializing State
From the controller's perspective the Initializing state shown in the state
models consists of 4 different axis sub-states, Unconnected,
Configuring, Synchronizing, and Waiting for Group. While transitioning
through these Initializing sub-states, the controller has no access to
current Axis State value in the drive. Only after the controller's CIP Axis
State completes the Initialization process, does the CIP Axis State value
reflect the current Axis State attribute value in the CIP Motion device.
During the Initializing state, the device waits for the CIP Motion
connections to the device to be established by the controller using a
Forward Open service. Once the Forward Open service is successfully
processed, the device initializes all attributes to their factory default
values, resets all active faults, resets applicable axis status conditions
Pre-Charge State
During the Pre-Charge state, when applicable, the device is waiting for
the DC Bus to fully charge (DC Bus Up status bit is clear). Once the DC
Bus reaches an operational voltage level (DC Bus Up status bit is set),
the axis either transitions to the Stopped state (drive axis or
regenerative converter axis) or to the Running state (non-regenerative
converter axis). The device's power structure is always disabled in this
state (Power Structure Enabled status bit clear). Any attempt for the
controller to enable the axis using the Axis Control mechanism while it
is in the Pre-Charge state is reported back to the controller as an error
in the Response Status and the axis remains in the Pre-Charge state.
The Pre-Charge State is classified as an Identity Object Standby state
and, therefore, requires that the associated power structure, if
applicable, is disabled.
Stopped State
In the Stopped state the device's power structure will either be disabled
(Power Structure Enabled status bit clear) or, in the case of a drive axis,
held in a static condition using an active control loop (Power Structure
Enabled status bit set). No motion can be initiated by a drive axis in the
Stopped State nor can a drive axis respond to a planner generated
command reference (Tracking Command status bit clear). In general,
the motor associated with the drive axis will be at rest, but if an external
force or torque is applied to the load, a brake may be needed to
maintain the rest condition. Similarly, no AC Line modulation can be
applied by a regenerative converter axis in the Stopped state, nor can
any regenerative energy be transferred to the AC Line. In the Stopped
state, main power is applied to the device and the DC Bus is at an
operational voltage level. If there are any Start Inhibit conditions
detected while in this state, the axis transitions to the Start Inhibited
state. If an Enable request or one of the Run Test service requests is
applied to an axis in the Stopped state, the axis transitions to the
Starting state.
Starting State
When an Enable request is given to an axis in the Stopped, or Stopping
state when performing a drive Flying Start, the axis immediately
transitions to the Starting state. In this state, the device checks various
conditions before transitioning to the Running state. These conditions
for a drive axis can include Brake Release delay time and Induction
Motor flux level. The device control and power structures are activated
during the Starting state (Power Structure Enabled status bit set) but the
command reference is set to a local static value and will not track the
Running State
The Running state is where the work gets done. In this state, the
device’s power structure is active (Power Structure Enabled status bit
set). In the case of a drive axis, the selected Control Mode is enabled
and the device is actively tracking command data from the controller
based motion planner output to affect axis motion (Tracking Command
status bit set).
In the case of a regenerative converter axis, the Converter Control
Mode is enabled and the device is actively tracking the Voltage or
Current set point value from the controller (Tracking Command status
bit set). In the case of a track section axis, the section axis is actively
tracking the current references for resident movers (Tracking Command
status bit set). The axis remains in the Running state until either a fault
occurs or it is explicitly commanded to stop via an Axis Control request.
In the case of an axis with no active control function (Control Mode = No
Control), the Running state simply indicates that the device is fully
operational. Since there is no active control function, however, the
Power Structure Enabled status bit and the Tracking Command status
bit are both clear. The axis remains in the Running state until either a
fault occurs or it is explicitly commanded to Shutdown via an Axis
Control request.
Testing State
When any one of the Run Test request services is sent to the axis while
in the Stopped state, for example, services that require an active power
structure to execute, the axis immediately transitions to the Starting
State (Power Structure Enabled status bit set), and then once the
Starting conditions are met, the axis transitions to the Testing state.
This Testing state is like the Running state in that the device's power
structure is active, but in the Testing state one of the device's built-in
test algorithms is controlling the motor (drive) or line energy flow
(regenerative converter), not command or set point data from the
controller (Tracking Command status bit clear). In the Testing state a
drive excites the motor in various ways while performing measurements
to determine characteristics of the motor and load. Similarly a
regenerative converter device applies current in various way to
determine characteristics of the AC line and DC bus. The drive or
converter axis remains in this state for the duration of the requested test
procedure and then stops and returns to the Stopped state. The axis
can also exit the Testing state by either a fault or an explicit Axis Control
request. In all these exit cases, a drive executes a Category 0 Stopping
Sequence.
Stopping State
When a Disable request is issued to the Motion Device Axis Object in
the Starting, Running or the Testing states, the axis immediately
transitions to the Stopping state. In this state, the axis is in the process
of stopping and is no longer tracking command or set point data from
the controller (Tracking Command status bit clear). For a drive axis, a
Disable Request executes the configured Stopping Actions while a
Shutdown Request executes the configured Shutdown Action.
There are many different Stopping Actions supported by the Motion
Device Axis Object for a drive axis. Each of these Stopping Actions
executes one of three possible IEC60204-1 Category Stops or Stopping
Sequences (Category Stop 0, 1, and 2). Most of these Stopping Actions
actively decelerate the axis to a stop (Category Stop 1 and 2). The
power structure may remain active (Power Structure Enabled status bit
set) as long as the Stopping Action procedure takes to complete. Once
the selected Stopping Action procedure has completed, the axis
transitions to the Stopped state. When the Stopping Action of "Disable
and Coast" is initiated by a Disable Request or a Shutdown Action, the
power structure is immediately disabled (Power Structure Enabled
status bit clear) and the axis coasts to a stop while in the Stopping state
(Category 0 Stop). For all Stopping Sequences, the device will wait until
the axis has reached zero speed, or a timeout occurs (as defined by the
Stopping Time Limit and Coasting Time Limit attributes), before
transitioning to the Stopped state. In some cases, such as when the
axis is stationary, this transition can be immediate. The criteria for zero
speed is based on Velocity Feedback being less than 1% of motor rated
speed or by criteria set by optional Zero Speed and Zero Speed Time
attribute values. In the case of a Frequency Control drive device, the
criteria are based on Velocity Reference rather than Velocity Feedback.
When an Enable Request is given to a drive axis in the Stopping state
with Flying Start Enabled, the axis will immediately transition to the
Starting state.
Aborting State
When a Major Fault occurs in the motion device while the axis is in
either the Starting, Running, Testing, or Stopping states, the axis
immediately transitions to the Aborting state. In this state, the axis is in
the process of stopping and is no longer tracking command or set point
data from the controller (Tracking Command status bit clear).
For a drive axis, a Major Fault executes the appropriate stopping action
as specified by the device vendor. When actively stopping the drive axis
in the Aborting state, the power structure remains active (Power
Structure Enabled status bit set) as long as the stopping action takes to
complete. In some cases, the power structure must be immediately
disabled so the axis may coast to a stop while in the Aborting state. In
any case, the drive axis will wait until the axis has reached zero speed
before transitioning to the Major Faulted state. Once the stopping
procedure is complete and the axis has reached zero speed, the axis
transitions to the Faulted state. The criteria for zero speed is based on
Velocity Feedback being less than 1% of motor rated speed or by
criteria set by optional Zero Speed and Zero Speed Time attribute
values. In the case of a Frequency Control drive axis, Velocity
Reference is used rather than Velocity Feedback. In some cases, such
as when the axis is stationary, this transition can be immediate.
When faults conditions are detected in the controller that are not visible
to the motion device, or when the motion device reports a Minor Fault
condition, the controller is responsible for bringing the axis to a stop,
either directly using an Axis Control state change request or, in the case
of a drive axis, directly by a motion planner stop, or indirectly using a
fault handler in the user program. If the Axis State reported by the
motion device is Stopping, then the controller sets the CIP Axis State to
Aborting based on the presence of the fault condition.
When an Abort Request is issued to the Motion Device Axis Object a
Controller Initiated Exception is generated. If the associated Axis
Exception Action is set to generate a Major Fault the drive axis stops
the axis according to the configured Stopping Action before transitioning
to the Faulted state.
Faulted State
The Motion Device Axis Object defines a Major Faulted state that is
identical to the Stopped state (or, if a Shutdown fault action was
initiated, the Shutdown state) with the exception that there are one or
more Faults active. In other words, a Major Faulted axis is a Stopped
(or Shutdown) axis with a Major Fault condition present. The Motion
Device Axis Object also defines a Minor Fault as a fault that allows
device operation to continue and does not impact the Axis State in the
motion device.
There is no such distinction between Major Fault and Minor Fault in the
controller; both Major Faults and Minor Faults reported by the drive
result in the axis transitioning to the Faulted state in the controller. Thus,
in the controller it is not generally true that a Faulted axis is a Stopped
(or Shutdown) axis with a Fault condition present. When the motion
Shutdown State
When a Shutdown request is issued to the device or a Shutdown fault
action is executed by the device, the targeted axis transitions to the
Shutdown state. In the case of a Shutdown request, the axis
immediately transitions from whatever state it is currently in to the
Shutdown state. The Shutdown state has the same basic characteristics
of the Stopped state except that it can be configured using the
Shutdown Action attribute to drop the DC Bus power to the device's
power structure. This is generally done by opening an AC Contactor
Enable output provided by the drive that controls power to the
converter. Regardless of whether or not DC Bus power is disconnected,
this state requires an explicit Shutdown Reset request from the
controller to transition to the Pre-Charge state. If the device is
configured to keep the DC Bus power active while in the Shutdown
state then the axis transitions through the Pre-Charge state to the
Stopped state. The Shutdown state offers an extra level of safety
against unexpected motion.
In the case where a Shutdown fault action is initiated by the drive in
response to an exception condition that is configured to be a Major
Fault, the device executes the Shutdown action, but the axis goes to the
No Device State
If the CIP Motion axis instance in the controller is created, but not
currently associated with a CIP Motion device, the axis state indicates
the No Device state. A CIP Motion axis will be associated with a
physical CIP Motion device to function. This condition is checked during
the controller Self Test state as qualification for transition to the
Initializing state. For this reason the No Device state is considered a
controller only sub-state of the Self Test state.
Configuring State
Once a CIP Motion I/O connection has been made to the device, the
controller begins to send configuration data using the connection's
service channel. At this time the axis state transitions from Unconnected
to Configuring. The axis state will remain in the Configuring state until
the values of all applicable configuration attributes in the device have
been set for this axis instance, or until a configuration fault occurs, in
which case the axis state transitions to the Faulted state.
Synchronizing State
If the device has not been synchronized to the controller by the time the
controller has completed the axis configuration process, the axis state
transitions to the Synchronizing state. The axis state will remain in the
Synchronizing state until the device has been successfully synchronized
as indicated by a successful Group_Sync service response from the
device, or a time limit (~60 seconds) is reached, in which case the
controller closes the connection and starts the Initialization process over
again.
See also
Fault and Alarm Behavior on page 45
Exceptions on page 45
Motion Control Axis Behavior Model on page 54
Stopping and Braking Attributes on page 594
Torque Control Behavior Torque is generally proportional to acceleration and to the torque
producing motor current, Iq. The purpose of the Torque Control
structure is to combine input signals to create a Torque Reference. The
See also
Torque Input Sources on page 74
Inertia Compensation on page 75
Friction Compensation on page 77
Torque Filters on page 79
Torque Limiter on page 81
Torque Input Sources The Torque Control model can take input from a variety of sources
depending on the Control Mode. Input to the Torque Reference path
can come through the cyclic Torque Command or Torque Trim signal in
Torque Control mode. In Position or Velocity Control mode, torque input
is derived from the outer velocity loop or acceleration loop by bringing in
the resulting acceleration signals and scaling these signals into
equivalent torque.
See also
Torque Control Behavior on page 73
Inertia Compensation on page 75
Inertia Compensation Inertia compensation features are included in the Torque Control
behavior model.
Backlash Compensation
Backlash Compensation is used to stabilize the device control loop
behavior in applications with high load inertia ratios and mechanical
backlash.
The Backlash Compensation Window attribute is used to control the
Backlash Compensation feature. Mechanical backlash is a common
problem in applications that use mechanical gearboxes. The problem
stems from the fact that until the input gear is turned to the point where
its proximal tooth contacts an adjacent tooth of the output gear, the
reflected inertia of the output is not felt at the motor. In other words,
If the Velocity Control loop is tuned for peak performance with the load
applied, the axis will be, at best, under-damped and, at worst, unstable
in the condition where the gear teeth are not engaged. In the worst case
scenario, the motor axis and the input gear oscillates wildly between the
limits imposed by the output gear teeth. The net effect is a loud buzzing
sound when the axis is at rest, commonly referred to as 'gearbox
chatter'. If this situation persists, the gearbox will wear out prematurely.
To prevent this condition, the conventional approach is to de-tune the
velocity loop so that the axis is stable without the gearbox load applied.
Unfortunately, system performance suffers.
With a Backlash Stabilization Window value commensurate with the
amount of backlash in the mechanical system, the backlash stabilization
algorithm is very effective in eliminating backlash-induced instability
while still maintaining full system bandwidth. The key to this algorithm is
a tapered Kj profile that is a function of the position error of the position
loop, illustrated in the following diagram.
The reason for the tapered profile, as opposed to a step profile, is that
when the position error exceeds the backlash distance a step profile
would create a very large discontinuity in the torque output. This
repulsing torque tends to slam the axis back against the opposite gear
tooth and perpetuate the buzzing effect. The tapered profile can be
qualified to run only when the acceleration command or the velocity
76 Rockwell Automation Publication MOTION-RM003L-EN-P - September 2020
Chapter 2 Behavior models used in CIP Motion
command to the control loop structure is zero, for example, when not
commanding motion that would engage the teeth of the gearbox.
Properly configured with a suitable value for the Backlash
Compensation Window, this algorithm entirely eliminates the gearbox
buzz without sacrificing any servo performance. The Backlash
Compensation Window parameter determines the width of the window
over which backlash stabilization is applied. In general, this value is set
equal to or greater than the measured backlash distance. A Backlash
Stabilization Window value of zero effectively disables the feature.
Inertia Observer
The Inertia Observer, when enabled, monitors the acceleration of the
axis in relationship to the torque producing current command, Iq Current
Reference, and estimates the total motor inertia.
The Total Inertia Estimate for the Inertia Observer is fed back to the Kj
gain to provide automatic gain control (AGC) with respect to load inertia.
This feature can be used to compensate for inertia variation without
compromising system performance. The Inertia Observer works on the
premise that the motor and load are not subject to externally applied
torques or forces that could impact the acceleration of the load. By
contrast, the Load Observer in the Acceleration Control behavior model
works on the premise that changes in acceleration are due to externally
applied torques/forces on the motor and load. Thus, the operation of
these two observers are mutually exclusive; they should not be enabled
at the same time.
See also
Friction Compensation on page 77
Torque Control Behavior on page 73
See also
Torque Filters on page 79
Torque Control Behavior on page 73
Torque filters The following filters can be applied to provide additional compensation
and control to the torque value.
Lead-Lag Filter
A lead-lag filter is provided in the torque reference path.
Use the lead-lag filter in the:
• Lead configuration to boost velocity or acceleration loop
bandwidth
• Lag configuration for the high frequency gain boost that
associates with compliant load mechanics.
Notch Filters
One or more Torque Notch Filters can also be applied to the torque
reference signal. Notch filters are effective in resonance control when
the natural resonance frequency is higher than the control loop
bandwidth. Like the low pass filter, the notch filters work by significantly
reducing the amount of energy in the device output that can excite the
natural resonances. Notch filters can be used even when the natural
resonance frequencies are relatively close to the control loop
bandwidth. That is because the phase lag introduced by the notch filters
are localized around the notch frequencies. For the notch filters to be
effective, the Notch Filter Frequency has to be set very close to the
natural resonance frequency of the load.
The following is an equation for the notch filter:
See also
Torque Limiters on page 81
Torque Control Behavior on page 73
Torque Limiter After undergoing friction compensation and filtering the Torque
Reference signal passes through a limiter to produce the Limited
Torque Reference signal. The Torque Limiter applies a torque limit to
the signal that is based on the sign of the torque reference signal input
and the state of the axis.
During normal operation it is the Torque Limit – Positive and Torque
Limit – Negative attributes, set by the user, that are applied to the
torque reference signal. When the axis is commanded to stop as part of
a disable request or major fault condition, the device applies the
Stopping Torque Limit.
Also included with the torque limiter is a built-in Torque Rate of Change
Limit. This feature limits the rate of change of the torque reference
output.
See also
Torque to Current Scaling on page 81
Torque Control Behavior on page 73
Torque to Current Scaling The final result of all this torque signal filtering, compensation, and
limiting functionality is the Filtered Torque Reference signal. When the
signal is scaled by the reciprocal of the Torque Constant of the motor,
1/Kt, it becomes the torque producing Iq Current Command signal to the
current loop.
Ideally, the relationship between motor torque and motor current is
independent of position, time, current, and environmental conditions,
the 1/Kt scaling has a nominal value of 1, so that 100% rated torque
translates to 100% rated current. In practice, this may not be the case.
Compensation can be applied to the 1/Kt value to address these issues
at the drive vendors' discretion.
Cogging Compensation
For PM motors, one of the more troublesome Kt variations to contend
with is a position dependent variation to Kt known as motor cogging.
The Kt scaling factor can be used to compensate for motor cogging by
performing a test on the motor that generates a Kt versus Electrical
Angle Cogging Compensation table. This table can then be used to
compensate for the cogging impact in real- time based on the electrical
angle of the motor resulting in smoother motor operation.
Torque Estimate
CIP Motion supports a generalized Torque Estimator block used to the
Torque Estimate signal that represents the torque, or force, applied by
the motor. This estimate is based on vendor specific algorithms that
determine motor torque, or force, from various motor related input and
output signals. An optional Torque Estimate Crossover Speed
configuration attribute allows different algorithms to be applied to
estimate torque for low speed and high speed operation.
The Torque Estimator output signal is passed through two 2nd order
notch filters. These filters can be configured to provide low pass, high
pass, notch, or band pass filtering to the Torque Estimate signal.
See also
Torque Control Behavior on page 73
Velocity Control Behavior on page 82
Velocity Control Behavior In Velocity Control mode, there are two operative control methods
supported, Closed Loop Velocity Control and Open Loop Frequency
Control.
See also
Closed Loop Velocity Control on page 83
Open Loop Frequency Control on page 86
Closed Loop Velocity The Closed Loop Velocity Control method is targeted for applications
that require tight speed regulation. The command input to the velocity
Control loop can be derived directly from the Velocity Command of the
Command Generator when configured for Velocity Control Mode or
from the Position Loop Output when configured for Position Control
Mode.
When serving as an outer velocity loop in Velocity Control Mode, the
device applies the Velocity Command input to the velocity command
summing junction to generate the Velocity Reference signal into a PI
regulator. Contributing to the velocity command summing junction also
is the Velocity Trim input, which can be used in conjunction with an
outer control loop to make minor adjustments to the velocity of the
motor.
Velocity Limiter
The output of the velocity command summing junction signal passes
through a limiter to produce the Velocity Reference signal into the
velocity loop. The Velocity Limiter applies a directional velocity limit,
either Velocity Limit - Pos or Velocity Limit - Neg, to the velocity
command signal input that is based on the sign.
Velocity Gains
The velocity loop generates a Velocity Loop Output signal to the next
inner loop through a PI control loop structure. The Proportional Gain of
the controller sets the unity gain bandwidth of the velocity loop in
radians/second, while the Integral Gain is used to drive the Velocity
Error signal to zero to compensate for any static and quasi-static torque
or forces applied to the load. The integrator path includes a Proportional
Gain so that units of the Integral Gain represent the bandwidth of the
integrator in radians/second.
The integral section of the velocity regulator includes an anti-windup
feature. The anti-windup feature automatically holds the regulator's
integral term when a limit condition is reached in the forward path. The
anti-windup feature is conditioned by the arithmetic sign of the
Negative Feedforward
Aside from the normal PI control elements, a negative feedforward gain
(Knff ) is provided to adjust the time response of the velocity regulator.
Knff has a range of 0…100%, where 0 disables the function. A value of
30% results in little noticeable overshoot in the speed response to a
step input. This can be easily observed when the motor speed is
ramped to zero. The effect of negative feedforward is to eliminate
backup of the motor shaft. The Knff gain setting has no effect on the
stability of the speed regulator. A disadvantage of by using negative
feedforward is that it results in a time lag in feedback response to a
reference ramp input.
Velocity Droop
Another feature of the velocity regulator is the velocity droop function.
The velocity error input to the integral term is reduced by a fraction of
the velocity regulator's output, as controlled by the droop gain setting,
Kdr. As torque loading on the motor increases, actual motor speed is
reduced in proportion to the droop gain. This is helpful when some level
of compliance is required due to rigid mechanical coupling between two
motors.
Acceleration Feedforward
The velocity loop requires a non-zero velocity loop output to generate
steady- state axis motor acceleration. To provide the non-zero output
from the drive to the motor, a non-zero velocity error is generally
required. In Position Control applications, this non-zero velocity error
translates to a non-zero position loop error.
Because many closed loop motion control applications require near
zero control loop error, this behavior is not desirable. Again, the position
and velocity loop error could be reduced by applying the velocity
See also
Position Control Behavior on page 60
Velocity Feedforward on page 62
Open Loop Frequency Another Velocity Control method is the open loop Frequency Control
method associated with so called Volts/Hertz or Variable Frequency
Control Drives (VFDs) that do not have a current control loop and typically drive
an induction motor.
Velocity control with this method is achieved by controlling the voltage
and frequency output of the drive device in some manner where voltage
is generally proportional to frequency. For an induction motor, the
velocity of the motor is determined by the Output Frequency of the drive
device divided by the Motor Pole count. This control method is
applicable to Velocity Control applications that do not require tight
speed regulation and therefore do not require a feedback device.
Slip Compensation
When driving an induction motor at a specific frequency, the actual
motor velocity is generally less than the command speed, given by the
output frequency divided by the motor pole count, by an amount that is
proportional to the load torque applied to the motor. This difference in
speed is called 'Slip' and is a configuration attribute associated with the
motor. The Motion Device Axis Object supports a Slip Compensation
Velocity Droop
Another feature defined for the Frequency Control method is the droop
function. The droop function reduces the velocity reference by a scaled
fraction of the torque producing current, Iq, as controlled by the droop
gain setting, Kdr. As torque loading on the motor is increased, actual
motor speed is reduced in proportion to the droop gain. This is helpful
when some level of compliance is required when performing torque
sharing between two motors on a common load.
See also
Velocity Control Behavior on page 82
Torque Control Behavior on page 73
Each attribute table begins with the attribute name as a heading. The
tag, GSV/SSV, and MSG names for each of these attributes are the
same as the attribute name listed, but with the spaces removed. For
example, Inhibit Axis would be InhibitAxis.
This table provides an explanation of the information, nomenclature,
and abbreviations used in the attribute tables.
DB = Motion Database
Indicates that the default value comes from the database.
FD = Factory Default computed value
∞ = max float = 3.402.... x 1038
0+ = min float = 1.2.... x 10-38
maxpos = 231/Conversion Constant
maxspd = 1000 * maxpos
Default, Minimum, Maximum minspd = minfloat
Range Limits maxacc = 1000 * maxspd
minacc = minfloat
maxint = 215 - 1
maxdint = 231 - 1
- (dash) = Not Applicable
N/A = Not Applicable
Defaults = Unless otherwise specified, all optional attributes default to 0. All
reserved and otherwise unused bits and enumerations are set to 0.
See also
Device Function Codes on page 93
CIP Data Types on page 93
Identify Motion Axis Attributes Based on Device Function Codes
on page 97
CIP Axis Attributes on page 243
Attribute Units Attribute Units define the unit nomenclature found in the Semantics of
Values column for many of the Motion Control Axis Attributes. In
general, attribute values are specified in units that are relevant to
motion control engineers.
See also
CIP Data Types on page 93
CIP Axis Attributes on page 243
CIP Data Types This table provides descriptions of the CIP Data Types related to the
CIP Motion Control Axis.
Data Type Data Type Description Range
Name Code
(hex)
BOOL* C1 Boolean 0 = FALSE; 1 = TRUE
SINT C2 Short Integer -128 SINT 127
INT C3 Integer -32768 INT 32767
DINT C4 Double Integer -231 DINT (231 – 1)
LINT C5 Long Integer -263 LINT (263 – 1)
USINT C6 Unsigned Short Integer 0 USINT 255
UINT C7 Unsigned Integer 0 UINT 65536
UDINT C8 Unsigned Double Integer 0 UDINT (232 – 1)
ULINT C9 Unsigned Long Integer 0 ULINT (264 – 1)
REAL CA Single Precision Float See IEEE 754
LREAL CB Double Precision Float See IEEE 754
BYTE D1 bit string – 8-bits N/A
WORD D2 bit string – 16-bits N/A
DWORD D3 bit string – 32-bits N/A
LWORD D4 bit string – 64-bits N/A
SHORT STRING DA {length, 1-byte characters[n]} N/A
* BOOL data type is defined by CIP standard to be an 8-bit unsigned integer with enumeration of 0 for
False and 1 for True.
See also
CIP Axis Attributes on page 243
Device Function Codes The variations in Control Mode and Control Method result in a set of
basic Device Function Codes that help organize the many attributes of
the Motion Control Axis. Device Function Codes are designated by
using a letter identifier or a combination that you can use to determine
what attributes are required for implementation of a given CIP Motion
device. The list of Device Function Codes is as follows:
Device Function Code Control Mode Control Method
G Regenerative (Active) AC/DC No Control Mode No Control Method
Converters
N Non-Regenerative (Passive) No Control Mode No Control Method
AC/DC and DC/DC Converters
E Encoder, Feedback Only No Control Mode No Control Method
P Position Loop Position Control Mode Closed Loop Vector Control Method
V Velocity Loop Velocity Control Mode Closed Loop Vector Control Method
T Torque Loop Torque Control Mode Closed Loop Vector Control Method
F Frequency Control Velocity Control Mode Frequency Control Method (V/Hz or
VFD)
Conditional Implementations
There are many conditions that impact implementation of attributes.
Some examples are, encoderless or sensorless drive operation, velocity
controlled drives operating without a feedback device, and attributes
that are replicated between the controller and the device. Conditional
implementation rules for attributes in these situations are represented
by the following Device Functions Codes:
Device Function Code Description
E Encoder-based device operation
!E Encoderless or Sensorless device operation
See also
Attribute Units on page 92
CIP Data Types on page 93
Required vs. Optional Axis In the attribute tables, attributes and services are defined as Required
(R) or Optional (O). Required attributes and services must be supported
Attributes in the implementation of the object. Optional attributes and services
may or may not be supported in the implementation and are left to the
discretion of the device manufacturer.
For Instance Attributes, the determination of whether a given attribute or
service is Required or Optional often depends on the associated Device
Function Code.
Required Implementation
If an attribute is marked as Required for a given Device Function Code
then the controller implementation, including configuration and
Conditional Implementation
For some attributes, there are conditional implementation rules that
extend beyond the Device Function Code. These rules are specified in
the Conditional Implementation column of the table below. In the
following example, the attribute PM Motor Resistance is Required “R” in
the implementation if the device supports Frequency Control, Position
Control, Velocity Control, or Torque Control and the device supports
Permanent Magnet motors, that is, “PM Motor only”. The attribute is Not
Applicable “-” for a Bus Power Converter or a Feedback Only device or
a drive that does not support a PM motor.
Attribute ID Access Attribute X G N E F P V T Conditional
Rule Implementation
1327 Set PM Motor R - - - R R R R SPM, IPM, LTS Motors
Resistance Only
To get details about how to specify the attribute, refer to the attributes
list for the functional category. For this example, PM Motor Resistance
is a member of the General Permanent Magnet Motor Attributes
category. The following table provides an example of the details
information:
Usage Access Data Default Min Max Semantics of Values
Type
Required Set/SSV* REAL 0 0 - Ohms
DB
* Indicates the attribute cannot be set while the drive power structure is enabled (Power Structure Enable
bit in CIP Axis Status is true).
When you are reviewing the tables for an attribute remember that
Vendor Specific attributes, attribute enumerations, and bits, are
Optional by definition. Attributes that have Optional enumerations or bit
maps are designated so in the Condition Implementation column.
Details about Optional and Required support for the individual
enumerations or bits for these attributes can be found in the detailed
attribute behavior tables.
The software queries the specific drive profile, Add-on Profile (AOP), to
determine if the Optional attributes listed in the table are supported.
Attributes that are marked with an AOP in the Conditional
Implementation column have semantics with additional, drive specific,
optional behavior that is queried.
See also
Motion Control Modes on page 22
Identify Motion Axis Attributes Based on Device Control Codes
on page 97
Interpreting the Attribute Tables on page 89
Identify Motion Axis This table provides an alphabetical list of all Motion Axis Attributes
specific to the CIP Drive data type. The table identifies whether the
Attributes Based on Device attribute is Required (R), Optional (O), or Conditional (C), in
implementation based on the Device Function Code. Attributes that are
Function Codes not applicable for a device function code are denoted by a dash (-).
The Device Function Codes are:
• G – Regenerative (Active) AC/DC Converters (No Control Mode,
No Control Method)
• N - Non-Regenerative (Passive) AC/DC Converters (No Control
Mode, No Control Method
• E – Encoder, Feedback Only (No Control Mode, No Control
Method)
• P – Position Loop (Position Control Mode, Closed Loop Vector
Control Method)
• V – Velocity Loop (Velocity Control Mode, Closed Loop Vector
Control Method)
• T – Torque Loop (Torque Control Mode, Closed Loop Vector
Control Method)
• F – Frequency Control (Velocity Control Mode, Frequency
Control Method)
• X – Track Section (No Control Mode, No Control Method)
The C/D column states whether the attribute is replicated in the drive.
Attr. ID Access Tag Attribute Name G N E F P V T C/D Conditional
Rule Implementation
2011 Get T AC Line Current R - - - - - - Yes V32
2034 Set AC Line Current Unbalance Limit O - - - - - - Yes V32
2225 Get T AC Line Electrical Angle O - - - - - - Yes V32
2010 Get T AC Line Frequency R - - - - - - Yes V32
2245 Set AC Line Frequency Change Action O - - - - - - Yes V32
2246 Set AC Line Frequency Change Threshold O - - - - - - Yes V32
2247 Set AC Line Frequency Change Time O - - - - - - Yes V32
2284 Set AC Line High Freq User Limit O - - - - - - Yes V32
2286 Set AC Line High Freq User Limit - Alternate O - - - - - - Yes V32
2285 Set AC Line Low Freq User Limit O - - - - - - Yes V32
See also
CIP Axis Attributes on page 243
Motion Instruction Compatibility on page 28
Attribute Conversion from The following table illustrates the methods used to convert a L5K file
from a Logix Designer project that uses an existing Allen-Bradley®
SERCOS to Integrated SERCOS drive to a comparable CIP Motion compliant drive.
Drive Supported Optional The following tables describe the optional attributes that are supported
for the Kinetix 350, Kinetix 5500, Kinetix 5700, Kinetix 6500, PowerFlex
Attributes 755 Standard, and the PowerFlex 755 Safety drives.
• Kinetix 350 Drive Module Optional Attributes on page 118
• Kinetix 5500 Hardwired STO Drive Module Optional Attributes on
page 125
• Kinetix 5500 Integrated STO Drive Module Optional Attributes on
page 133
• Kinetix 5700 Drive Module Optional Attributes on page 140
• Kinetix 5700 Advanced Safety Drive Module Optional Attributes
on page 148
• Kinetix 5700 CIP Safety (EtherNet/IP) Module Optional Attributes
on page 156
• Kinetix 5700 CIP Advanced Safety (EtherNet/IP) Module Optional
Attributes on page 166
• Kinetix 6500 Drive Module Optional Attributes on page 187
• Kinetix 5700 Regenerative Bus Supply Module Optional
Attributes on page 177
• PowerFlex 527 Axis Instance Optional Attributes on page 195
• PowerFlex 755 Standard Drive Module Optional Attributes on
page 200
• PowerFlex 755 High Power, Standard Drive Module Optional
Attributes on page 206
• PowerFlex 755 Low Power, Non-Network Safety Drive Module
Optional Attributes on page 212
• PowerFlex 755 High Power, Non-Network Safety Drive Module
Optional Attributes on page 218
• PowerFlex 755 Low and High Power, STO Only Network Safety
Drive Module Optional Attributes on page 224
• PowerFlex 755 Low and High Power, Advanced Safety Network
Safety Drive Module Optional Attributes on page 231
The tables use the following abbreviations:
Key Description
Y The attribute/enum/bit is supported.
Y# The attribute was not supported until the major revision of the drive.
(indicated by the # value)
N The attribute/enum/bit is NOT supported.
R The attribute is required.
O The attribute is optional.
G Regenerative (Active) AC/DC Converters (No Control Mode, No Control Method)
N Non-regenerative (Passive) AC/DC and DC/DC Converters (No Control Mode, No Control
Method
E Encoder, Feedback Only (No Control Mode, No Control Method)
P Position Loop (Position Control Mode, Closed Loop Vector Control Method)
V Velocity Loop (Velocity Control Mode, Close Loop Vector Control Method)
T Torque Loop (Torque Control Mode, Closed Loop Vector Control Method)
F Frequency Control (Velocity Control Mode, Frequency Control Method)
C/D Controller/Device Replicated Attribute
AOP Special device specific semantics needed from AOP
See also
Device Function Codes on page 93
Attribute Conversion from SERCOS to Integrated Motion on the
Ethernet/IP Network on page 114
MSG Instruction Access Only Attributes on page 238
Kinetix 350 Drive Module A Kinetix 350 drive module supports the following optional attributes
and corresponding control mode functionalities:
Optional Attributes
ID Access Attribute Name N E F P V T Conditional Implementation
Rule
367 Get Acceleration Fine Command - - Y Y Y
485 Set Acceleration Limit - N N N N
482 Get Acceleration Reference - - N N N
481 Set Acceleration Trim - - N N N
836 Set Adaptive Tuning Configuration - - - N N N
Kinetix 5500 Hardwired STO The hardwired Kinetix 5500 drive modules include the following catalog
numbers:
Drive Module Optional • 2198-H003-ERS, Kinetix 5500, 1A, 195-528 Volt, Safe Torque
Attributes Off Drive
• 2198-H008-ERS, Kinetix 5500, 2.5A, 195-528 Volt, Safe Torque
Off Drive
• 2198-H015-ERS, Kinetix 5500, 5 A, 195 – 528 Volt, Safe Torque
Off Drive
• 2198-H025-ERS, Kinetix 5500, 8A, 195- 528 Volt, Safe Torque
Off Drive
• 2198-H040-ERS, Kinetix 5500, 13 A, 192-528 Volt, Safe Torque
Off Drive
• 2198-H070-ERS Kinetix 5500, 23 A,195–528 Volt, Safe Torque
Off Drive
These drive modules support the optional attributes and corresponding
control mode functionality as indicated in the following table:
Kinetix 5500 Integrated STO The integrated Kinetix 5500 drive modules include the following catalog
numbers:
Drive Module Optional • 2198-H003-ERS2, Kinetix 5500, 1A, 195-528 Volt, CIP Safe
Attributes Torque Off Drive
• 2198-H008-ERS2, Kinetix 5500, 2.5A, 195-528 Volt, CIP Safe
Torque Off Drive
• 2198-H015-ERS2, Kinetix 5500, 5 A, 195 – 528 Volt, CIP Safe
Torque Off Drive
• 2198-H025-ERS2, Kinetix 5500, 8A, 195- 528 Volt, CIP Safe
Torque Off Drive
• 2198-H040-ERS2, Kinetix 5500, 13 A, 192-528 Volt, CIP Safe
Torque Off Drive
• 2198-H070-ERS2 Kinetix 5500, 23 A,195–528 Volt, CIP Torque
Off Drive
These drive modules support the optional attributes and corresponding
control mode functionality as indicated in the following table:
ID Access Attribute N E F P V T Conditional Implementation
Rule
367 Get Acceleration Fine Command - - Y Y Y
485 Set Acceleration Limit - N Y Y N
482 Get Acceleration Reference - - Y Y N
481 Set Acceleration Trim - - N N N
1376 Set Actuator Diameter N N N N N DScale
1377 Set Actuator Diameter Unit N N N N N DScale
1374 Set Actuator Lead N N N N N DScale
1375 Set Actuator Lead Unit N N N N N DScale
1373 Set Actuator Type N N N N N DScale
836 Set Adaptive Tuning Configuration - - Y Y Y V26/V27
844 Get Adaptive Tuning Gain Scaling Factor - - Y Y Y V26/V27
732/267 Get Analog Input 1 N - N N N N
733/268 Get Analog Input 2 N - N N N N
734 Set Analog Output 1 N - N N N N
735 Set Analog Output 2 N - N N N N
873 Set Auto Sag Configuration - N N N N V26/V27
874 Set Auto Sag Slip Increment - N N N N V26/V27
875 Set Auto Sag Time Limit - N N N N V26/V27
876 Set Auto Sag Start - N N N N V26/V27
30 Set Axis Configuration R R R R R O-Enum
0 = Feedback Only (Y)
1 = Frequency Control (Y)
2 = Position Loop (Y)
3 = Velocity Loop (Y)
4 = Torque Loop (Y)
Kinetix 5700 Safety Drive The Kinetix 5700 single-axis and dual-axis model drives include the
following catalog numbers:
Module Optional Attributes • 2198-S086-ERS3, 43A, 458-747 Volt DC, Network Safety STO
Drive
• 2198-S130-ERS3, 65A, 458-747 Volt DC, Network Safety STO
Drive
• 2198-S160-ERS3, 85A, 458-747 Volt DC, Network Safety STO
Drive
• 2198-D006-ERS3, 2.5A, 458-747 Volt DC, Network Safety STO
Drive
Kinetix 5700 Advanced The Kinetix 5700 advanced safety drive modules include the following
catalog numbers:
Safety Drive Module • 2198-S086-ERS4, 43A, Inverter, Advanced Safety Drive
Optional Attributes • 2198-S130-ERS4, 65A, Inverter, Advanced Safety Drive
• 2198-S160-ERS4, 85A, Inverter, Advanced Safety Drive
• 2198-D006-ERS4, 2x2 5A, Dual-Axis Inverter, Advanced Safety
Drive
• 2198-D0012-ERS4, 2x5A, Dual-Axis Inverter, Advanced Safety
Drive
• 2198-D020-ERS4, 2x8A, Dual-Axis Inverter, Advanced Safety
Drive
• 2198-D032-ERS4, 2x13A, Dual-Axis Inverter, Advanced Safety
Drive
• 2198-D057-ERS4, 2x23A, Dual-Axis Inverter, Advanced Safety
Drive
These drive modules support the optional attributes and corresponding
control mode functionality as indicated in the following table:
Kinetix 5700 CIP Safety The Kinetix 5700 CIP Safety (EtherNet/IP) modules include these
catalog numbers:
(EtherNet/IP) Module • 2198-S263-ERS3 Kinetix 5700, 150A, 458-747 Volt DC, CIP
Optional Attributes Safety (EtherNet/IP)
• 2198-S312-ERS3 Kinetix 5700, 192A, 458-747 Volt DC, CIP
Safety (EtherNet/IP)
These drive modules support the optional attributes and corresponding
control mode functionality as indicated in this table.
ID Access Rule Attribute Name G N E F P V T Conditional Implementation
955 Set AC Line Contactor Input Checking N N - N N N N V32
2034 Set AC Line Current Unbalance Limit N - - - - - - V32
2225 Get AC Line Electrical Angle N - - - - - - V32
2245 Set AC Line Frequency Change Action N - - - - - - O-Enum V32
0 = Continue (N)
2246 Set AC Line Frequency Change N - - - - - - V32
Threshold
2247 Set AC Line Frequency Change Time N - - - - - - V32
2284 Set AC Line High Freq User Limit N - - - - - - V32
2286 Set AC Line High Freq User Limit - N - - - - - - V32
Alternate
2285 Set AC Line Low Freq User Limit N - - - - - - V32
2287 Set AC Line Low Freq User Limit - N - - - - - - V32
Alternate
2289 Set AC Line Overload User Limit N - - - - - - V32
2280 Set AC Line Overvoltage User Limit N - - - - - - V32
2282 Set AC Line Overvoltage User Limit - N - - - - - - V32
Alternate
2041 Set AC Line Source Impedance N - - - - - - V32
Kinetix 5700 CIP Advanced The Kinetix 5700 CIP Advanced Safety (EtherNet/IP) modules include
these catalog numbers:
Safety (EtherNet/IP) Module • 2198-S263-ERS4 Kinetix 5700, 150A, 458-747 Volt DC, CIP
Optional Attributes Advanced Safety (EtherNet/IP)
Kinetix 5700 Regenerative The Kinetix 5700 Regenerative Bus Supply modules include these
catalog numbers:
Bus Supply Module Optional • 2198-RP088 Kinetix 5700 Regenerative Bus Supply, 24kW, 35A /
Attributes 88A
• 2198-RP200 Kinetix 5700 Regenerative Bus Supply, 67kW, 100A
/ 200A
• 2198-RP263 Kinetix 5700 Regenerative Bus Supply, 119kW,
176A / 263A
• 2198-RP312 Kinetix 5700 Regenerative Bus Supply, 140kW,
207A / 312A
These drive modules support the optional attributes and corresponding
control mode functionality as indicated in this table.
ID Access Rule Attribute Name G N E F P V T Conditional Implementation
955 Set AC Line Contactor Input Checking N N - N N N N V32
2034 Set AC Line Current Unbalance Limit Y - - - - - - V32
2225 Get AC Line Electrical Angle Y - - - - - - V32
2245 Set AC Line Frequency Change Action N - - - - - - O-Enum V32
0 = Continue (N)
2246 Set AC Line Frequency Change Y - - - - - - V32
Threshold
2247 Set AC Line Frequency Change Time Y - - - - - - V32
2284 Set AC Line High Freq User Limit N - - - - - - V32
2286 Set AC Line High Freq User Limit - N - - - - - - V32
Alternate
2285 Set AC Line Low Freq User Limit N - - - - - - V32
2287 Set AC Line Low Freq User Limit - N - - - - - - V32
Alternate
2289 Set AC Line Overload User Limit N - - - - - - V32
2280 Set AC Line Overvoltage User Limit N - - - - - - V32
2282 Set AC Line Overvoltage User Limit - N - - - - - - V32
Alternate
923 Set AC Line Resonance User Limit N - - - - - - V32
2041 Set AC Line Source Impedance N - - - - - - V32
2043 Set AC Line Source Impedance - N - - - - - - V32
Alternate
2042 Set AC Line Source Power Y - - - - - - V32
2044 Set AC Line Source Power - Alternate N - - - - - - V32
2040 Set AC Line Source Select N - - - - - - V32
Kinetix 6500 Drive Module The following table identifies the optional attributes and corresponding
control mode functionality supported by a Kinetix 6500 drive module.
Optional Attributes
ID Access Attribute Name N E F P V T Conditional Implementation
Rule
367 Get Acceleration Fine Command - - Y Y Y
485 Set Acceleration Limit - N Y Y N
482 Get Acceleration Reference - - Y Y N
1348 Set Induction Motor Stator Leakage - - N N N N Ind Motor only, V26/V27
Reactance
647 Set Inverter Overload Action - N Y Y Y O-Enum
1 = Current Foldback (Y)
128 = Reduce PWM Rate (N)
129 = PWM Foldback (N)
699 Set Inverter Thermal Overload User Limit - N Y Y Y
1338 Set Linear Motor Damping Coefficient - N N N N Linear Motor only
2313 Set Linear Motor Integral Limit Switch - N N N N Linear Motor only
1336 Set Linear Motor Mass - N Y Y Y Linear Motor only
1337 Set Linear Motor Max Speed - N Y Y Y Linear Motor only
801 Get Load Observer Acceleration Estimate - - Y Y Y
806 Set Load Observer Bandwidth - - Y Y Y
PowerFlex 527 Axis The following table identifies the optional attributes and corresponding
control mode functionality supported by a PowerFlex 527 drive module.
Instance Optional Attributes
ID Access Attribute N E F P V T Conditional Implementation
Rule
367 Get Acceleration Fine Command - - - Y Y N
485 Set Acceleration Limit - - N N N N
482 Get Acceleration Reference - - - N N N
481 Set Acceleration Trim - - - N N N
1376 Set Actuator Diameter - N N N N N DScale
1377 Set Actuator Diameter Unit - N N N N N DScale
1374 Set Actuator Lead - N N N N N DScale
1375 Set Actuator Lead Unit - N N N N N DScale
1373 Set Actuator Type - N N N N N DScale
836 Set Adaptive Tuning Configuration - - - N N N Vxx
844 Get Adaptive Tuning Gain Scaling Factor - - - N N N Vxx
732/267 Get Analog Input 1 N - Y Y Y N
733/268 Get Analog Input 2 N - Y Y Y N
734 Set Analog Output 1 N - Y Y Y N
735 Set Analog Output 2 N - N N N N
873 Set Auto Sag Configuration - - N N N N Vxx
874 Set Auto Sag Slip Increment - - N N N N Vxx
875 Set Auto Sag Slip Time Limit - - N N N N Vxx
876 Set Auto Sag Start - - N N N N Vxx
19 Set Axis Features R R R R R R O-Bits
0 = Fine Interpolation (Y)
1 = Registration Auto-rearm (Y)
2 = Alarm Log (Y)
5 = Hookup Test (Y)
6 = Commutation Test (Y)
7 = Motor Test (Y)
8 = Inertia Test (Y)
9 = Sensorless Control (Y)
10 = Drive Scaling (N)
11 = Ext. Event Block (N)
12 = Integer Cmd. Pos. (N)
13 = Ext. Motor Test (N)
763 Get Axis Safety Faults - N Y Y Y N V24
760 Get Axis Safety State - N Y Y Y N V24
761 Get Axis Safety Status - N Y Y Y N V24
825 Set Backlash Compensation Window - - - N - -
593 Set Brake Prove Ramp Time - - N N N N Vxx
594 Set Brake Slip Tolerance - - N N N N Vxx
592 Set Brake Test Torque - - N N N N Vxx
638/262 Get Bus Regulator Capacity N - N N N N
659 Get CIP Axis Alarms N N Y Y Y N
904 Get CIP Axis Alarms - RA N N Y Y Y N
563 Set Commutation Polarity - - - N N N PM Motor only
562 Set Commutation Self-Sensing Current - - - N N N PM Motor only O-Value = #
PowerFlex 755 Standard The following table identifies the optional attributes and corresponding
control mode functionality supported by a PowerFlex 755-EENET-CM
Drive Module Optional drive module.
Attributes
ID Access Attribute N E F P V T Conditional Implementation
367 Get Acceleration Fine Command - - - N N N
485 Set Acceleration Limit - - N N N N
482 Get Acceleration Reference - - - N N N
481 Set Acceleration Trim - - - N N N
1376 Set Actuator Diameter - N N N N N DScale
1377 Set Actuator Diameter Unit - N N N N N DScale
1374 Set Actuator Lead - N N N N N DScale
1375 Set Actuator Lead Unit - N N N N N DScale
1373 Set Actuator Type - N N N N N DScale
836 Set Adaptive Tuning Configuration - - - N N N V26/V27
844 Get Adaptive Tuning Gain Scaling Factor - - - N N N V26/V27
732/267 Get Analog Input 1 N - Y Y Y Y
733/268 Get Analog Input 2 N - Y Y Y Y
734 Set Analog Output 1 N - Y Y Y Y
PowerFlex 755 High Power, The following table identifies the optional attributes and corresponding
control mode functionality supported by a PowerFlex 755-HiPwr-
Standard Drive Module EENET-CM drive module.
Optional Attributes
ID Access Attribute N E F P V T Conditional Implementation
367 Get Acceleration Fine Command - - - N N N
485 Set Acceleration Limit - - N N N N
482 Get Acceleration Reference - - - N N N
481 Set Acceleration Trim - - - N N N
1376 Set Actuator Diameter - N N N N N DScale
1377 Set Actuator Diameter Unit - N N N N N DScale
1374 Set Actuator Lead - N N N N N DScale
1375 Set Actuator Lead Unit - N N N N N DScale
1373 Set Actuator Type - N N N N N DScale
836 Set Adaptive Tuning Configuration - - - N N N V26/V27
844 Get Adaptive Tuning Gain Scaling Factor - - - N N N V26/V27
732/267 Get Analog Input 1 N - Y Y Y Y
733/268 Get Analog Input 2 N - Y Y Y Y
734 Set Analog Output 1 N - Y Y Y Y
735 Set Analog Output 2 N - Y Y Y Y
873 Set Auto Sag Configuration - - Y Y Y Y V26/V27
874 Set Auto Sag Slip Increment - - Y Y Y Y V26/V27
875 Set Auto Sag Slip Time Limit - - N N N N V26/V27
876 Set Auto Sag Start - - Y Y Y Y V26/27
PowerFlex 755 Low Power, The following table identifies the optional attributes and corresponding
control mode functionality supported by a PowerFlex 755-EENET-CM-S
Non-Network Safety Drive and PowerFlex 755-EENET-CM-S1 drive module.
Module Optional Attributes
ID Access Attribute N E F P V T Conditional Implementation
367 Get Acceleration Fine Command - - - N N N
485 Set Acceleration Limit - - N N N N
482 Get Acceleration Reference - - - N N N
481 Set Acceleration Trim - - - N N N
1376 Set Actuator Diameter - N N N N N DScale
1377 Set Actuator Diameter Unit - N N N N N DScale
1374 Set Actuator Lead - N N N N N DScale
1375 Set Actuator Lead Unit - N N N N N DScale
1373 Set Actuator Type - N N N N N DScale
836 Set Adaptive Tuning Configuration - - - N N N V26/V27
844 Get Adaptive Tuning Gain Scaling Factor - - - N N N V26/V27
732/267 Get Analog Input 1 N - Y Y Y Y
733/268 Get Analog Input 2 N - Y Y Y Y
734 Set Analog Output 1 N - Y Y Y Y
735 Set Analog Output 2 N - Y Y Y Y
873 Set Auto Sag Configuration - - Y Y Y Y V26/V27
874 Set Auto Sag Slip Increment - - Y Y Y Y V26/V27
875 Set Auto Sag Slip Time Limit - - N N N N V26/V27
876 Set Auto Sag Start - - Y Y Y Y V26/27
PowerFlex 755 High Power, The following table identifies the optional attributes and corresponding
control mode functionality supported by a PowerFlex 755-HiPwr-
Non-Network Safety Drive EENET-CM-S and PowerFlex 755-HiPwr-EENET-CM-S1 drive module.
Module Optional Attributes
ID Access Attribute N E F P V T Conditional Implementation
367 Get Acceleration Fine Command - - - N N N
485 Set Acceleration Limit - - N N N N
482 Get Acceleration Reference - - - N N N
481 Set Acceleration Trim - - - N N N
1376 Set Actuator Diameter - N N N N N DScale
1377 Set Actuator Diameter Unit - N N N N N DScale
1374 Set Actuator Lead - N N N N N DScale
1375 Set Actuator Lead Unit - N N N N N DScale
1373 Set Actuator Type - N N N N N DScale
836 Set Adaptive Tuning Configuration - - - N N N V26/V27
844 Get Adaptive Tuning Gain Scaling Factor - - - N N N V26/V27
732/267 Get Analog Input 1 N - Y Y Y Y
733/268 Get Analog Input 2 N - Y Y Y Y
734 Set Analog Output 1 N - Y Y Y Y
735 Set Analog Output 2 N - Y Y Y Y
873 Set Auto Sag Configuration - - Y Y Y Y V26/V27
874 Set Auto Sag Slip Increment - - Y Y Y Y V26/V27
875 Set Auto Sag Slip Time Limit - - N N N N V26/V27
876 Set Auto Sag Start - - Y Y Y Y V26/27
PowerFlex 755 Low and The following table identifies the optional attributes and corresponding
control mode functionality supported by a PowerFlex 755-EENET-CM-
High Power, STO Only S3 and PowerFlex 755-HiPwr-EENET-CM-S3 drive module.
PowerFlex 755 Low and The following table identifies the optional attributes and corresponding
control mode functionality supported by a PowerFlex 755-EENET-CM-
High Power, Advanced S4 and PowerFlex 755-HiPwr-EENET-CM-S4 drive module.
Safety Network Safety
Drive Module Optional
Attributes
ID Access Attribute N E F P V T Conditional Implementation
Rule
367 Get Acceleration Fine Command - - - N N N
485 Set Acceleration Limit - - N N N N
482 Get Acceleration Reference - - - N N N
481 Set Acceleration Trim - - - N N N
836 Set Adaptive Tuning Configuration - - - N N N V26/V27
844 Get Adaptive Tuning Gain Scaling Factor - - - N N N V26/V27
732/267 Get Analog Input 1 N - Y Y Y Y
733/268 Get Analog Input 2 N - Y Y Y Y
734 Set Analog Output 1 N - Y Y Y Y
735 Set Analog Output 2 N - Y Y Y Y
873 Set Auto Sag Configuration - - Y Y Y Y V26/V27
874 Set Auto Sag Slip Increment - - Y Y Y Y V26/V27
875 Set Auto Sag Slip Time Limit - - N N N N V26/V27
876 Set Auto Sag Start - - Y Y Y Y V26/V27
MSG Instruction Access Only The following table lists the attributes that are available to a specific
drive via messaging. The P### references in the Conditional
Attributes Implementation column refer to the related PowerFlex drive parameter.
The CIP Axis Attributes let you configure motion-control system devices
that include feedback devices and drive devices. For drive devices, the
CIP Axis Attributes cover a wide range of drive types from simple
variable frequency (V/Hz) drives, to sophisticated position-control servo
drives. Many commercial drive products have axes that can be
configured to operate in any one of these different motion-control
modes, depending on the specific application requirements.
The CIP Axis Attributes are organized to address the broad range of
functionality. Because of the large number of attributes, they are
organized by functional category.
Data Attributes
Axis Info Attributes on page 330 CIP Axis Status Attributes on page 339
Axis Statistical Attributes on page 338 Event Capture Attributes on page 356
Drive Attributes
Drive General Purpose I/O Attributes on page 361 Power and Thermal Management Configuration
Attributes on page 370
Drive Output Attributes on page 368 Power and Thermal Management Status
Attributes on page 371
Feedback Attributes
Feedback Attributes on page 453 General Feedback Info Attributes on page 470
Feedback Configuration Attributes on page 456 General Feedback Signal Attributes on page 471
Motor Attributes
General Linear Motor Attributes on page 548 Interior Permanent Magnet Motor Attributes on
page 565
General Motor Attributes on page 550 Linear PM Motor Attributes on page 563
General Permanent Magnet Motor Attributes on page 556 Load Transmission and Actuator Attributes on
page 568
General Rotary Motor Attributes on page 559 Rotary PM Motor Attributes on page 570
Induction Motor Attributes on page 561
Safety Attributes
Axis Safety Status Attributes on page 573 Guard Safety Status Attributes on page 588
Converter Bus Voltage Control Configuration Attributes Converter Bus Voltage Control Signal Attributes
on page 644 on page 646
Converter Current Reference Configuration Attributes on Converter Current Reference Signal Attributes
page 649 on page 651
Converter Current Control Configuration Attributes on Converter Current Control Signal Attributes on
page 652 page 654
Converter Reactive Power Control Attributes on page 660 Converter Output Attributes on page 661
See also
Standard Exceptions on page 662
Interpret the Attribute Tables on page 89
Control Mode Attributes The following attribute tables contain control mode related attributes
associated with a Motion Control Axis Object instance.
Acceleration Control These are the acceleration related attributes associated with a Motion
Control Axis.
Attributes
Acceleration Trim
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - C Set/ T REAL 0 -max max Accel Units
SSV accel accel
Acceleration Reference
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - C Get/ T REAL - - - Accel Units
GSV
Acceleration Feedback
Usage Access T Data Default Min Max Semantics of Values
Type
Required - E Get/ T REAL - - - Accel Units
GSV
Output of the Load Observer that, when the Load Observer block is
enabled, is applied to the acceleration reference summing junction. In
the Load Observer configuration, this signal compensates for
disturbances to the load relative to an ideal load model. When the Load
Observer is configured to operate in Acceleration Feedback Only mode,
this signal is the estimated acceleration feedback signal used to close
the acceleration loop. When the Load Observer is disabled, this signal
is 0.
See also
Acceleration Control Configuration Attributes on page 247
Motion Control Configuration Attributes on page 473
Velocity Control Mode on page 24
Acceleration Control These are the acceleration control configuration attributes associated
with a Motion Control Axis.
Configuration Attributes
Load Observer Configuration
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - PV Set USINT 0 - - Enumeration
0 = Disabled (R)
1 = Load Observer Only (O)
2 = Load Observer with
Velocity Estimate (O)
3 = Velocity Estimate Only (O)
4 = Acceleration Feedback (O)
5-255 = Reserved
Kop
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - PV Set T REAL FD 0 Radians/Sec
Koi
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - PV Set T REAL 0 0 Radians/Sec
Kof
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - PV Set REAL 0.5 0
Acceleration Limit
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - C Set REAL 0 0 Accel Control Units/Sec2
2*Eq 3
Deceleration Limit
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - C Set REAL 0 0 Accel Control Units/Sec2
2*Eq 3
See also
Acceleration Control Attributes on page 246
Motion Control Configuration Attributes on page 473
Command Reference These are the command reference generation functionality of the
device that converts command position, velocity, acceleration, and
Generation Attributes torque data output from a controller-based or device-based motion
planner into corresponding command references signals to the device's
motor control structures. The command reference generator
functionality includes fine interpolators, signal selector switches,
dynamic limiters, command notch filters.
See also
Command Generator Signal Attributes on page 253
Command Generator Configuration Attributes on page 249
Command Generator The following are the command generator configuration attributes
associated with a Motion Control Axis:
Configuration Attributes
Skip Speed 1
Usage Access Data Default Min Max Semantics of Values
Type
Optional - F Set/SSV REAL 0 - Velocity Units
The Skip Speed 1 attribute sets the central speed of a skip speed band
within which the device does not operate. The skip speed value is
signed.
Skip Speed 2
Usage Access Data Default Min Max Semantics of Values
Type
Optional - F Set/SSV REAL 0 - Velocity Units
Skip Speed 3
Usage Access Data Default Min Max Semantics of Values
Type
Optional - F Set/SSV REAL 0 - Velocity Units
The Skip Speed 3 attribute sets the central speed of a skip speed band
within which the device does not operate. The skip speed value is
signed.
Ramp Acceleration
Usage Access Data Default Min Max Semantics of Values
Type
Optional - FV Get/SSV REAL 0 0 Accel Units
Derived from
Max Accel
Ramp Deceleration
Usage Access Data Default Min Max Semantics of Values
Type
Optional - FV Get/SSV REAL 0 0 Accel Units
Derived from
Max Decel
The Ramp Jerk Control attribute sets the percentage of accel or decel
time that is applied to the speed ramp as jerk limited S Curve based on
a step change in velocity. The S Curve time is added ½ at the beginning
and ½ at the end of the ramp. A value of 0 results in no S-Curve, for
example, a linear acceleration or deceleration ramp.
A value of 100% results in a triangular acceleration profile with the peak
being the configured ramp acceleration or deceleration.
As the Jerk Control value increases the derived accelerating jerk value
decreases based on:
The Flying Start Enable attribute is used to enable or disable the Flying
Start feature of the device. When Flying Start Enable is true and the
motion axis is enabled, the device determines the current velocity of the
motor, using either the configured Flying Start Method or, if not
supported, a method that is left to the drive vendor's discretion. This
operation is done as part of the Starting State initialization activities.
Just prior to transitioning to the Running state, the device presets the
output of the Ramp Generator to the current velocity. In this way, the
motor seamlessly ramps from its current velocity to the commanded
velocity from the controller. When Flying Start Enable is false, the motor
velocity is irrelevant and a preset of 0 is applied to the Ramp Generator
output.
Some drive vendors do not allow the Flying Start feature to be disabled
when connected to a feedback device. To support this behavior, these
drives do not support the Flying Start Enable attribute, but do support
the Flying Start Method attribute.
See also
Command Generator Signal Attributes on page 253
Command Generator Signal These are the command generator signal attributes associated with a
Motion Control Axis.
Attributes
Position Fine Command
Usage Access T Data Type Default Min Max Semantics of Values
The Position Fine Command attribute is the output value from the
Command Position fine interpolator.
The Velocity Fine Command attribute is the output value from the
Command Velocity fine interpolator. When no Command Velocity signal
is present when performing position control, this signal can be derived
by scaling the Differential Position output value of the Command
Position fine interpolator.
The Acceleration Fine Command attribute is the output value from the
Command Acceleration fine interpolator. When no Command
Acceleration signal is present when performing position or velocity
control, this signal can be derived by scaling the Differential Velocity
output value of the Command Velocity fine interpolator. If no Command
Velocity signal is present, the Interpolated Command Acceleration
signal can be derived by scaling the 2nd Differential Position output
value of the Command Position fine interpolator.
Skip Speed 1
Usage Access T Data Type Default Min Max Semantics of Values
Optional - FV Set REAL 0 - Velocity Control Units/Sec
The Skip Speed 1 attribute sets the central speed of a skip speed band
within which the device does not operate. The skip speed value is
signed.
Skip Speed 2
Usage Access T Data Type Default Min Max Semantics of Values
Optional - FV Set REAL 0 - Velocity Control Units/Sec
The Skip Speed 2 attribute sets the central speed of a skip speed band
within which the device does not operate. The skip speed value is
signed.
Skip Speed 3
Usage Access T Data Type Default Min Max Semantics of Values
Optional - FV Set REAL 0 - Velocity Control Units/Sec
The Skip Speed 3 attribute sets the central speed of a skip speed band
within which the device does not operate. The skip speed value is
signed.
The Skip Speed Band attribute determines the speed window around a
skip speed that cannot be commanded. Skip Speed block adjusts any
command set-point within this window to fall at either the upper or lower
Skip Speed Band boundary value. The device can smoothly accelerate
or decelerate through the skip speed band based on the ramp
generator block but may not operate at a set speed within the band.
The Skip Speed Band is distributed ½ above and ½ below the skip
speed. This Skip Speed Band attribute applies to all skip speeds
supported in the device. A value of 0 for this attribute disables this
feature.
Ramp Acceleration
Usage Access T Data Type Default Min Max Semantics of Values
Ramp Deceleration
Usage Access T Data Type Default Min Max Semantics of Values
The Flying Start Enable attribute enables or disables the Flying Start
feature of the device. When Flying Start Enable is true and the motion
axis is enabled, the device determines the current velocity of the motor,
using either the configured Flying Start Method or, if not supported, a
method that is left to the drive vendor’s discretion. This operation is
done as part of the Starting State initialization activities. Just prior to
transitioning to the Running state, the device presets the output of the
Ramp Generator to the current velocity. The motor seamlessly ramps
from its current velocity to the commanded velocity from the controller.
When Flying Start Enable is false, the motor velocity is irrelevant and a
preset of 0 is applied to the Ramp Generator output.
Some drive vendors do not allow the Flying Start feature to be disabled
when connected to a feedback device. These drives do not support the
Flying Start Enable attribute, but do support the Flying Start Method
attribute.
The Flying Start CEMF Reconnect Delay attribute defines the delay
between the start command and the start of the reconnect function.
The Flying Start CEMF Current Reg Kp attribute sets the proportional
gain for the current regulator that controls the reconnect function.
The Flying Start CEMF Current Reg Ki attribute sets the integral gain for
the current regulator that controls the reconnect function.
The Flying Start CEMF Velocity Reg Kp attribute sets the proportional
gain for the velocity regulator that controls the reconnect function.
The Flying Start CEMF Velocity Reg Ki attribute sets the integral gain
for the velocity regulator that controls the reconnect function.
The Flying Start CEMF Excitation Reg Kp attribute sets the proportional
gain for the current regulator that controls the excitation function when
the reconnect function determines the need.
The Flying Start CEMF Excitation Reg Ki attribute sets the integral
gain for the current regulator that controls the excitation function when
the reconnect function determines the need.
The Flying Start CEMF Brake Level attribute defines the amount of DC
braking current that the drive uses for the Flying Start function. The
Flying Start function applies DC brake current to the motor when it
determines the motor is spinning near zero speed, which brings the
motor to a complete stop before attempting to restart it.
The Flying Start CEMF Brake Time attribute defines the amount of time
the drive applies the DC braking current for the Flying Start function.
The Flying Start Sweep Reconnect Delay attribute sets the delay time
between the start command and the start of the reconnect function. This
is mainly for power loss situations so the restart does not occur too
quickly causing unwanted faults.
The Flying Start Sweep Initial Voltage Reg Kp attribute sets the
proportional gain used by the reconnect function to control the initial
output voltage.
The Flying Start Sweep Initial Voltage Reg Ki attribute sets the integral
gain used by the reconnect function to control the initial output voltage.
The Flying Start Sweep Time attribute sets the time to sweep frequency
in one direction for use with the reconnect function.
The Flying Start Sweep V/Hz DC Boost Adjust attribute sets the voltage
of the 0 Hz point on the V/Hz curve used in the primary sweep method.
The attribute value represents the percentage of the rated stator
resistance voltage drop defined by the product of the Induction Motor
Stator Resistance attribute and the Motor Rated Continuous Current
attribute.
The Flying Start Sweep V/Hz Ratio attribute sets the scale value for a
fixed volts per hertz curve to be used during the sweep.
The attribute value represents the percentage of the rated V/Hz ratio
defined by the Motor Rated Voltage attribute divided by the Induction
Motor Rated Frequency attribute.
The Flying Start Sweep Speed Detect Level attribute sets the level used
by the reconnect function for frequency detection, where the detection
signal remains at this level throughout the time specified in the Flying
Start Sweep Speed Detect Time attribute.
The percentage of Operating Power is defined by the Vq Voltage
Output attribute times the Iq Current Command attribute.
The Flying Start Sweep Speed Detect Time attribute sets the time the
reconnect function uses for frequency detection.
The Flying Start Sweep Recovery Current Reg Ki attribute sets the
integral gain used by the reconnect function in the voltage recovery to
the normal V/Hz level.
The Flying Start Sweep Voltage Reg Kp attribute sets the proportional
gain for the output voltage regulator that controls the reconnect function
The Flying Start Sweep Voltage Reg Ki attribute sets the integral gain
for the output voltage regulator that controls the reconnect function.
The Flying Start Sweep Brake Level attribute defines the level of DC
braking current that the drive uses for the Flying Start function. The
Flying Start function applies DC brake current to the motor when it
determines the motor is spinning near zero speed, in order to bring the
motor to a complete stop before attempting to restart it.
The Flying Start Sweep Zero Speed Threshold attribute defines the
current level that the Flying Start function uses for zero speed detection
when applying DC braking.
The Command Notch Filter Width attribute sets the damping ratio, Zd, in
the denominator of the command notch filter equation that determines
the width of the notch for the 1st command notch filter instance.
The frequency range over which signal attenuation is more than 3dB is
calculated as follows:
Width (Hz) = 2 * Notch Filter Frequency * Notch Filter Width * (1 - z2 -
.5z4 - z6).
Where,
z = Notch Filter Depth / Notch Filter Width
When Notch Filter Depth is set to 0, z = 0.
The Command Notch Filter Depth attribute sets the damping ratio, Zn,
in the numerator of the command notch filter equation that determines
the depth of the notch for the first command notch filter instance.
The notch filter depth at the center frequency can be calculated as
follows:
Depth (dB) = 20log10 (z).
Where,
z = Notch Filter Depth / Notch Filter Width
When Notch Filter Depth is set to 0, z = 0.
The Command Notch Filter Gain attribute sets the high frequency gain
of first command notch filter instance. For notch filter operation, the
value for this attribute is set to 1. A value greater than 1 results in a
lead-lag filter function and a value less than 1 results in a lag-lead filter
function. A value of 0 results in a low pass filter function.
The Command Notch Filter 2 Width attribute sets the damping ratio, Zd,
in the denominator of the command notch filter equation that determines
the width of the notch for the 2nd command notch filter instance.
The frequency range over which signal attenuation is more than 3dB
can be calculated as follows:
Width (Hz) = 2 * Notch Filter Frequency * Notch Filter Width * (1 - z2 -
.5z4 - z6).
Where,
z = Notch Filter Depth / Notch Filter Width
When Notch Filter Depth is set to 0, z = 0.
The Command Notch Filter 2 Depth attribute sets the damping ratio, Zn,
in the numerator of the command notch filter equation that determines
the depth of the notch for the second command notch filter instance.
The notch filter depth at the center frequency is calculated as follows:
Depth (dB) = 20log10 (z).
Where,
z = Notch Filter Depth / Notch Filter Width
When Notch Filter Depth is set to 0, z = 0.
The Command Notch Filter 2 Gain attribute sets the high frequency gain
of second command notch filter instance. For notch filter operation, the
value for this attribute is set to 1. A value greater than 1 results in a
lead-lag filter function and a value less than 1 results in a lag-lead filter
function. A value of 0 results in a low pass filter function.
See also
Command Generator Configuration Attributes on page 249
Current Control These are the current control configuration attributes associated with a
Motion Control Axis.
Configuration Attributes
Current Vector Limit
Usage Access Data Default Min Max Semantics of Values
Type
Optional - D Set REAL 100 0 103 % Motor Rated
FD
Kqp
Usage Access Data Default Min Max Semantics of Values
Type
Optional - C Set REAL 0 0 Radians/Sec
FD
Kqi
Usage Access Data Default Min Max Semantics of Values
Type
Optional - C Set/SSV REAL 0 0 Radians/Sec
The Kqi attribute determines Iq Integral Gain value that, together with
Kdp, multiplies the Iq Current Error signal before applying it to the Iq
Integrator Error accumulator. The reciprocal of this value, 1/Kdi,
represents the integrator time constant for the flux current loop. A value
of 0 for this attribute disables the integrator.
Kdp
Usage Access Data Default Min Max Semantics of Values
Type
Optional - C Set REAL 0 0 Radians/Sec
DB
Kdi
Usage Access Data Default Min Max Semantics of Values
Type
Optional - C Set REAL 0 0 Radians/Sec
DB
The Kdi attribute determines the Id Integral Gain value that, together
with Kdp, multiplies the Id Current Error signal before applying it to the
Id Integrator Error accumulator. The reciprocal of this value, 1/Kdi,
represents the integrator time constant for the flux current loop. A value
of 0 for this attribute disables the integrator.
The Flux Integral Time Constant value determines the response time of
the flux producing current loop integrator. When used for Pole-Zero
cancelation, this value is set to the electrical time constant of the motor.
A value of 0 for the Flux Integral Time Constant disables the integrator.
Flux Up Control
Usage Access Data Default Min Max Semantics of Values
Type
Optional- D Set USINT 0 - - Enumeration
(Induction Motor) 0 = No Delay (R)
1 = Manual Delay (O)
2 = Automatic Delay (O)
3-255 = Reserved
Flux Up Time
Usage Access Data Default Min Max Semantics of Values
Type
Optional - D Set REAL 0 0 103 Seconds
(Induction Motor)
The Flux Up Time attribute sets the amount of time the drive device
allows to build full motor flux before transitioning to the Running state.
Commutation Offset
Usage Access Data Default Min Max Semantics of Values
Type
Required - CE Set REAL 0 0 Electrical Degrees
(PM Motor) !LTM DB
Commutation Polarity
Usage Access Data Default Min Max Semantics of Values
Type
Optional - CE USINT 0 - - Enumeration
Set
(PM Motor) 0 = Normal Polarity
1 = Inverted Polarity
2-255 = Reserved
Commutation Alignment
Usage Access Data Default Min Max Semantics of Values
Type
Optional - CE Set USINT 0 0 Enumeration:
(PM Motor) !LTM 0 = Not Aligned (R)
1 = Controller Offset (R)
2 = Motor Offset (O)
3 = Self-Sense (O)
4-255 = Reserved
See also
CIP Axis Attributes on page 243
Current Control Signal These are the current control signal related attributes associated with a
Motion Control Axis.
Attributes
Current Command
Usage Access T Data Default Min Max Semantics of Values
Type
Required - C Get/GSV T REAL - - - % Motor Rated
Current Reference
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - C Get/GSV T REAL - - - % Motor Rated
The Current Reference attribute is the current reference signal, Iq, into
the torque current loop summing junction.
The Flux Current Reference attribute is the current reference signal, Id,
into the flux producing current loop summing junction.
Current Disturbance
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - C Set/SSV T REAL - - - % Motor Rated
Current Error
Usage Access T Data Default Min Max Semantics of
Type Values
Optional - C Get/GSV T REAL - - - % Motor Rated
Error between commanded and actual current that is the output of the
torque producing, q-axis, current loop summing junction.
Error between commanded and actual current that is the output of the
flux producing, d-axis, current loop summing junction.
Current Feedback
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - C Get/GSV T REAL - - - % Motor Rated
Vq Id Decoupling Gain
Usage Access T Data Default Min Max Semantics of Values
Type
Vd Iq Decoupling Gain
Usage Access T Data Default Min Max Semantics of Values
Type
Value to set the bandwidth for the Iq feedback filter used to compensate
for changes in Lq due to magnetic saturation effects of PM motor types.
Optional - C, !E
(IM) Set/SSV REAL 524 0 Hz/Amp
Value to set the proportional gain used by the flux vector frequency
regulator for closed loop flux vector operation without a feedback device
(encoderless or sensorless operation). This regulator allows the drive to
maintain proper field orientation and torque producing current, Iq, by
adjusting the output frequency of the drive.
Value to set the integral gain used by the flux vector frequency regulator
for closed loop flux vector operation without a feedback device
(encoderless or sensorless operation). This regulator allows the drive to
maintain proper field orientation and torque producing current, Iq, by
adjusting the output frequency of the drive.
Value to set the filter bandwidth for the Iq current signal used to adjust
voltage and frequency to stabilize the motor.
Optional - D !E
Set/SSV REAL 5162 0 Volts/Amp
Value to set the gain of the voltage stability control function based on
the filtered Iq current signal.
Value to set the gain of the electrical angle stability control function
based on the filtered Iq current signal.
5-255 = Reserved
Specifies the method used by the drive to establish absolute rotor (or
linear motor magnet track) alignment relative to stator windings (or
linear motor moving coil) for the purposes of PM motor commutation
when starting up the drive. If this attribute is not supported, the
commutation startup method is determined implicitly by the Feedback 1
Type selection. Likewise, if this attribute is supported and set to From
Feedback Type, the commutation startup method is also determined
implicitly by the Feedback 1 Type selection.
The UVW startup method uses UVW signals from motor mounted
encoder tracks or Hall sensors together with the Commutation Offset to
properly align the rotor with stator windings or, in the case of a linear
motor, the moving coil with magnet track. Once aligned, commutation is
maintained via position signals from the motor mounted feedback
device, that is, Feedback 1.
The Digital startup method uses Digital signals from a motor mounted
absolute feedback device together with the Commutation Offset to align
the rotor with stator windings or, in the case of a linear motor, the
moving coil with the magnet track.
The Self-Sensing start-up method applies current to the motor stator (or
moving coil) during the initial Starting state to force the rotor (or moving
coil) to the Null position and thereby achieve proper commutation
alignment. Once aligned, commutation is maintained via position signals
from the motor mounted feedback device, Feedback 1. This method is
used when there is no absolute feedback available to align the motor,
for example. a motor equipped with an incremental encoder.
Commutation Offset
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - CE
% Motor Rated
(PM) Set/GSV REAL 100 0 200
Commutation Polarity
Usage Access T Data Default Min Max Semantics of Values
Type
Enumeration:
Optional - CE 0 = Normal
(PM) Set/SSV* USINT 0 - - 1 = Inverted
2-255 = (reserved)
Commutation Alignment
Usage Access T Data Default Min Max Semantics of Values
Type
Enumeration:
0 = Not Aligned (R)
1 = Controller Offset (R)
Optional - CE 2 = Motor Offset (O)
(PM) 3 = Self-Sense (O)
Set/GSV USINT 0 DB - -
(!LTM) 4 = Database Offset
(O)
5-255 = Reserved
See also
Current Control Configuration Attributes on page 265
CIP Axis Attributes on page 243
Frequency Control These are the Frequency Control Configuration attributes associated
with the Frequency Control method of operation of a Motion Control
Configuration Attributes Axis.
Maximum Voltage
Usage Access Data Default Min Max Semantics of Values
Type
Required - F Set/SSV REAL 460 0 Volts (RMS)
FD
Maximum Frequency
Usage Access Data Default Min Max Semantics of Values
Type
Required - F Set/SSV REAL 130 0 Hertz
FD
The Maximum Frequency attribute sets the highest frequency the drive
device can output.
Break Voltage
Usage Access Data Default Min Max Semantics of Values
Type
Required - F Set/SSV REAL 230 0 Volts (RMS)
FD
Break Frequency
Usage Access Data Default Min Max Semantics of Values
Type
Required - F Set/SSV REAL 30 0 Hertz
FD
The Break Frequency attribute sets the output frequency of the drive
device at the Break Voltage where boost ends.
Only applicable in Basic V/Hz mode.
Start Boost
Usage Access Data Default Min Max Semantics of Values
Type
Required - F Set/SSV REAL 8.5 0 Volts (RMS)
FD
The Start Boost attribute sets phase-to-phase voltage boost level for
starting and accelerating.
Only applicable in Basic V/Hz mode.
Run Boost
Usage Access Data Default Min Max Semantics of Values
Type
Required - F Set/SSV REAL 8.5 0 Volts (RMS)
FD
The Run Boost attribute sets the phase-to-phase voltage boost level for
steady-state speed or deceleration.
Only applicable in Basic V/Hz mode and Fan/Pump V/Hz modes.
The Current Limit Regulator Kp attribute sets the proportional gain that
regulates the output frequency so as to prevent overcurrent conditions.
Effective during fast acceleration or large load step changes.
The Current Limit Regulator Ki attribute sets the integral gain that
regulates the output frequency so as to prevent overcurrent conditions.
Effective during fast acceleration or large load step changes.
See also
CIP Axis Attributes on page 243
Frequency Control Signal This attribute is the signal attribute associated with the Frequency
Control method of operation of a Motion Control Axis.
Attribute
Slip Compensation
Usage Access T Data Default Min Max Semantics of Values
Type
Required - F Get T REAL - - - RPM
See also
Frequency Control Configuration Attributes on page 280
CIP Axis Attributes on page 243
Position Loop Signal These are the position loop signal related attributes associated with a
Motion Control Axis.
Attributes
Position Command
Usage Access T Data Default Min Max Semantics of Values
Type
Required - P Get T DINT 0 -maxpos maxpos Position Control Units
Position Trim
Usage Access T Data Default Min Max Semantics of Values
Type
Required - P Set T DINT 0 -maxpos maxpos Position Control Units
Position Reference
Usage Access T Data Default Min Max Semantics of Values
Type
Required - P Get T DINT - - - Position Control Units
Position Feedback
Usage Access T Data Type Default Min Max Semantics of Values
This 64-bit position feedback value, when supported, extends the range
of the 32-bit Position Feedback attribute. When configured for Position
Control mode, the lower 32-bits of this attribute becomes the Position
Feedback signal that is applied to the position proportional control
summing junction. In most cases the Position Feedback – 64 Bit signal
is derived directly from the feedback device specified by the Feedback
Mode selection. If axis Feedback Mode is configured for Master
Feedback Position Feedback – 64 Bit represents the actual position of
the feedback device specified by the Feedback Master Select. If
Feedback Master Select is not supported, the Feedback 1 channel is
used.
Position Error
Usage Access T Data Default Min Max Semantics of Values
Type
The Position Error attribute is the error between commanded and actual
position that is the output of the position loop summing junction.
The Position Loop Output attribute is the output of the position loop
forward path representing the total control effort of the position loop.
See also
Position Control Mode on page 23
Position Loop Configuration Attributes on page 287
CIP Axis Attributes on page 243
Position Loop Configuration These are the position loop configuration attributes associated with a
Motion Control Axis.
Attributes
Kpi
Usage Access T Data Default Min Max Semantics of Values
Type
Required - P Set REAL 0 0 Radians/Sec
The Kpi attribute is the Position Integral Gain value that, together with
the Kpp, multiplies the Position Integrator Error signal to form the
integral control signal that is summed together with the proportional
control signal to generate the output of the position control loop. The
reciprocal of this value, 1/Kpi, represents the integrator time constant for
the position loop. A value of 0 for this attribute disables the integrator.
Kpp
Usage Access T Data Default Min Max Semantics of Values
Type
Required - P Set REAL 0 0 Radians/Sec
The Kpp attribute is the Position Proportional Gain value that multiplies
the Position Error signal to form the proportional control signal that
summed together with the integral control signal to generate the output
of the position control loop. This value directly determines the
bandwidth of the position loop.
Kvff
Usage Access T Data Default Min Max Semantics of Values
Type
Required - P Set REAL 0 0 %
The Kvff attribute is the Velocity Feedforward Gain value that multiplies
the Velocity Feedforward Command signal to form the Velocity
Feedforward Command that is applied to the output of the position
control loop. 100% Velocity Feedforward applies the full Velocity Fine
Command signal to the velocity loop.
The Position Lead Lag Filter Bandwidth attribute sets the pole
frequency for the position regulator Lead-Lag Filter. A value of 0
disables the filter.
The Position Lead Lag Filter Gain attribute sets the high frequency gain
of the position regulator Lead-Lag Filter. A value greater than 1 results
in a lead function and value less than 1 results in a lag function. A value
of 1 disables the filter.
The Position Limit - Positive attribute is a value that defines the most
positive position value. Exceeding the value while commanding motion
in the positive direction generate a Position Overtravel Positive
exception.
This value defines the most negative position feedback value that when
exceeded while commanding motion in the negative direction,
generates a Position Overtravel Negative exception.
See also
Position Loop Signal Attributes on page 285
Position Control Mode on page 23
CIP Axis Attributes on page 243
Torque/Force Control These are the torque/force control configuration attributes associated
with a Motion Control Axis.
Configuration Attributes
Torque Offset
Usage Access T Data Default Min Max Semantics of Values
Type
Required - C Set/SSV REAL 0 -100 +100 % Motor Rated
System Inertia
Usage Access T Data Default Min Max Semantics of Values
Type
Required - PV Set/SSV T REAL 0 0 % Motor Rated / (Motor
Optional - T FD Units/Sec2)
Sets the pole frequency for the torque reference Lead-Lag Filter. A
value of 0 disables the filter.
Sets the high frequency gain of the torque reference Lead-Lag Filter. A
value greater than 1 results in a lead function and value less than 1
results in a lag function. A value of 0 results in a first order low pass
filter function. A value of 1 disables the filter.
The Torque Notch Filter Width attribute sets the damping ratio, Zd, in
the denominator of the torque notch filter equation that determines the
width of the notch for the first torque notch filter instance.
The frequency range over which signal attenuation is more than 3dB
can be calculated as follows:
Width (Hz) = 2 * Notch Filter Frequency * Notch Filter Width * (1 - z2 -
.5z4 - z6).
Where,
z = Notch Filter Depth / Notch Filter Width
When Notch Depth is set to 0, z = 0.
The Torque Notch Filter Depth attribute sets the damping ratio, Zn, in
the numerator of the torque notch filter equation that determines the
depth of the notch for the first torque notch filter instance.
The notch filter depth at the center frequency can be calculated as
follows:
Depth (dB) = 20log10 (z).
Where,
z = Notch Filter Depth / Notch Filter Width
When Torque Notch Depth is set to 0, z = 0.
The Torque Notch Filter Gain attribute sets the high frequency gain of
first torque notch filter instance. For notch filter operation, the value for
this attribute is set to 1. A value greater than 1 results in a lead-lag filter
function and a value less than 1 results in a lag-lead filter function. A
value of 0 results in a low pass filter function.
The Torque Notch Filter 2 Width attribute sets the damping ratio, Zd, in
the denominator of the torque notch filter equation that determines the
width of the notch for the second torque notch filter instance.
The frequency range over which signal attenuation is more than 3dB
can be calculated as follows:
Width (Hz) = 2 * Notch Filter Frequency * Notch Filter Width * (1 - z2 -
.5z4 - z6).
Where,
z = Notch Filter Depth / Notch Filter Width
When Notch Depth is set to 0, z = 0.
The Torque Notch Filter Depth attribute sets the damping ratio, Zn, in
the numerator of the torque notch filter equation that determines the
depth of the notch for the second torque notch filter instance.
The notch filter depth at the center frequency can be calculated as
follows:
Depth (dB) = 20log10 (z).
Where,
z = Notch Filter Depth / Notch Filter Width
When Torque Notch Depth is set to 0, z = 0
The Torque Notch Filter Gain attribute sets the high frequency gain of
second torque notch filter instance. For notch filter operation, the value
for this attribute is set to 1. A value greater than 1 results in a lead-lag
filter function and a value less than 1 results in a lag-lead filter function.
A value of 0 results in a low pass filter function.
The Torque Notch Filter 2 Width attribute sets the damping ratio, Zd, in
the denominator of the torque notch filter equation that determines the
width of the notch for the third torque notch filter instance.
The frequency range over which signal attenuation is more than 3dB
can be calculated as follows:
Width (Hz) = 2 * Notch Filter Frequency * Notch Filter Width * (1 - z2 -
.5z4 - z6).
Where,
z = Notch Filter Depth / Notch Filter Width
When Notch Depth is set to 0, z = 0.
The Torque Notch Filter Depth attribute sets the damping ratio, Zn, in
the numerator of the torque notch filter equation that determines the
depth of the notch for the third torque notch filter instance.
The notch filter depth at the center frequency can be calculated as
follows:
Depth (dB) = 20log10 (z).
Where,
z = Notch Filter Depth / Notch Filter Width
When Torque Notch Depth is set to 0, z = 0
The Torque Notch Filter Gain attribute sets the high frequency gain of
third torque notch filter instance. For notch filter operation, the value for
this attribute is set to 1. A value greater than 1 results in a lead-lag filter
function and a value less than 1 results in a lag-lead filter function. A
value of 0 results in a low pass filter function.
The Torque Notch Filter 2 Width attribute sets the damping ratio, Zd, in
the denominator of the torque notch filter equation that determines the
width of the notch for the fourth torque notch filter instance.
The frequency range over which signal attenuation is more than 3dB
can be calculated as follows:
Width (Hz) = 2 * Notch Filter Frequency * Notch Filter Width * (1 - z2 -
.5z4 - z6).
Where,
z = Notch Filter Depth / Notch Filter Width
When Notch Depth is set to 0, z = 0.
The Torque Notch Filter Depth attribute sets the damping ratio, Zn, in
the numerator of the torque notch filter equation that determines the
depth of the notch for the fourth torque notch filter instance.
The notch filter depth at the center frequency can be calculated as
follows:
Depth (dB) = 20log10 (z).
Where,
z = Notch Filter Depth / Notch Filter Width
When Torque Notch Depth is set to 0, z = 0
The Torque Notch Filter Gain attribute sets the high frequency gain of
fourth torque notch filter instance. For notch filter operation, the value
for this attribute is set to 1. A value greater than 1 results in a lead-lag
filter function and a value less than 1 results in a lag-lead filter function.
A value of 0 results in a low pass filter function.
This positive value determines the maximum positive torque that can be
applied to the motor. If the device attempts to exceed this value, the
torque command is clamped to this value.
This negative value determines the most negative torque value that can
be applied to the motor. If the device attempts to apply a more negative
torque than this limit, the torque command is clamped to this value.
Torque Threshold
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - C Set/SSV REAL 90 0 103 % Motor Rated
FD
Overtorque Limit
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - D Set/SSV REAL 200 0 103 % Motor Rated
Undertorque Limit
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - D Set/SSV REAL 10 0 103 % Motor Rated
The Torque Estimate Notch 1 Width attribute sets the damping ratio, Zd,
in the denominator of the notch filter equation that determines the width
of the notch of the first torque estimate notch filter instance.
The frequency range over which signal attenuation is more than 3dB
can be calculated as follows:
Width (Hz) = 2 * Notch Filter Frequency * Notch Filter Width * (1 - z2 -
.5z4 - z6).
Where, z = Notch Filter Depth / Notch Filter Width
When Notch Filter Depth is set to 0, z = 0.
The Torque Estimate Notch 1 Depth attribute sets the damping ratio,
Zn, in the numerator of the notch filter equation that determines the
depth of the notch of the first torque estimate notch filter instance.
The notch filter depth at the center frequency can be calculated as
follows:
Depth (dB) = 20log10 (z). Where, z = Notch Filter Depth / Notch Filter
Width
When Notch Filter Depth is set to 0, z = 0.
The Torque Estimate Notch 1 Gain attribute sets the high frequency
gain of the first torque estimate notch filter instance. For notch filter
operation, the value for this attribute is set to 1. A value greater than 1
results in a lead-lag filter function and a value less than 1 results in a
lag-lead filter function. A value of 0 results in a low pass filter function.
The Torque Estimate Notch 2 Width attribute sets the damping ratio, Zd,
in the denominator of the notch filter equation that determines the width
of the notch of the second torque estimate notch filter instance.
The frequency range over which signal attenuation is more than 3dB
can be calculated as follows:
Width (Hz) = 2 * Notch Filter Frequency * Notch Filter Width * (1 - z2 -
.5z4 - z6).
Where, z = Notch Filter Depth / Notch Filter Width
When Notch Filter Depth is set to 0, z = 0.
The Torque Estimate Notch 2 Gain attribute sets the high frequency
gain of the second torque estimate notch filter instance. For notch filter
operation, the value for this attribute is set to 1. A value greater than 1
results in a lead-lag filter function and a value less than 1 results in a
lag-lead filter function. A value of 0 results in a low pass filter function.
The Adaptive Tuning Gain Scaling Factor Min attribute sets the lower
limit on the Adaptive Tuning Gain Scaling Factor when the Adaptive
Tuning function is active.
This value can be set to prevent the Adaptive Tuning algorithm from
decreasing the bandwidth of the control loop to the point where there is
insufficient torque to effectively control the load.
The Torque Notch Low Pass Filter Bandwidth Min attribute sets the
upper limit on the Torque Notch Filter Frequency Estimate value for the
Adaptive Tuning function. The frequency of an identified natural
resonance must be lower than this limit to be applied to the Torque
Notch Filter Frequency Estimate.
This value sets the upper limit on the Torque Notch Filter Frequency
Estimate value for the Adaptive Tuning function. The frequency of an
identified natural resonance must be lower than this limit to be applied
to the Torque Notch Filter Frequency Estimate.
This value sets the lower limit on the Torque Notch Filter Frequency
Estimate value for the Adaptive Tuning function. The frequency of an
identified natural resonance must be higher than this limit to be applied
to the Torque Notch Filter Frequency Estimate.
This value represents the Bandwidth of the Torque Low Pass Filter
when the Adaptive Tuning Configuration is equal to Gain Stabilization or
Tracking Notch and Gain Stabilization. The value is modified by the
Adaptive Tuning function. The value is initialized to the Torque Low
Pass Filter Bandwidth when the Adaptive Tuning Configuration
transitions from Disabled or Tracking Notch to Gain Stabilization or
Tracking Notch and Gain Stabilization. The Torque Low Pass Filter
Bandwidth Estimate value is initialized to zero when the drive is power
cycled or reset.
When the selected Adaptive Tuning Configuration has enabled the Gain
Stabilization function, this value proportionally scales the servo loop
gain attributes of the associated axis as directed by the Adaptive Tuning
function.
After a drive power cycle or reset, the value of this attribute is initialized
to the last known value stored in non-volatile memory.
When the Adaptive Tuning Configuration is charged to disable the Gain
Stabilization function, this attribute is initialized to 1.
See also
Torque Force Control Signal Attributes on page 317
Velocity Control Mode on page 24
Motor Adaptation Attributes These are the Motor Adaptation attributes configuration attributes
associated with a Motion Control Axis.
The Motor Adaption Speed attribute sets the speed at which the motor
adaption functions become active. These functions include the torque,
slip, and flux adaption functions. Collectively, these functions are
designed to compensate for changes in motor performance due to
temperature, speed, current, and manufacturing variations.
The Torque Adaption Regulator Ki attribute sets the integral gain for the
torque regulator associated with the torque adaption function.
Conceptually, this regulator adds a trim signal to the current reference
to improve the accuracy of applied motor torque.
The Slip and Flux Regulator Slew Time attribute determines the
maximum amount of time after the motor speed reaches the level
specified by the Motor Adaption Speed attribute that the slip and flux
regulators are allowed to converge before the slip and flux
compensation provided by these regulators are applied. If the regulators
have not completed the convergence process in the time specified by
this attribute, the slip and flux compensation shall be applied without
further qualification.
The Slip and Flux Regulator Slew Rate attribute determines the rate at
which the slip and flux regulators are allowed to converge.
The Slip Adaption Regulator Iq Threshold attribute sets for the torque
threshold above which the slip regulator of the slip adaption function
becomes active.
The Slip Adaption Regulator Kp attribute sets the proportional gain for
the slip regulator associated with the slip adaption function.
The Slip Adaption Regulator Ki attribute sets the integral gain for the
slip regulator associated with the slip adaption function.
The Flux Adaption Regulator Kp attribute sets the proportional gain for
the flux regulator associated with flux adaption function.
See also
Torque/Force Control Configuration Attributes on page 291
Torque/Force Control These are the torque/force signal related attributes associated with a
Motion Control Axis.
Signal Attributes
Torque Command
Usage Access T Data Default Min Max Semantics of Values
Type
Required - C Get/GSV T REAL - - % Motor Rated
Command torque output from fine interpolator (if active) into torque
input summing junction when configured for toque control.
Torque Trim
Usage Access T Data Default Min Max Semantics of Values
Type
Required - C Set/SSV T REAL 0 - % Motor Rated
Torque Reference
Usage Access T Data Default Min Max Semantics of Values
Type
Required - C Get/GSV T REAL - - - % Motor Rated
Torque Estimate
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - C Get/GSV T REAL - - - % Motor Rated
See also
Torque Control Mode on page 25
Torque/Force Control Configuration Attributes on page 291
Velocity Loop Configuration These are the velocity loop configuration attributes associated with a
Motion Control Axis.
Attributes
Velocity Offset
Usage Access T Data Default Min Max Semantics of Values
Type
Required - PV Set/SSV REAL 0 -maxspd maxspd Velocity Units
Velocity Droop
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - FPV Set/SSV REAL 0 0 Velocity Units / Sec / %
Rated
The Velocity Low Pass Filter Bandwidth attribute controls the bandwidth
of the Low Pass Filter applied to the Velocity Error signal.
Recommended implementation is a two pole IIR filter. A value of 0 for
this attribute disables this feature.
Velocity Threshold
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - ED Set/SSV REAL 0 0 Velocity Units
FD
The Velocity Limit - Positive attribute defines the most positive velocity
reference value into the velocity summing junction. If the signal entering
the velocity limiter exceeds this velocity limit value, the device responds
by clamping the velocity reference to this limit and sets the Velocity
Limit status bit.
Slat Configuration
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - V Set/SSV BYTE 0 - - 0 = SLAT Disabled
1 = SLAT Min
Speed/Torque
2 = SLAT Max
Speed/Torque
Speed Error level to switch from Speed control to Min/ Max control.
Time delay after SLAT Set Point is reached to switch from Speed
control to Min/ Max control.
The active 'Max' select function will select the larger, or Max function, of
the Velocity Loop Output or the Torque Command. The Velocity
Command value is a negative quantity and so when the motor speed is
mechanically limited, the Velocity Error is a negative value, and the
Velocity Loop Output is a saturated (limited) to a negative value. The
324 Rockwell Automation Publication MOTION-RM003L-EN-P - September 2020
Chapter 4 CIP Axis Attributes
Torque Command is also negative, but smaller in magnitude, so it
becomes selected by the 'Max' operation.
The forced transition to speed control occurs when the Velocity Error
value becomes positive such as when the mechanical limitation is
removed. A preset of the velocity loop's integral term occurs, as before.
When, by restoring the mechanical constraint, the Velocity Error
becomes negative again and less than the negated SLAT Set-point
parameter value for a SLAT Time delay, speed control is turned off and
the 'Max' select operation becomes active.
See also
Position Loop Attributes on page 285
Position Loop Configuration Attributes on page 287
Velocity Loop Attributes on page 325
Velocity Loop Signal These are the velocity control signal related attributes associated with a
Motion Control Axis.
Attributes
Velocity Command
Usage Access T Data Default Min Max Semantics of Values
Type
Required - FPV Get T REAL - - - Velocity Control
Units/Second
Velocity Trim
Usage Access T Data Default Min Max Semantics of Values
Type
Required - FPV Set T REAL 0 -maxspd maxspd Velocity Control
Units/Second
Velocity Reference
Usage Access T Data Default Min Max Semantics of Values
Type
Required - FPV Get T REAL - - - Velocity Control
Units/Sec
Velocity Feedback
Usage Access T Data Default Min Max Semantics of Values
Type
Required - ED Get T REAL - - - Velocity Control
Units/Sec
Velocity Error
Usage Access T Data Default Min Max Semantics of Values
Type
Required - PV Get T REAL - - - Velocity Control
Units/Sec
Error between the velocity reference and velocity feedback value that is
the output of the velocity loop summing junction.
Output of velocity forward path representing the total control effort of the
velocity loop.
Field Weakening
PM motors can also be operated using a technique called "field
weakening" to extend the top speed capability of the motor. Field
weakening uses active current vector control to reduce the effective
magnetic field strength from the permanent magnets, enabling higher
speeds at the expense of lower torque production. While the use of field
weakening to significantly extend motor speed range is more common
for Interior PM (IPM) motors, the speed range of Surface-mount PM
(SPM) motors can be significantly extended as well. The following graph
illustrates the PM Motor Torque-Speed Curve with Field Weakening.
See also
Position Loop Signal Attributes on page 285
Position Loop Configuration Attributes on page 287
Velocity Loop Configuration Attributes on page 318
General Permanent Magnet Motor Attributes on page 556
Data Attributes These attribute tables contain attributes associated with general data of
Motion Control Axis Object instance.
Axis Info Attributes These are the attributes that provide information about the associated
hardware capabilities of Motion Control Axis.
The Inverter Rated Output Voltage attribute is the drive inverter output
voltage rating. This value is hard coded in the device.
The Inverter Rated Output Current attribute is the drive inverter output
current rating. This value is hard coded in the device.
The Inverter Rated Output Power attribute is the drive inverter output
power rating. This value is hard coded in the device.
The Converter Rated Input Power attribute is the converter input power
rating.
See also
Drive Output Attributes on page 368
Power and Thermal Management Configuration Attributes on
page 370
Converter Current Reference Signal Attributes on page 651
Frequency Analysis These are the frequency analysis configuration attributes associated
with a Motion Control Axis.
Attributes
Frequency Analysis Status
Usage Access Data Default Min Max Semantics of Values
Type
Optional - GC Get USINT Enumeration:
0 = Inactive
1 = Configuring System
2 = Collecting Data
3 = Analyzing Data
4 = Data Ready
5-255 = (reserved)
Waterfall Index
Usage Access Data Default Min Max Semantics of Values
Type
Optional - GC Get USINT Range: 1 to 1000
Specifies the index into the Frequency Table associated with the
singular input frequency applied during the last frequency analysis test.
This attribute is only applicable when the frequency analysis test was
using the Waterfall Excitation Type.
Frequency Samples
Usage Access Data Default Min Max Semantics of Values
Type
Optional - GC Get USINT Range: 1 to 1000
Frequency Table
Usage Access Data Default Min Max Semantics of Values
Type
Optional - GC Get REAL Hertz
[200]
Output Magnitude
Usage Access Data Default Min Max Semantics of Values
Type
Optional - GC Get REAL Decibels
[200]
Output Phase
Usage Access Data Default Min Max Semantics of Values
Type
Optional - GC Get REAL Degrees
[200]
Gain Margin
Usage Access Data Default Min Max Semantics of Values
Type
Optional - GC Get REAL Decibels
The frequency associated with the Gain Margin. The attribute value is
interpolated based on the Frequency Table array.
Phase Margin
Usage Access Data Default Min Max Semantics of Values
Type
Optional - GC Get REAL Degrees
See also
Axis Info Attributes on page 330
Data Logging Attributes These are the data logging attributes associated with a Motion Control
Axis.
Index location in data log of the sample associated with trigger event.
Data Log 1
Usage Access Data Default Min Max Semantics of Values
Type
Optional - All Get LINT* Units of associated data
[N] source attribute.
Data Log 2
Usage Access Data Default Min Max Semantics of Values
Type
Optional - All Get LINT* Units of associated data
[N] source attribute.
General purpose array type attribute for storing sampled real-time axis
data.
* 64-bit data container can be used to transfer any data type associated
with Attribute ID. Data Types less than 64-bits shall be least significant
word aligned with no sign extension. Size of the array is left to vendors
discretion.
Data Log 3
Usage Access Data Default Min Max Semantics of Values
Type
Optional - All Get LINT* Units of associated data
[N] source attribute.
General purpose array type attribute for storing sampled real-time axis
data.
* 64-bit data container can be used to transfer any data type associated
with Attribute ID. Data Types less than 64-bits shall be least significant
word aligned with no sign extension. Size of the array is left to vendors
discretion.
Data Log 4
Usage Access Data Default Min Max Semantics of Values
Type
Optional - All Get LINT* Units of associated data
[N] source attribute.
General purpose array type attribute for storing sampled real-time axis
data.
* 64-bit data container can be used to transfer any data type associated
with Attribute ID. Data Types less than 64-bits shall be least significant
Data Log 5
Usage Access Data Default Min Max Semantics of Values
Type
Optional - All Get LINT* Units of associated data
[N] source attribute.
General purpose array type attribute for storing sampled real-time axis
data.
* 64-bit data container can be used to transfer any data type associated
with Attribute ID. Data Types less than 64-bits shall be least significant
word aligned with no sign extension. Size of the array is left to vendors
discretion.
Data Log 6
Usage Access Data Default Min Max Semantics of Values
Type
Optional - All Get LINT* Units of associated data
[N] source attribute.
General purpose array type attribute for storing sampled real-time axis
data.
* 64-bit data container can be used to transfer any data type associated
with Attribute ID. Data Types less than 64-bits shall be least significant
word aligned with no sign extension. Size of the array is left to vendors
discretion.
Data Log 7
Usage Access Data Default Min Max Semantics of Values
Type
Optional - All Get LINT* Units of associated data
[N] source attribute.
General purpose array type attribute for storing sampled real-time axis
data.
* 64-bit data container can be used to transfer any data type associated
with Attribute ID. Data Types less than 64-bits shall be least significant
word aligned with no sign extension. Size of the array is left to vendors
discretion.
Data Log 8
Usage Access Data Default Min Max Semantics of Values
Type
Optional - All Get LINT* Units of associated data
[N] source attribute.
General purpose array type attribute for storing sampled real-time axis
data.
* 64-bit data container can be used to transfer any data type associated
with Attribute ID. Data Types less than 64-bits shall be least significant
word aligned with no sign extension. Size of the array is left to vendors
discretion.
Specifies the number of samples captured in each active Data Log. This
number can be no larger than the size of the Data Log arrays.
See also
Axis Info Attributes on page 330
Frequency Analysis Attributes on page 332
Axis Statistical Attributes These are the attributes that provide useful statistics on motion axis
operation.
Accumulated time that the axis has been powering the Running state.
See also
Interpret the Attribute Tables on page 89
CIP Axis Status Attributes These are the device status attributes associated with a Motion Control
Axis. Any status bits that are not applicable are set to 0.
Axis State
Usage Access T Data Default Min Max Semantics of Values
Type
Required - All Get T USINT - - - Enumeration:
0 = Initializing
1 = Pre-Charge
2 = Stopped
3 = Starting
4 = Running
5 = Testing
6 = Stopping
7 = Aborting
8 = Major Faulted
9 = Start Inhibited
10 = Shutdown
11-255: Reserved
Axis Status
Usage Access T Data Type Default Min Max Semantics of Values
Axis Status 2
Usage Access T Data Type Default Min Max Semantics of Values
0 Required Local Control This bit is set if axis is taking command reference
and services from local interface instead of the
remote (CIP Motion) interface. This bit is based on the
current state of the Remote Mode bit of the Node
Status attribute.
1 Required Alarm This bit is set if the axis has detected one or more
exception conditions configured to generate an
alarm. This bit is clear if there are no current axis
alarm conditions.
2 Required/ DC Bus Up For a drive axis, this bit is set if the DC Bus has
XBD charged up to an operational voltage level based on
direct measurement and, if applicable, the Converter
Bus Up Status bit associated with external CIP Motion
converter) supplying DC Bus power to this device is
also set. If the Bus Configuration attribute is set to
Shared DC - Non CIP Converter the drive might also
check the status of its associated external Non-CIP
Motion converter. When a drive axis is in the Pre-
Charge state, the transition of the DC Bus Up status
bit from 0 to 1 initiates a state transition to the
Stopped State. Once set, the DC Bus Up bit is cleared
when the DC Bus voltage has dropped below an
operational voltage level, or the Converter Bus Up
Status bit associated with external CIP Motion
converters supplying DC Bus power to this device is
cleared.
For an AC/DC converter axis, this bit is set if the DC
Bus has charged up to an operational voltage level
based on direct measurement alone. When a
converter axis is in the Pre-Charge state, the
transition of the DC Bus Up status bit from 0 to 1
initiates a state transition to the Running state for a
Passive converter, or to the Stopped state for an
Active converter. Once set, the DC Bus Up bit is
cleared when the DC Bus voltage has dropped below
an operational voltage level, independent of the state
of the Converter Bus Up Status bit.
For a DC/DC converter axis, this bit is set when the
primary DC Bus has charged up to an operational
voltage level based on direct measurement, the
Converter Bus Up Status bit associated with external
CIP Motion converters supplying DC Bus power to this
device has been set, and the DC/DC converter has
established all the secondary DC Bus voltage levels.
While the DC/DC converter axis is in the Pre-Charge
state, the transition of the DC Bus Up status bit from
0 to 1 initiates a state transition to the Running state.
3 Required/ Power Structure This bit is set if the axis power structure is energized
XGD Enabled and capable of generating motor flux and torque for
a drive axis, or regenerating power to the AC line for
a converter axis. The value of the Power Structure
Enabled bit is determined by the Axis State, and for
the drive axis, the configured Stopping Action
attribute value.
4 Required/ Motor Flux Up This bit is set if motor flux for an induction motor has
D reached an operational level. Transition of the Motor
Flux Up bit is initiated in the Starting State according
to the configured Flux Up Control attribute value. This
bit is only applicable to Induction Motor types.
5 Required/ Tracking This bit is set if the axis control structure is actively
XGD Command tracking the command reference from the motion
planner associated with a drive axis, or the bus
voltage setpoint of a converter axis, or the current
references of a track section axis applying force to
resident movers. The Tracking Command bit is
directly associated with the Running state of the Axis
State Model
6 Required/ Position Lock This bit is set if the actual position is within the
P Position Lock Tolerance of the command position.
7 Optional/ Velocity Lock This bit is set if the velocity feedback signal is within
PV the Velocity Lock Tolerance of the unlimited velocity
reference.
8 Required/ Velocity Standstill This bit is set if the velocity feedback signal is within
ED Velocity Standstill Window of 0. For a Frequency
Control drive this bit is set if the velocity reference
signal is within Velocity Standstill Window of 0.
9 Optional/ Velocity Threshold This bit is set if the absolute velocity feedback signal
ED is below Velocity Threshold. For a Frequency Control
drive this bit is set if the absolute velocity reference
signal is below the Velocity Threshold.
10 Optional/ Velocity Limit This bit is set if the velocity reference signal is
FPV currently being limited by the Velocity Limiter.
11 Optional/ Acceleration Limit This bit is set if the acceleration reference signal is
C currently being limited by the Acceleration Limiter.
12 Optional/ Deceleration Limit This bit is set if the acceleration reference signal is
C currently being limited by the Deceleration Limiter.
13 Optional/ Torque Threshold This bit is set if the absolute filtered torque
C reference is above the Torque Threshold.
14 Required/ Torque Limit This bit is set if the filtered torque reference is
C currently being limited by the Torque Limiter.
15 Optional/ Current Limit This bit is set if the command current, Iq, is currently
XD being limited by the Current Vector Limiter.
16 Optional/ Thermal Limit This bit is set if Current Vector Limit condition of the
XD axis is being limited by any of the axis's Thermal
Models or I2T Thermal Protection functions.
17 Required/ Feedback This bit, when set, indicates that the feedback device
RE Integrity is accurately reflecting changes to axis position, and
there have been no conditions detected that would
compromise the quality of the feedback position
value. The bit is set at power-up assuming that the
feedback device passes any power-up self-test
required. If during operation a feedback exception
occurs that could impact the fidelity of axis position,
the bit is immediately cleared. The bit remains clear
until either a fault reset is executed by the drive or
the drive is power cycled. Note that the Feedback
Integrity bit behavior applies to both absolute and
incremental feedback device operation..
18 Required/ Shutdown This bit is set when the axis is in the shutdown state
XBD or in the faulted state but would transition to the
shutdown state if the faults were cleared. Therefore,
the Shutdown bit is closely associated with the
Shutdown State of the Axis State Model.
19 Required In Process This bit is set for the duration of an active process.
An example of active process would be an operation
initiated by a Run Motor Test, Run Hookup Test, or
Run Inertia Test to request service. An active process
that requires the enabling of the axis power structure
results in a transition to the Testing State of the Axis
State Model.
21 Optional/ AC Power Loss This bit is set when a CIP Motion converter, or a CIP
XBD Motion drive containing an integral converter, or a
CIP Motion drive connected to an external non-CIP
converter, has detected a loss of AC input power. This
bit is cleared when AC input power is determined to
be sufficient for converter operation.
When an AC Power Loss condition is detected by a
converter supplying power to other devices over a
shared DC Bus, a method is needed to generate a
Converter AC Power Loss exception on any drive
whose power structure is enabled. To accomplish
this, the control system monitors the AC Power Loss
status bits of converters supplying DC Bus power and
propagates AC Power Loss status to all drives on the
shared DC Bus, such as drives that are configured for
Shared AC/DC or Shared DC operation. Upon
notification of AC Power Loss, drives that have
enabled power structures will assert a Converter AC
Power Loss exception and invoke the programmed
Axis Exception Action. Disabled drives will not
generate an exception action on AC Power Loss.
Thus, no drive faults will occur on removal of AC
Power from a converter.
Unlike other devices, DC/DC converters configured
for Shared DC/DC operation on the shared primary DC
bus do not assert an AC Power Loss exception when
receiving a Converter AC Power Loss. Instead, DC/DC
converters cascade the Converter AC Power Loss,
sent by the control system to devices on the primary
bus, to devices on the secondary DC Bus by setting
its AC Power Loss status bit and, thereby, initiating
AC Power Loss exceptions on all enabled Shared DC
devices assigned to the secondary Shared DC Bus.
The DC/DC converter remains operational in the
Running state to allow Shared DC devices on the
secondary DC bus to execute the configured AC
Power Loss exception action.
Note that only the originating drive or converter with
the AC Power Loss condition can cause AC Power
Loss Faults on other drives on the associated shared
bus. In other words, no device with an AC Power Loss
Fault can cause an AC Power Loss exception on other
drives on the shared bus by setting its AC Power Loss
bit. This qualification prevents DC Bus recovery
deadlock. To recover full DC Bus operation, the
originating drive or converter with the AC Power Loss
condition must first be reset, typically via a Shutdown
Reset Request. Once clear, the controller then clears
the Converter AC Power Loss bit to all the shared
drives. The AC Power Loss Faults on the shared
drives can then be successfully cleared by either a
Fault Reset Request, or a Shutdown Reset Request,
allowing these drives to become operational.
22 Optional/ Position Control When set, this bit indicates that axis position is being
C Mode actively controlled by the Position Loop. Position
Control Mode is only applicable when the axis is
enabled and using the PI Vector Control Method. The
"Position Control Mode" status bit is cleared whenever
the active Control Mode is changed from Position
Control to Velocity Control or Torque Control. This
status bit is clear if the drive axis is disabled.
23 Optional/ Velocity Control When set, this bit indicates that axis velocity is being
C Mode actively controlled by the Velocity Loop. Velocity
Control Mode is only applicable when the drive axis is
enabled and using the PI Vector Control Method. The
"Velocity Control Mode" status bit is cleared whenever
the active Control Mode is changed from Velocity
Control to Position Control or Torque Control. This
status bit is clear if the drive axis is disabled.
24 Optional/ Torque Control When set, this bit indicates that axis velocity is being
C Mode actively controlled by the Torque (Current) Loop.
Torque Control Mode is only applicable when the
drive axis is enabled and using the PI Vector Control
Method. The "Torque Control Mode" status bit is
cleared whenever the active Control Mode is changed
from Torque Control to Position Control or Velocity
Control. This status bit is clear if the drive axis is
disabled.
25-31 - Reserved -
The naming convention for individual bits within the CIP Axis Status
attributes is to append a 'Status' suffix to the CIP Axis Status condition.
This table lists the resulting CIP Axis Status tags associated with the
above status conditions.
Bit Tag
0 LocalControlStatus
1 AlarmStatus
2 DCBusUpStatus
3 PowerStructureEnabledStatus
4 MotorFluxUpStatus
5 TrackingCommandStatus
6 PositionLockStatus
7 VelocityLockStatus
8 VelocityStandstillStatus
9 VelocityThresholdStatus
10 VelocityLimitStatus
11 AccelerationLimitStatus
12 DecelerationLimitStatus
13 TorqueThresholdStatus
14 TorqueLimitStatus
15 CurrentLimitStatus
16 ThermalLimitStatus
13 Optional/ Bus Voltage Limit This bit is set if the bus voltage reference signal into
G the bus voltage control loop is currently being limited
by the Bus Voltage Limiter block.
14 Optional/ Bus Voltage Rate This bit is set if the bus voltage Rate Limiter block is
G Limit currently limiting the rate of change of the bus
voltage set point signal into the bus voltage control
loop.
15 Optional/ Active Current This bit is set if the Rate Limiter block is currently
G Rate Limit limiting the rate of change of the Active Current
Command signal.
16 O/G Reactive Current This bit is set if the Rate Limiter block is currently
Rate Limit limiting the rate of change of the Reactive Current
Command signal.
17 Optional/ Reactive Power This bit is set if the Power Limiter block is currently
G Limit limiting the Reactive Power Set Point signal.
18 Optional/ Reactive Power This bit is set if the Rate Limiter block is currently
G Rate Limit limiting the rate of change of the Reactive Power Set
Point signal.
19 Optional/ Active Current This bit is set if the active current reference signal is
G Limit currently being limited by the Current Limiter block.
20 Optional/ Reactive Current This bit is set if the reactive current reference signal
G Limit is currently being limited by the Current Limiter
block.
21 Optional/ Motoring Power This bit is set if the current reference signals are
G Limit currently being limited by the Current Limiter block
due to the Motoring Power Limit.
22 Optional/ Regenerative This bit is set if the current reference signals are
G Power Limit currently being limited by the Current Limiter block
due to the Converter Regenerative Power Limit.
23 Optional/ Converter Thermal This bit is set if the current reference signals are
G Limit currently being limited by the Current Limiter block
due to the Converter Thermal Current Limit.
24-31 - Reserved -
The naming convention for individual bits within the CIP Axis Status 2
attributes is to append a 'Status' suffix to the CIP Axis Status 2
condition. This table lists the resulting CIP Axis Status 2 tags associated
with the above status conditions.
Bit Tag
0 MotoringStatus
1 RegeneratingStatus
2 RideThruStatus
3 ACLineSyncStatus
4 BusVoltageLockStatus
5 ReactivePowerOnlyModeStatus
6 VoltageControlModeStatus
7 PowerLossStatus
8 ACLineVoltageSagStatus
9 ACLinePhaseLossStatus
10 ACLineFrequencyChangeStatus
11 ACLineSyncLossStatus
0 Optional/C Torque Notch Filter This bit is set when the Adaptive Tuning function has detected a
Frequency Detected resonance frequency between the Torque Notch Filter Low
Frequency Limit and the Torque Notch Filter High Frequency
Limit with magnitude above the Toque Notch Filter Tuning
Threshold. Otherwise, the bit is clear.
This bit is cleared by the Adaptive Tuning function when the Axis
state transitions to the Running state.
1 Optional/C Torque Notch Filter Tuning • When the Adaptive Tuning Configuration is set to Tracking
Unsuccessful Notch or Tracking Notch and Gain Stabilization, this bit is set
when n+1 successive updates of the tunable Torque Notch
Filters have failed to eliminate all resonances between the
Torque Notch Filter Low Frequency Limit and the Torque Notch
Filter High Frequency Limit with magnitude above the Toque
Notch Filter Tuning Threshold. Here “n” is defined as the
configured Track Notch Filters attribute value. This condition
can occur when there are more resonances in the system than
there are tunable Torque Notch Filters. Otherwise, the bit is
clear.
• When this bit is set, and the Adaptive Tuning Configuration is
set to Tracking Notch and Gain Stabilization, the Adaptive
Tuning function decreases the Torque Low Pass Filter
Bandwidth to attenuate the remaining resonances.
• This bit is cleared by the Adaptive Tuning function when the
Axis state transitions to the Running state or, when in the
Running state, the Adaptive Tuning Configuration transitions
from Disabled to one of the Torque Notch Filter Tuning
enumerations.
2 Optional/C Torque Notch Filter This bit is set when, the Adaptive Tuning function, identifies
Multiple Frequencies multiple resonant frequencies that are between the Torque Notch
Filter Low Frequency Limit and the Torque Notch Filter High
Frequency Limit whose magnitudes are above the Toque Notch
Filter Tuning Threshold. Otherwise, the bit is clear.
This bit is cleared by the Adaptive Tuning function when the Axis
state transitions to the Running state.
3 Optional/C Torque Notch Filter This bit is set when the Adaptive Tuning function identifies a
Frequency Below Limit frequency that is below the Torque Notch Filter Low Frequency
Limit but whose magnitude is higher than the configured Toque
Notch Filter Tuning Threshold. Otherwise, the bit is clear.
This bit is cleared by the Adaptive Tuning function when the Axis
state transitions to the Running state.
4 Optional/C Torque Notch Filter This bit is set when the Adaptive Tuning function identifies a
Frequency Above Limit frequency that is above the Torque Notch Filter High Frequency
Limit but whose magnitude is higher than the configured Toque
Notch Filter Tuning Threshold. Otherwise, the bit is clear.
This bit is cleared by the Adaptive Tuning function when the Axis
state transitions from disabled to enabled operation.
5 Optional/C Adaptive Tune Gain This bit is set when the Adaptive Tuning Gain Scaling Factor is not
Stabilization Active equal to one. This indicates that the Adaptive Tuning function is
actively adjusting servo loop gain values and the Torque Low
Pass Filter Bandwidth value to improve system stability.
This bit is cleared by the Adaptive Tuning function when the Axis
state transitions to the Running state.
6-31 - Reserved -
The naming convention for individual bits within the CIP Axis Status RA
attributes is to append a 'Status' suffix to the CIP Axis Status RA
condition. This table lists the resulting CIP Axis Status RA tags
associated with the above status conditions.
Bit Tag
0 TorqueNotchFilterFreqDetectedStatus
1 TorqueNotchFilterTuneUnsuccessfulStatus
2 TorqueNotchFilterMultipleFreqStatus
3 TorqueNotchFilterFreqBelowLimitStatus
4 TorqueNotchFilterFreqAboveLimitStatus
5 AdaptiveTuneGainStabilizationStatus
0-31 Reserved -
The naming convention for individual bits within the CIP Axis Status 2
RA attributes is to append a 'Status' suffix to the CIP Axis Status 2 RA
condition. This table lists the resulting CIP Axis Status 2 RA tags
associated with the above status conditions.
Bit Tag
0 -
The Axis I/O Status - Mfg attribute is a collection of bits indicating the
state of vendor specific digital inputs associated with the operation of
this axis. A value of zero for a given input bit indicates a logical 0 value,
while a value of 1 indicates a logical 1 value.
0 Optional/ Enable Input This bit represents the logical state of the Enable
XBD Input.
1 Optional/ Home Input This bit represents the logical state of the Home
ED Input.
2 Optional/ Registration 1 Input This bit represents the logical state of the
ED Registration 1 Input.
3 Optional/ Registration 2 Input This bit represents the logical state of the
ED Registration 2 Input.
4 Optional/ Positive Overtravel This bit represents the logical state of the Positive
P OK Input Overtravel OK Input.
5 Optional/ Negative Overtravel This bit represents the logical state of the Negative
P OK Input Overtravel OK Input.
6 Optional/ Feedback 1 This bit represents the logical state of the
ED Thermostat OK Input Thermostat OK input associated with the motor
mounted Feedback 1device.
7 Optional/ Resistive Brake This bit represents the logical state of the Resistive
D Release Output Brake Release Output.
8 Optional/ Mechanical Brake This bit represents the logical state of the
XD Release Output Mechanical Brake Release Output.
9 Optional/ Motor Thermostat OK This bit represents the logical state of the Motor
D Input Thermostat OK Input.
10-31 - Reserved -
The naming convention for individual bits within the CIP Axis I/O Status
attributes is to append a 'Status' suffix to the CIP Axis Status condition.
This table lists the resulting CIP Axis I/O Status tags associated with the
above status conditions.
Bit Tag
0 EnableInputStatus
0 Optional/ Regenerative Power This bit represents the logical state of the
D OK Input Regenerative Power Input. This input status bit
indicates the associated external regenerative
converter is in the Running state and capable of
transferring regenerative power.
1 Optional/ Bus Capacitor Module This bit represents the logical state of the Bus
BD OK Input Capacitor Module Input.
2 Optional/ Shunt Thermal This bit represents the logical state of the Shunt
BD Switch OK Input Thermal Switch Input.
3 Optional/ Contactor Enable This bit represents the logical state of the Contactor
BD Output Enable Output.
4 Optional/ Pre-Charge OK Input This bit represents the logical state of the Pre-
BD Charge Input.
5 Optional/ AC Line Contactor OK This bit represents the logical state of the AC Line
BD Input Contactor OK Input
6 Optional/ Regenerative Power This bit represents the logical state of the
G OK Output Regenerative Power Output. This output status bit
indicates this regenerative converter is in the
Running state and capable of transferring
regenerative power.
7 Optional/ Bus Conditioner This bit represents the logical state of the Bus
BD Module OK Input Conditioner Module Input.
8 Optional/ Converter OK Input This bit represents the logical state of the Converter
D OK Input. This input status bit indicates the
associated external converter has determined that
the DC bus has reached operational voltage level
and that the converter is not faulted.
9 Optional/ Converter OK Output This bit represents the logical state of the Converter
B OK Output. This output bit indicates that this
converter has determined that the DC bus has
reached operational voltage level and is not
currently faulted.
10-31 - Reserved -
The naming convention for individual bits within the CIP Axis I/O Status
- RA attributes is to append a 'Status' suffix to the CIP Axis Status - RA
condition. This table lists the resulting CIP Axis I/O Status -RA tags
associated with the above status conditions.
Bit Tag
0 RegenerativePowerInputStatus
1 BusCapacitorModuleInputStatus
2 ShuntThermalSwitchInputStatus
3 ContactorEnableOutputStatus
4 PreChargeInputStatus
5 ACLineContactorInputStatus
6 RegenerativePowerOutputStatus
7 BusConditioneerModuleInputStatus
8 ConverterInputStatus
9 ConverterOutputStatus
See also
CIP Axis Attributes on page 243
Motion Control Axis Behavior Model on page 54
Event Capture Attributes These are the event related attributes associated with a Motion Control
Axis. These include registration, marker, and homing events. The Event
Capture attributes are designed to support the possibility of up to 7
*These attributes are generally updated via the cyclic Command Data
Set of the CIP Motion C-to-D Connection. When included as cyclic
command data, these attributes cannot not be updated via a Set
service.
The Event Checking Control attribute is passed to the device by the
controller as part of the Drive to Controller connection for the purpose of
arming various device inputs, e.g. marker, home switch, and registration
inputs, to generate events to the controller. When these enabled events
occur, the device captures both the time and exact axis position when
the event occurred. This attribute also manages the format and content
of the C2D Event Data Block.
Registration Inputs
Usage Access T Data Default Min Max Semantics of Values
Type
Required - E Set/GSV USINT 0 0 10
The Home Event Time attribute is the system time stamp latched on the
specified home event.
The Watch 1 Event Time attribute is the system time stamp latched on
the specified watch event.
The Watch 2 Event Time attribute is the system time stamp latched on
the specified watch event.
The Home Torque Threshold attribute sets the minimum torque level
needed to detect the hard stop during a Home to Torque sequence. The
drive’s output torque must exceed the specified Home Torque
Threshold for the specified Home Torque Time. The units for Home
Torque Threshold are expressed as a percentage of the operative
Torque Limit, which during the homing sequence is set to the Home
Torque Limit by the controller.
Valid for non-“immediate” cases of “active” Home Mode.
Valid for “home to torque” homing sequences.
The Home Torque Time attribute sets the minimum amount of time
needed for the drive’s output torque to exceed the specified Home
Torque Threshold to detect the hard stop during a Home to Torque
sequence.
Valid for “home to torque” homing sequences.
See also
Motion Control Signal Attributes on page 487
Motion Control Status Attributes on page 498
Drive Attributes These attribute tables contain attributes associated with the drive. Drive
attributes reside both on the controller and on the drive.
Drive General Purpose I/O These are the attributes that provide to general purpose analog and
digital I/O associated with the Motion Control Axis.
Attributes
Digital Inputs
Usage Access T Data Type Default Min Max Semantics of Values
The Digital Inputs attribute is a 32-bit word with whose bits can be
assigned by the vendor to general purpose digital inputs.
Digital Outputs
Usage Access T Data Type Default Min Max Semantics of Values
The Digital Outputs attribute is a 32-bit word with whose bits can be
assigned by the vendor to general purpose digital outputs.
Analog Input 1
Usage Access T Data Type Default Min Max Semantics of Values
Analog Input 2
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - XBD Get T REAL - - - % Full Scale
Analog Output 1
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - XBD Set T REAL 0 -100 +100 % Full Scale
Analog Output 2
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - XBD Set T REAL 0 -100 +100 % Full Scale
A floating point value that specifies the width of the pulse reject filter for
a digital input configured as an Enable function.
A floating point value that specifies the width of the pulse reject filter for
a digital input configured as a Registration 1 function.
A floating point value that specifies the width of the pulse reject filter for
a digital input configured as a Registration 2 function.
A floating point value that specifies the width of the pulse reject filter for
a digital input configured as a Positive Overtravel function.
A floating point value that specifies the width of the pulse reject filter for
a digital input configured as an Negative Overtravel function.
A floating point value that specifies the width of the pulse reject filter for
a digital input configured as an Regeneration OK
function.
A floating point value that specifies the width of the pulse reject filter for
a digital input configured as a Bus Capacitor OK function.
A floating point value that specifies the width of the pulse reject filter for
a digital input configured as an Shunt Thermal Switch OK function.
A float that specifies the width of the pulse reject filter for a digital input
configured as a Home & Registration 1 function.
The AC Line Contactor is a float value that specifies the width of the
pulse reject filter for a digital input configured as a AC Line Contactor
OK function.
See also
CIP Axis Status Attributes on page 339
Drive Output Attributes These are the inverter output related attributes associated with a
Motion Control Axis.
Output Frequency
Usage Access T Data Default Min Max Semantics of Values
Type
Required - F Get T REAL - - - Hertz
Optional - C
Output Current
Usage Access T Data Default Min Max Semantics of Values
Type
Required - D Get T REAL - - - Amps (RMS)
!LTM
Output Voltage
Usage Access T Data Default Min Max Semantics of Values
Type
Required - D Get T REAL - - - Volts (RMS)
!LTM
Output Power
Usage Access T Data Default Min Max Semantics of Values
Type
Required - D Get T REAL - - - Kilowatts
PWM Frequency
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - D Set T UINT - - - Hertz
The PWM Frequency attribute sets the carrier frequency for the Pulse
Width Modulation output to the motor. Drive derating is required at
higher PWM frequencies due to switching losses. Current loop update
time is tied directly to the PWM frequency so loop performance
generally increases with increasing PWM rate.
See also
Drive General Purpose I/O Attributes on page 361
Power and Thermal Management Configuration Attributes on
page 370
Power and Thermal These are the power and thermal configuration related attributes
associated with a Motion Control Axis.
Management Configuration
Attributes Motor Overload Action
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - XD Set USINT 0 - - Enumeration
0 = None (R)
1 = Current Foldback (O)
2...127 = Reserved
128...255 = Vendor specific
See also
Power and Thermal Management Status Attributes on page 371
Power and Thermal These are the power and thermal status related attributes associated
with a Motion Control Axis.
Management Status
Attributes Motor Overload Protection Method
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - XBD Get T USINT - - - Enumeration:
0 = Thermal Model
1 = I2T Overload
Motor Capacity
Usage Access T Data Default Min Max Semantics of Values
Type
Required - XD Get T REAL - - - % Motor Rated
!LTM
Inverter Capacity
Usage Access T Data Default Min Max Semantics of Values
Type
Required – XD Get T REAL - - - % Inverter Rated
!LTM
Converter Capacity
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - BD Get T REAL - - - % Converter Rated
Ambient Temperature
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - XBD Get T REAL - - - Degrees C
Inverter Temperature
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - XD Get T REAL - - - Degrees C
Motor Temperature
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - XD Get T REAL - - - Degrees C
Feedback 1 Temperature
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - XE Get T REAL - - - Degrees C
Feedback 2 Temperature
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - E Get T REAL - - - Degrees C
The Inverter Overload Limit is the factory-set limit for Inverter capacity.
Exceeding the Inverter Overload Limit for drives applying to an I2T
inverter overload protection method causes:
• An overload condition
• Activates I2T overload protection.
If the inverter overloads, the Inverter Capacity attribute value increases
to show the level of utilization of the inverters available I2T overload
capacity. The drive optionally triggers as an Inverter Overload Action
when the Inverter Capacity reaches 100% of its rated capacity.
When employing an overload protection method based on an inverter
thermal model:
• The Inverter Capacity attribute value represents how much the
rated thermal capacity of the inverter associated with the the
inverter thermal model is utilized.
The drive optionally triggers a predetermined Inverter Overload Action
when the Inverter Capacity value exceeded the Inverter Overload Limit.
A drive also uses the Inverter Overload Limit to determine the absolute
thermal capacity limit of the inverter. If exceeding the capacity, the
absolute thermal capacity generates an Inverter Thermal Overload FL
exception.
Converter Temperature
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - B Get T REAL - - - Degrees C
AC Line 1 Capacity
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - G Get T REAL - - - % Converter Rated
AC Line 2 Capacity
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - G Get T REAL - - - % Converter Rated
AC Line 3 Capacity
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - G Get T REAL - - - % Converter Rated
The Converter Overload Limit attribute is a factory set maximum limit for
Converter Capacity that when exceeded triggers the selected Converter
Overload action.
If the drive applies an I2T converter overload protection method, then
exceeding the specified Converter Overload Limit results in an overload
condition and activates I2T overload protection. While the converter is
overloaded, the Converter Capacity attribute value increases to indicate
how much of the converters available I2T overload capacity has been
utilized. When Converter Capacity reaches 100% of its rated capacity,
the drive can optionally trigger a Converter Overload Action.
When employing an overload protection method based on a converter
thermal model, the Converter Capacity attribute value represents how
much of the converter’s rated thermal capacity, associated with the
converter thermal model, has been utilized. Once the Converter
Capacity value exceeds the Converter Overload Limit, the drive can
optionally trigger a predetermined Converter Overload Action.
The Converter Overload Limit can also be used by the drive to
determine the absolute thermal capacity limit of the converter, i.e. the
Converter Thermal Overload Factory Limit, which if exceeded,
generates an Converter Thermal Overload FL exception.
The configured Converter Overload Limit also applies to Converter L1,
L2, and L3 Capacity, any of which are exceeded also results in a
Converter Thermal Overload FL exception.
Duty Select
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - XBD Set T USINT - - - Enumeration:
0 = Normal (R)
1 = Heavy (O)
2 = Light (O)
3-255 = (reserved)
The Duty Select attribute indicates the duty level of the drive application
and balances the continuous and intermittent overload capacity of the
drive and motor.
• Use Normal Duty for nominal continuous rating and nominal
overload capacity
• Use Heavy Duty for the highest overload capacity with a lower
continuous rating
• Use Light Duty for the highest continuous rating with a lower
overload capacity
Use Duty Select to determine the level of thermal protection for the
motor and the inverter during drive operation.
See also
Power and Thermal Management Configuration Attributes on
page 370
Drive Commissioning and The attribute tables contain attributes associated with auto-tuning and
test services applied to a Motion Control Axis Object instance. These
Tuning Attributes attributes are unique to the controller and do not require replication in
the Motion Control Device Axis Object.
Auto-Tune Configuration These are the attributes that are associated with auto-tune
configuration of a Motion Control Axis.
Attributes
System Damping
Usage Access T Data Default Min Max Semantics of Values
Type
Required - C Set/SSV REAL 1 0.5 2.0
(Derived from
Damping Factor)
System Bandwidth
Usage Access T Data Default Min Max Semantics of Values
Type
Required - C Set/SSV REAL 0 0 Loop Bandwidth Units
(Derived from
Servo
Bandwidth)
Damping Factor
Usage Access T Data Default Min Max Semantics of Values
Type
Required - Set/SSV REAL FD 0.5 2.0 -
GPV
The value for the Position Servo Bandwidth represents the unity gain
bandwidth of the position loop that is to be used by software Autotune
function to calculate the position loop gains. The unity gain bandwidth is
the frequency beyond which the position servo is unable to provide any
significant position disturbance correction. In general, within the
constraints of a stable servo system, the higher the Position Servo
Bandwidth the better the dynamic performance of the system. A
maximum value for the Position Servo Bandwidth is generated by the
MRAT instruction. Computing gains based on this maximum value
software Autotune procedure results in a dynamic response in keeping
with the current value of the Damping Factor.
A set to the Position Servo Bandwidth attribute while configured for
Position Loop operation also updates the System Bandwidth attribute
value to support Manual Tuning.
The value for the Velocity Servo Bandwidth represents the unity gain
bandwidth of the velocity loop that is to be used by the software
Autotune function to calculate the velocity loop gains. The unity gain
bandwidth is the frequency beyond which the velocity servo is unable to
provide any significant position disturbance correction. In general, within
the constraints of a stable servo system, the higher the Velocity Servo
Bandwidth is the better the dynamic performance of the system. A
maximum value for the Velocity Servo Bandwidth is generated by the
MRAT instruction. Computing gains based on this maximum value using
the software's Autotune procedure results in a dynamic response in
keeping with the current value of the Damping Factor.
A set to the Velocity Servo Bandwidth attribute while configured for
Velocity Loop operation also updates the System Bandwidth attribute
value to support Manual Tuning.
The value for the Drive Model Time Constant represents a lumped
model time constant for the drive's current loop and is used to calculate
the Velocity and Position Servo Bandwidth values. The Drive Model
Time Constant is the sum of the drive's current loop time constant, the
feedback sample period, calculation delay, and the time constant
associated with the velocity feedback filter. This value is set by software
based on the specific drive amplifier and motor feedback selection.
Since the bandwidth of the velocity feedback filter is determined by the
resolution of the feedback device, the value for the Drive Model Time
Constant is smaller when high resolution feedback devices are
selected.
The value for the Converter Model Time Constant represents lumped
model time constant for the converter’s current loop and used to
calculate Bus Voltage loop bandwidth values. The Converter Model
Time Constant is the sum of the converter’s current loop time constant,
and the calculation delay. This value is set by software based on the
specific converter selection.
(A set to the Converter Model Time Constant attribute while configured
for Active Current Control operation also updates the System Bandwidth
attribute value to support Manual Tuning.)
Application Type
Usage Access T Data Default Min Max Semantics of Values
Type
Required - PV Set/GSV USINT 1 - - Enumeration:
0 = Custom
1 = Basic
2 = Tracking
3 = Point-to-Point
4 = Constant Speed
5-255 = Reserved
This attribute specifies the type of motion control application and is used
by configuration and auto-tune software to set the Gain Tuning
Configuration Bits attribute that establishes the appropriate gain set the
application.
The next table shows which Feedforward values are applicable based
on the Application Type. Separate bits are defined in the Gain Tuning
Configuration Bits attribute to enable tuning of Velocity Feedforward,
Kvff, and Acceleration Feedforward, Kaff.
Application Type Kvff Kaff
Custom - -
Basic yes no
Tracking yes yes
Point-Point no no
Const. Spd. yes no
Finally, the Torque Low Pass Filter bit enables tuning of the Torque Low
Pass Filter Bandwidth. This bit is set for all Application Types except
Custom,
Application Type Torque LP Filter
Custom -
Basic yes
Tracking yes
Point-Point yes
Const. Spd. yes
Loop Response
Usage Access T Data Default Min Max Semantics of Values
Type
Required - GPV Set/GSV USINT 1 - - Enumeration:
0 = Low
1 = Medium
2 = High
3-255 = Reserved
A High setting for Loop Response is best suited for systems that
demand the highest level of control performance. Generally these are
rigid mechanical systems with relatively light load inertia/mass, for
example, Load Ratio < 3.
A Medium Loop Response setting is best suited for general purpose
control applications with modest loading, for example Load Ratio < 10.
This setting can accommodate both rigid and compliant mechanical
systems.
A Low setting for Loop Response is best suited for systems that control
heavy load inertia/mass, for example, Load Ratio > 10. The heavy load
inertia/mass of these systems generally required lower position and
velocity loop bandwidths to maintain stability and minimize motor
heating.
Overall system performance can be improved for a given Loop
Response setting by compensating for the load inertia/mass by setting
the System Inertia value to the Total Inertia of the mechanical system.
Load Coupling
Usage Access T Data Default Min Max Semantics of Values
Type
Required - C Set/GSV USINT 0 - - Enumeration:
0 = Rigid
1 = Compliant
2-255 = Reserved
This Gain Tuning Configuration Bits attribute value is a bit field attribute
that controls the loop gain-tuning calculations.
Bits 4-7 may not be updated programmatically by SSV instruction
unless the Application Type is set to Custom.
The following table provides detailed descriptions for the bits of this
attribute:
Bit Name Description
Run Inertia Test This bit determines whether or not the MRAT tuning instruction will send
a Test Inertia service to the drive to perform an inertia measurement. If
this bit is set the Inertia Test will be performed. If the bit is clear, the
MRAT will immediately complete without an inertia measurement.
Use Load Ratio This bit determines if Load Ratio is used in calculating Total Inertia and
System Bandwidth calculations. If this bit is set, Load Ratio will be used
in these calculations. If this bit is clear, Load Ratio will not have any
impact on Total Inertia or System Bandwidth.
Tune Position Integrator The Tune Position Integrator bit attribute determines whether or not the
auto-tuning algorithm calculates a value for the Position Integrator
Bandwidth. If this bit is clear (false) the value for the Position Integrator
Bandwidth is set to zero, disabling the integrator.
Tune Velocity Integrator The Tune Velocity Integrator bit attribute determines whether or not
tuning algorithms calculate a value for the Velocity Integrator
Bandwidth. If this bit is clear (false) the value for the Velocity Integrator
Bandwidth is set to zero, disabling the integrator.
Tune Velocity Feedforward The Tune Velocity Feedforward bit attribute determines whether or not
tuning algorithms calculate a value for the Velocity Feedforward Gain. If
this bit is clear (false) the value for the Velocity Feedforward Gain is set
to zero.
See also
Motor Test Status Attributes on page 401
Hookup Test Configuration Attributes on page 391
Inertia Test Configuration Attributes on page 395
Hookup Test Configuration These are the attributes that are associated with hookup test
configuration applied to a Motion Control Axis.
Attributes
Hookup Test Distance
Usage Access T Data Default Min Max Semantics of Values
Type
Required - E Set/ REAL 1 0 maxpos Position Units
SSV*
* Indicates the attribute cannot be set while the drive power structure is enabled (Power Structure Enable bit
in CIP Axis Status is true).
The Hookup Test Distance attribute is used by the Hookup Test service
to determine the amount of motion that is necessary to satisfy selected
hookup test process.
The Hookup Test Speed attribute is used by the Run Hookup Test
service to control the velocity of motion during the hookup test.
See also
Motor Test Result Attributes on page 401
Inertia Test Result Attributes on page 398
Hookup Test Result Attributes on page 392
Inertia Test Configuration Attributes on page 395
Auto-Tune Configuration Attributes on page 383
Hookup Test Result These are the attributes that are associated with hookup result status
applied to a Motion Control Axis
Attributes
The Hookup Test Status attribute returns status of the last Run Hookup
Test service on the targeted drive axis. The Hookup Test Status
attribute can be used to determine when the hookup test service has
successfully completed. Conditions may occur, however, that make it
impossible for the drive to properly perform the operation. When this is
the case, the test process is automatically terminated and a test error is
reported that is stored in the Hookup Test Status output parameter.
See also
Motor Test Result Attributes on page 401
Inertia Test Result Attributes on page 398
Hookup Test Configuration Attributes on page 391
Inertia Test Configuration Attributes on page 395
Auto-Tune Configuration Attributes on page 383
Inertia Test Configuration These are the attributes that are associated with inertia test
configuration applied to a Motion Control Axis.
Attributes
Tuning Select
Usage Access T Data Default Min Max Semantics of Values
Type
Required - C Set/SSV# USINT 0 - - Enumeration
0 = Total Inertia
1 = Motor Inertia
2...255 = Reserved
# Indicates the attribute cannot be set while the tracking command (Tracking Command bit in CIP Axis Status
is true).
Tuning Direction
Usage Access T Data Default Min Max Semantics of Values
Type
Required - C Set/SSV# USINT 0 - - Enumeration
0 = Unidirectional Forward
1 = Unidirectional Reverse
2 = Bidirectional Forward
3 = Bidirectional Reverse
4...255 = Reserved
# Indicates the attribute cannot be set while the tracking command (Tracking Command bit in CIP Axis Status
is true).
# Indicates the attribute cannot be set while the tracking command (Tracking Command bit in CIP Axis Status
is true).
The Tuning Travel Limit attribute is used by the Inertia Test service,
associated with the MRAT instruction, to limit the excursion of the axis
during the test. If, while performing the Inertia Test motion profile, the
drive determines that the axis will not be able to complete the profile
before exceeding the Tuning Travel Limit, the drive will terminate the
profile and report that the Tuning Travel Limit was exceeded through
Tuning Speed
Usage Access T Data Default Min Max Semantics of Values
Type
Required - C Set/SSV# REAL 0 0 Position Units / Sec
# Indicates the attribute cannot be set while the tracking command (Tracking Command bit in CIP Axis Status
is true).
The Tuning Speed attribute value determines the maximum speed used
by the Inertia Test service initiated motion profile. This attribute should
be set to the desired maximum operating speed of the motor prior to
running the test. The tuning procedure will measure maximum
acceleration and deceleration rates based on ramps to and from the
Tuning Speed. Thus, the accuracy of the measured acceleration and
deceleration capability is reduced by tuning at a speed other than the
desired operating speed of the system.
Tuning Torque
Usage Access T Data Default Min Max Semantics of Values
Type
Required - C Set/SSV# REAL 100 0 % Rated
# Indicates the attribute cannot be set while the tracking command (Tracking Command bit in CIP Axis Status
is true).
Load Ratio
Usage Access T Data Default Min Max Semantics of Values
Type
Required - C Set/SSV# REAL 0 0 Rotary Motor:
DB Load Ratio = (total inertia /
motor inertia) - 1.
Linear Motor:
Load Ratio = (total mass /
motor mass) - 1.
The Load Ratio attribute's value represents the ratio of the load inertia
or mass to the motor inertia or mass.
The value for Load Ratio may be known by the user or may be
measured as part of a software initiated Autotune process.
When Use Load Ratio bit is set in the Gain Tuning Configuration Bits
attribute, configuration software uses the value of Load Ratio to
compute Total Inertia/Mass and System Inertia attributes.
The Load Ratio value may also be used in calculations associated with
System Damping attribute.
Total Inertia
Usage Access T Data Default Min Max Semantics of Values
Type
Required - C Set/SSV# REAL FD 0 Inertia Units
(Rotary Motor)
# Indicates the attribute cannot be set while the tracking command (Tracking Command bit in CIP Axis Status
is true).
Total Inertia represents the combined inertia of the rotary motor and
load in engineering units.
Total Mass
Usage Access T Data Default Min Max Semantics of Values
Type
Required - C Set/SSV# REAL FD 0 Mass Units
(Linear Motor)
# Indicates the attribute cannot be set while the tracking command (Tracking Command bit in CIP Axis Status
is true).
Total Mass represents the combined mass of the linear motor and load
in engineering units.
# Indicates the attribute cannot be set while the tracking command (Tracking Command bit in CIP Axis Status
is true).
# Indicates the attribute cannot be set while the tracking command (Tracking Command bit in CIP Axis Status
is true).
See also
Motor Test Result Attributes on page 401
Hookup Test Result Attributes on page 392
Hookup Test Configuration Attributes on page 391
Inertia Test Result Attributes on page 398
Auto-Tune Configuration Attributes on page 383
Inertia Test Result These are the attributes that are associated with inertia result status
applied to a Motion Control Axis.
Attributes
Tune Status
Usage Access T Data Default Min Max Semantics of Values
Type
Required - C Get/GSV INT - - - Enumeration
0 = Tune Successful
1 = Tune in Progress
2 = Tune Aborted
3 = Tune Time-out Fault
4 = Tune Failed - Servo Fault
5 = Axis Reached Tuning
Travel Limit
6 = Axis Polarity Set
Incorrectly
7 = Tune Measurement Error
8 = Tune Configuration Error
The Tune Status attribute returns status of the last run Inertia Test
service that initiates a process on the targeted drive axis. The Tune
Status attribute can, thus, be used to determine when the Inertia Test
initiated operation has successfully completed. Conditions may occur,
however, that make it impossible for the drive to properly perform the
operation. When this is the case, the Inertia Test process is
automatically aborted and a failure reported that is stored in the Tune
Status output parameter.
Tune Acceleration
Usage Access T Data Default Min Max Semantics of Values
Type
Required - C Get/GSV REAL - - - Position Units / Sec2
Tune Deceleration
Usage Access T Data Default Min Max Semantics of Values
Type
Required - C Get/GSV REAL - - - Position Units / Sec2
The Tune Inertia Mass value represents the estimated inertia or mass
for the axis as calculated from the measurements made during the last
Motion Run Axis Tune (MRAT) initiated tuning process. This value may
also be set directly by software tuning tools or programmatically.
Tune Friction
Usage Access T Data Default Min Max Semantics of Values
Type
Required - C Set/SSV REAL 0 0 % Rated
This floating point value represents the active load offset measured
during the last successful Inertia Test profile. This value can be used to
set the Torque Offset of the drive to cancel out the active load
torque/force. This value may also be set directly by software tuning
tools or programmatically.
This floating point value represents the load ratio calculated by MRAT
based on the measurements made during the last successful Inertia
Test profile. The Load Inertia Ratio attribute's value represents the ratio
of the load inertia to the motor inertia. Or in the case of a linear motor,
the load mass over the motor mass. This value can be used to set the
Load Ratio attribute value as part of an Autotune process. This value
may also be set directly by software tuning tools or programmatically.
See also
Motor Test Status Attributes on page 401
Hookup Test Status Attributes on page 392
Hookup Test Configuration Attributes on page 391
Inertia Test Configuration Attributes on page 395
Auto-Tune Configuration Attributes on page 383
Motor Test Result Attributes These are the attributes that are associated with result status applied to
a Motion Control Axis.
The Motor Test Status attribute returns status of the last Run Motor Test
service on the targeted drive axis. The Motor Test Status attribute can
be used to determine when the motor test service has successfully
completed. Conditions may occur, however, that make it impossible for
the drive to properly perform the operation. When this is the case, the
test process is automatically terminated and a test error is reported that
is stored in the Motor Test Status output parameter.
This floating point value represents the slip speed of an induction motor
as measured by the Motor Test procedure.
This floating point value represents the measured Counter EMF (CEMF)
of a PM motor at Rated Speed by the Motor Test procedure.
This floating point value represents the maximum speed of the motor
without exceeding the operational DC bus overvoltage limit, as
determined by the Motor Test procedure.
See also
Hookup Test Result Attributes on page 392
Inertia Test Result Attributes on page 398
Motor Test Configuration These are the attributes that are associated with result status applied to
a Motion Control Axis.
Attributes
Motor Test Travel Limit
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - C Set/SSV# REAL 0 0 Motor Units
The Motor Test Travel Limit attribute is used by the Dynamic Motor Test
service to limit the range of the axis travel during the test. For linear
motors, Motor Unit = Meters. For rotary motors, Motor Unit = Revs.
The Motor Test Data Valid attribute is set True by Studio 5000 Logix
Designer configuration software when a Motor Test is executed
successfully and the user Accepts the results of the test. This attribute
is set False by Studio 5000 Logix Designer configuration software
See also
Hookup Test Result Attributes on page 392
Inertia Test Result Attributes on page 398
Hookup Test Configuration Attributes on page 391
Inertia Test Configuration Attributes on page 395
Faults and Alarms The following attribute tables contain fault and alarm related attributes
associated with a Motion Control Axis Object instance.
Attributes
APR Fault Attributes This attribute table has all APR (Absolute Position Recovery) faults that
relate to attributes associated with a Motion Device Axis. This includes
standard APR faults and Rockwell Automation specific APR faults. APR
Faults are conditions during device initialization when restoring the
absolute position of an axis. Unlike Initialization Faults, APR faults are
recoverable. Clear APR faults with a Fault Reset request.
The CIP APR Faults attribute is a bit mapped value that represents the
state of all standard APR faults. An APR fault generates when the
system fails to recover the absolute position of the axis after power
cycle, reset, or reconnection. APR faults are detected during the initial
configuration or initialization of the drive axis.
When an APR fault occurs, the actual position of the axis does not
correlate to the position of the axis prior to the power cycle, reset, or
reconnect. Feedback serial number mismatch and scaling configuration
are examples of standard APR faults. APR faults are recoverable. Clear
APR faults with a Fault Reset request.
Rockwell Automation Publication MOTION-RM003L-EN-P - September 2020 405
Chapter 4 CIP Axis Attributes
The CIP APR Faults - RA attribute is a bit mapped value that represents
the state of all Rockwell Automation specific APR (Absolute Position
Recovery) faults. An APR fault generates when the system does not
recover the absolute position of the axis after power cycle, reset, or
reconnection. APR faults are detected during the initial configuration or
initialization of the drive axis. When an APR fault occurs, the actual
position of the axis does not correlate to the position of the axis before
the power cycle, reset, or reconnect. These faults are specific to
Rockwell Automation APR implementation. APR faults are recoverable.
Clear APR faults with a Fault Reset request.
1 Memory Write Error Error occurs when saving absolute position data to nonvolatile memory.
2 Memory Read Error Error occurs when reading absolute position data from nonvolatile
memory.
3 Feedback Serial Number Position Feedback Serial Number does not match the Feedback Serial
Mismatch Number.
4 Buffer Allocation Fault Occurs when there is not enough RAM memory left to save the APR data.
5 Scaling Configuration Scaling attribute configuration for this axis changes and does not
Changed match the saved scaling configuration.
6 Feedback Mode Changed Feedback Mode has changed and does not match the saved Feedback
Mode configuration.
7 Feedback Integrity Loss The Feedback Integrity bit of CIP Axis Status attribute has transitioned
from 1 to 0 during device operation.
8 Feedback Position Range Absolute position feedback range has changed due to the extension of
Changed the position feedback data type from the drive from a 32-bit DINT to a
64-bit LINT as a result of a drive firmware update, and the absolute
feedback range of the feedback device being greater than 232 feedback
counts.
9-15 -- Reserved --
0 -- Reserved -- This bit cannot be used since the Fault Code is defined by the associated
exception bit number and Fault Code of 0 means no fault condition is present.
1 Persistent Media Fault (L6x) means that all 6 sectors reserved for APR in Persistent Memory (for
example, NAND flash) are marked as bad. This fault condition is not
recoverable.
2 Firmware Error Traps firmware errors.
3 Feedback Battery Loss Battery powered Absolute Feedback device has failed to maintain absolute
position through a power cycle due to low battery level or disconnected
battery power.
4 Mover Sequencing A controller detects the Mover Axis Assignment Sequence attribute is
Without Reference configured to sequence movers on the track without a Reference Mover.
5 Mover Assignment A controller detects a change to the Mover Axis Assignment sequence
Sequence Changed attribute.
6-15 -- Reserved --
See also
Absolute Position Recovery Functionality on page 47
APR Recovery Scenarios on page 51
Axis Exception Action These configuration attributes control the action performed by the
device as a result of an exception condition. A unique exception action
Configuration Attributes is defined for each supported exception condition.
See also
Axis Exception Action on page 411
Axis Exception Action The Axis Exception Action attributes are 64-element array of
enumerated bytes that specify the action to take by the device for the
associated standard or manufacturer specific exception, respectively.
For a given exception, certain exception actions may not be supported.
Attempting to do so results in an "Invalid Attribute Value" service error
code (0x09). Each device product must specify the available actions for
each exception that is supported. If a specific exception is not supported
by the device, the only valid exception action enumeration is
'Unsupported'. Attempting to write any other value to the element
associated with an unsupported exception results in an "Invalid Attribute
Value" service error code (0x09) that is generated while the project is
online with the controller. For drives that support Rockwell Automation
specific axis exceptions, the 64-element CIP Axis Exception Action - RA
and CIP Axis Exception Action 2 - RA arrays ares sent to the drive
device.
3 Optional (FPV) Stop Planner Stop Planner instructs the drive device (D) to set the
associated bit in the Axis Faults word and instructs the
Motion Planner to perform a controlled stop of all planned
motion at the configured Max Decel rate. For some
exceptions that are fundamental to the operation of the
device, it may not be possible to select this action or any
other action that leaves device enabled.
4 Required (XBD) Disable Disable action results in the drive device (D) both setting the
associated bit in the Axis Faults word and bringing the axis
to a stop based on the factory set "best" available stopping
method. This "best" stopping method includes both the
method of decelerating the motor to a stop and the final
state of the power structure given the expected level of
control still available. The level of axis control available
depends on the specific exception condition and on the
configured control mode.
The available deceleration methods are defined by the
Stopping Action attribute. (See the Stopping Action section
following this table for additional information.)
If the application requires exception action that is a more
severe stopping action than the factory set "best" method,
the controller will initiate that action.
If the application requires an exception action that is less
severe than the factory set "best" method, the controller will
configure the device axis instance for a Minor Fault
exception action and handle the fault directly. This may put
device and motor components at risk and is only be allowed
by the device when there is an opportunity for the device to
remain operational. This is important in applications where
the value of the product is higher than the value of the motor
or device.
When the Disable exception action is applied to a converter
device (B), stopping action is not applicable (0 = No Action).
The final states of Disable or Shutdown for the converter are
applicable, however, with Shutdown executing the
configured Shutdown Action. In the Shutdown case, the DC
Bus Unload bit of the converter's Axis Status attribute is set
to generate a Bus Sharing exception on all drives in the
converter's Bus Sharing Group.
When multiple major faults occur with different stopping
actions, the most severe of the associated stopping actions
is applied, that is, the stopping action that requires the
lowest level of control functionality. This rule also applies to
the Stopping Action associated with a Disable Request.
5 Required (All) Shutdown While the final axis state after a Major Fault is the Major
Faulted state, the Shutdown Exception Action forces the
power structure into the Shutdown state, immediately
disabling the drive's power structure. If Shutdown Action is
configured to do so, this action also drops DC Bus power to
the drive's power structure. Therefore, the Shutdown action
overrides the drive's best stopping method. An explicit
Shutdown Reset is required to restore the drive to an
operational state.
6-254 Reserved -
Stopping action
Standard stopping actions, listed in decreasing levels of deceleration
control, are as follows:
1. Ramp Decel
2. Current Limit Decel
3. Coast
In general, the "best" stopping action is the most controlled deceleration
method still available given the exception condition.
The final state of the power structure in response to the Major Fault
exception action can be any one of the following states that are listed in
decreasing levels of control functionality:
1. Hold (stopped with Holding Torque)
2. Disable (stopped with Power Structure Disabled)
3. Shutdown (stopped with Shutdown Action)
The "best" final state of the power structure is the state with the most
control functionality still available given the exception condition.
In all these final states a fault reset must be executed before the axis
can be restored to enabled operation and commanded to move.
If a Start Inhibit condition is present at the time of the exception, the
best final state for the exception action can only be Disable or
Shutdown.
The specific stopping action and final state associated with a given
Disable exception action is captured in the Axis Fault Action attribute
that is included in the Fault Log record. Axis Fault Action enumerations
are as follows:
Enumeration Description
Stop Action Enumerations 0 = No Action
1 = (reserved)
2 = Ramped Stop
3 = Torque Limited Stop
4 = Coast
State Change Enumerations 0 = No Action
1 = Hold
2 = Disable
3 = Shutdown
See also
Axis Exception Action Configuration Attributes on page 407
Exceptions on page 45
Exception, Fault and Alarm Attributes on page 429
Stopping and Braking Attributes on page 594
Configuration Fault These are the configuration fault related attributes associated with a
Motion Control Axis.
Attributes
Attribute Error Code
Data
Usage Access T Default Min Max Semantics of Values
Type
Required - All Get/GSV T INT - - - Refer to CIP Error Codes
CIP Error code returned by the erred set list service to the module.
Attribute Error ID
Data
Usage Access T Default Min Max Semantics of Values
Type
Required - All Ger/GSV T INT - - -
See also
CIP Error Codes on page 415
Exception, Fault, and Alarm Attributes on page 429
Identify Motion Axis Attributes Based on Device Function Codes
on page 97
CIP Error Codes These are general CIP error codes that can be returned by the Attribute
Error Code.
See also
Configuration Fault Attributes on page 415
Exception Factory Limit These are the exception limit related attributes associated with a Motion
Control Axis. Exception Limit attributes define the conditions under
Info Attributes which a corresponding exception is generated during motion axis
operation that has the potential of generating either a fault or alarm.
They are typically associated with temperature, current, and voltage
conditions of the device that are continuous in nature. Factory Limits
(FL) for exceptions are usually hard coded in the device and typically
result in a major fault condition. User Limits (UL) for exceptions are
configurable and typically used to generate a minor fault, or alarm
condition. For this reason, the User Limits are generally set inside the
corresponding Factory Limits. Note that the triggering of a User Limit
exception does not preclude triggering of the corresponding Factory
Limit exception; the two exception trigger conditions are totally
independent of one another.
Returns the Factory Limit for the Motor Overspeed Factory Limit
exception based on a factory set value determined by the Rotary Motor
Rated Speed or Rotary Motor Max Speed attribute values, or by
operational speed limits enforced by the drive vendor. The drive may
take the minimum of any of these values as the Factory Limit.
When PM Motor Rotary Bus Overvoltage Speed and PM Motor Rotary
Max Extended Speed attributes are supported and non-zero, the drive
uses these values to determine the Rotary Motor Overspeed Factory
Limit. The PM Motor Extended Speed Permissive value determines
which limit to apply. If the PM Motor Extended Speed Permissive is
False, the Rotary Motor Overspeed Factory Limit will be based on the
PM Motor Rotary Bus Overvoltage Speed. If the PM Motor Extended
Speed Permissive is True, the Rotary Motor Overspeed Factory Limit
will be based on the PM Motor Rotary Max Extended Speed value.
For Rockwell Automation drives, when PM Motor Extended Speed
Permissive is False, the Motor Overspeed Factory Limit = 1.25 * Bus
Overvoltage Speed, or the speed limit corresponding to the Bus
Overvoltage Factory Limit, whichever is less. When PM Motor Extended
Speed Permissive is True, the Motor Overspeed Factory Limit = 1.25 *
Max Extended Speed value.
The Operational Speed Limit on all Rockwell Automation drive products
is 600 Hz. The following formula is used to calculate the operational
speed limit:
Operational Speed Limit (RPM) = 590 (Hz) * 120 / Rotary Motor Poles
Returns the Factory Limit for the Motor Overspeed Factory Limit
exception based on a factory set value determined by the Linear Motor
Rated Speed or Linear Motor Max Speed attribute values, or by
operational speed limits enforced by the drive vendor. The drive may
take the minimum of any of these values as the Factory Limit.
When PM Motor Linear Bus Overvoltage Speed and PM Motor Linear
Max Extended Speed attributes are supported and non-zero, the drive
uses these values to determine the Linear Motor Overspeed Factory
Limit. The PM Motor Extended Speed Permissive value determines
which limit to apply. If the PM Motor Extended Speed Permissive is
False, the Linear Motor Overspeed Factory Limit will be based on the
PM Motor Linear Bus Overvoltage Speed. If the PM Motor Extended
Speed Permissive is True, the Linear Motor Overspeed Factory Limit
will be based on the PM Motor Linear Max Extended Speed value.
For Rockwell Automation drives, when PM Motor Extended Speed
Permissive is False, the Motor Overspeed Factory Limit = 1.25 * Bus
Overvoltage Speed, or the speed limit corresponding to the Bus
Overvoltage Factory Limit, whichever is less. When PM Motor Extended
Speed Permissive is True, the Motor Overspeed Factory Limit = 1.25 *
Max Extended Speed value
See also
Exceptions on page 45
Exception User Limit Configuration Attributes on page 423
Exception User Limit These are the exception user limit configuration related attributes
associated with a Motion Control Axis.
Configuration Attributes
Motor Phase Loss Limit
Usage Access Data Default Min Max Semantics of Values
Type
Optional - XD Set REAL 5 0 100 % Motor Rated
Sets the minimum motor phase current for the Motor Phase Loss
exception. The current in each motor phase must exceed this value
during the motor phase loss test or a Motor Phase Loss exception
occurs. Decreasing this attribute's value lowers sensitivity to phase loss
conditions. A value of 0 will effectively disable the motor phase loss test.
Sets the Overspeed User Limit relative to the Rotary Motor Rated
Speed or Linear Motor Rated Speed that is allowable before throwing a
Motor Overspeed UL exception.
Sets User Limit for the Bus Overvoltage UL exception. Unlike the
corresponding Factory Limit, which is specified in Volts, the User Limit
is based on percent of Nominal Bus Voltage during operation.
Sets User Limit for the Feedback Signal Loss UL exception. Feedback
interface hardware typically monitor average voltage levels on incoming
signals. Feedback Signal Loss conditions occur when the average
voltage levels drop below a percentage of voltage drop allowed by the
Feedback Signal Loss Factory Limit.
Sets User Limit for the Feedback Data Loss UL exception. For digital
feedback devices, feedback interface hardware monitors the integrity of
data transferred over the serial connection to the feedback device.
Feedback Data Loss conditions occur when two or more consecutive
data packets are lost or corrupted.
Sets the low voltage limit as a percent of Converter Rated Input Voltage
for the AC line source.
Sets the high frequency limit as the difference from the nominal AC line
frequency.
Sets the low frequency limit as the difference from the nominal AC line
frequency.
Sets the high frequency limit as the difference from the nominal
alternate AC line source frequency.
Sets the low frequency limit as the difference from the nominal alternate
AC line source frequency.
Sets the User Limit for the AC Line Resonance UL exception based on
a percentage of the Converter Output Rated Current. The AC Line
Resonance UL exception occurs when the current flowing through the
AC line filter in the resonant frequency band, exceeds the user limit for
a vendor specified period.
See also
Exceptions on page 45
Exception, Fault, and Alarm Attributes on page 429
Standard Exceptions on page 662
Exception, Fault and Alarm These are the exception, fault, and alarm related attributes associated
with a Motion Control Axis. Exceptions are conditions that can occur
Attributes during axis operation that have the potential of generating faults or
alarms based on the Exception Action configuration.
Axis Exceptions
Usage Access T Data Default Min Max Semantics of Values
Type
Required - All Get T LWORD - - - See Semantics
The Axis Exceptions attribute is a bit map that represents the current
state of all standard exception conditions. See the Std. Exception Table
bit map definition later in this section for detail on the bit locations. Each
exception has a corresponding Axis Exception Action. Exceptions that
are configured to be Ignored are only be visible in this attribute
Axis Exceptions 2
Usage Access T Data Default Min Max Semantics of Values
Type
Required - XG Get T LWORD - - - See Semantics
Optional - NED
The Axis Exceptions - Mfg attribute is a bit map that represents the
current state of all manufacturer specific exception conditions. See the
Mfg. Exception Table published in drive product manual. Each
exception has a corresponding Axis Exception Action. Exceptions that
are configured to be Ignored are only be visible in this attribute.
Axis Faults
Usage Access T Data Default Min Max Semantics of Values
Type
Required - All Get T LWORD - - - See Semantics
A bit map that represents the state of all standard runtime faults. The bit
map is identical to that of the Axis Exceptions attribute. Fault bits when
set are latched until a fault reset occurs. A fault reset clears the
Axis Faults 2
Usage Access T Data Default Min Max Semantics of Values
Type
Required - XG Get T LWORD - - - See Semantics
Optional - NED
A bit map that represents the state of all manufacturer specific runtime
faults. The bit map is identical to that of the Axis Exceptions Mfg
attribute. Fault bits when set are latched until a fault reset occurs. A
fault reset clears the runtime fault bits, but the bits set again
immediately if the underlying exception condition is still present. Any
exceptions whose Axis Exception Action is configured to ignore or
report as alarms do not appear in this attribute.
The Axis Faults 2 - Mfg attribute provides a 64-bit extension to the Axis
Faults Mfg attribute bit map representing the state of all manufacturer
specific runtime faults. The bit map is identical to that of the Axis
Exceptions Mfg attribute. Fault bits when set are latched until a fault
reset occurs. A fault reset clears the runtime fault bits, but the bits set
again immediately if the underlying exception condition is still present.
A bit map that represents the state of all Rockwell Automation specific
runtime faults. Fault bits when set are latched until a fault reset occurs.
A fault reset clears the runtime fault bits, but the bits set again
immediately if the underlying exception condition is still present. Any
exceptions whose CIP Axis Exception Action is configured to ignore or
report as alarms do not appear in this attribute.
Axis Alarms
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - All Get T LWORD - - - See Semantics
A bit map that represents the current state of all standard alarm
conditions. The bit map is identical to that of the Std. Axis Exceptions
attribute. Only exception conditions whose Axis Exception Action is
configured to report as an alarm appear in this attribute, and will not be
reported in the Axis Faults attribute. Alarm bits when set are not latched
and will clear as soon as the underlying exception condition, or multiple
underlying exception sub-conditions with different Sub Codes, is
corrected.
Axis Alarms 2
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - All Get T LWORD - - - See Semantics
A bit map that represents the current state of all manufacturer specific
alarm conditions. The bit map is identical to that of the Mfg. Axis
Exceptions attribute. Only exception conditions whose Axis Exception
Action is configured to report as an alarm appear in this attribute, and
will not be reported in the Axis Faults attribute. Alarm bits when set are
not latched and will clear as soon as the underlying exception condition,
or multiple exception sub-conditions with different Sub Codes, is
corrected.
A bit map that represents the current state of all Rockwell Automation
specific alarm conditions. Only exception conditions whose Axis
Exception Action is configured to report as an alarm appear in this
attribute, and will not be reported in the CIP Axis Faults attribute. Alarm
bits when set are not latched and will clear as soon as the underlying
exception condition is corrected.
See also
Exceptions on page 45
Module Node Fault and Alarm Attributes on page 438
Standard Exceptions on page 662
Rockwell Automation Specific Exceptions on page 671
Initialization Faults These are the initialization fault related attributes associated with a
Motion Control Axis. Initialization Faults are conditions that can occur
Attributes during the device initialization process that prevent normal operation of
the device.
A bit map that represents the state of all standard initialization faults.
These faults prevent any motion, and do not have configurable fault
actions. Examples of initialization faults are corrupted memory data,
A bit map that represents the state of all Rockwell Automation specific
initialization faults. These faults prevent any motion, and do not have
configurable fault actions. Examples of initialization faults are corrupted
memory data, calibration errors, firmware startup problems, or an invalid
configuration attribute value. Initialization faults cannot be cleared with a
Fault Reset service, although a power-cycle provides a new attempt at
initialization.
See also
Rockwell Automation Specific Initialization Faults on page 436
Standard Initialization Faults on page 435
Standard Initialization This table defines a list of standard faults associated with the
Initialization Faults attribute.
Faults
Standard Initialization Fault Descriptions
Bit Exception Description
0 Reserved This bit cannot be used since the Fault Code is defined by the
associated exception bit number and Fault Code of 0 means no fault
condition is present.
1 Boot Block Checksum Fault Checksum or CRC error for Boot Block of CIP Motion device detected
as part of Self-Test.
2 Main Block Checksum Fault Checksum or CRC error for Main Block of CIP Motion device detected
as part of Self-Test.
3 Nonvolatile Memory Checksum or CRC error for NV Memory of CIP Motion device detected
Checksum Fault as part of Self-Test.
4...31 Reserved
See also
Rockwell Automation Specific Initialization Faults on page 436
Initialization Faults Attributes on page 434
Standard Start Inhibits on page 615
Rockwell Automation This table defines a list of Rockwell Automation specific faults
associated with the Initialization Faults-RA attribute.
Specific Initialization Faults
Rockwell Automation Specific Initialization Faults Bit Descriptions
Bit Exception Description
2 Feedback Data Range Data within a motor data blob is out of range.
16 Illegal Option Card The Main Control Board has detected an illegal
option installed in the port.
17 Option Storage Checksum Option data storage checksum failed.
18 Reserved -
19 Module Voltage Mismatch Voltage rating mismatch detected on the inter-
device communications backplane.
20 Unknown Module Unknown device detected on the inter-device
communications backplane.
21 Factory Configuration Error Factory Configuration Data is missing or invalid.
22 Illegal Address Invalid Ethernet IP Address configuration or device
Node Address is out of range (>254).
23 Series Mismatch Incompatible device is detected on the inter-device
communications backplane, for example, SERCOS
AMs have been detected by the CIP IAM.
0 -
8 -
9 -
10 -
11 -
12 Invalid FPGA Image Fault
18 -
19 Module Voltage Mismatch
20 Unknown Module Fault
21 Factory Configuration Error Fault
22 Illegal Address Fault
23 Series Mismatch Fault
24 Open Slot Fault
25 Mover Axis Assignment Fault
26 Track Backplane Communication Fault
27 Unassociated Section Axis Fault
28 Track Configuration Fault
See also
Rockwell Automation Specific Exceptions on page 671
Rockwell Automation Specific CIP Axis Alarm Names on page
675
Rockwell Automation Specific CIP Axis Fault Names on page
674
Rockwell Automation Specific Start Inhibits on page 616
Module/Node Fault and These are the module/node fault and alarm related attributes
associated with a Motion Control Axis.
Alarm Attributes
This bit field is a roll-up of module scoped fault conditions that can
include synchronization faults detected on either side of the CIP Motion
connection. All defined Node Fault Codes are mapped into bits in this
attribute. The controller generally applies a shutdown fault action when
a Module Fault occurs and recovery generally requires module
reconnection or reconfiguration.
The following table defines a list of conditions associated with the
Module Fault Bits attributes. While the Module Fault Bits attribute is
marked as Required in the CIP Motion device implementation, support
for each of the individual fault conditions therein is left Optional. In this
table the terms motion module and motion device are used
synonymously.
Bit Module Fault Device Node Fault Description
Name Name
0 Control Sync Fault - The Control Sync Fault bit attribute is set when the
Logix controller detects that several consecutive
connection updates from the motion module have
been missed. This condition results in the automatic
shutdown of the associated motion module. The
Logix controller is designed to "ride-through" a
maximum of four missed position updates without
issuing a fault or adversely impacting motion in
progress. Missing more than four position updates
in a row constitutes a problematic condition that
warrants shutdown of the motion module. This bit is
cleared when the connection is reestablished.
18 Duplicate Address Duplicate Address The Duplicate Address Fault bit indicates that a
Fault Fault motion device node has been detected on the
network that uses the same Node Address as this
device node. For Ethernet, this address would be the
IP Address of the device.
19 System System Connection The System Connection Fault code indicates that
Connection Fault Fault the device has detected that the connection to a
networked device that this device depends on has
faulted or has been closed.
20-31 Reserved - -
This bit field is a roll-up of module scoped alarm conditions that can
include synchronization alarms detected on either side of the CIP
Motion connection. All defined Node Alarm Codes are mapped into bits
in this attribute.
The following table defines a list of conditions associated with the
Module Alarm Bits attributes. While the Module Alarm Bits attribute is
marked as Required in the CIP Motion device implementation, support
See also
Exceptions on page 45
Standard Exceptions on page 662
Exception Factory Limit Info Attributes on page 422
Exception User Limit Configuration Attributes on page 423
Fault Log Attributes These are the fault log attributes associated with a Motion Control Axis.
(Fault Type != 8)
Fault Sub Code: Enum
(Fault Type = 8)
Fault Sub Code: Attr ID
Stop Action Enum:
0 = No Action
1 = Planner Stop
2 = Ramped Stop
3 = Torque Limited Stop
4 = Immediate (Coast)
State Change Enum:
0 = No Action
The CIP Axis Fault Log attribute is a structure that is used to implement
a running log of faults, complete with fault type, fault codes, and
timestamps. The elements of this structure is as follows:
The Fault Log Index points to the latest element in the Fault Log array.
Each element in the Fault Log array is called a Fault Log Record.
The Fault Log Length element indicates the number of elements in the
Fault Log array.
The Fault Type is an enumerated value indicating the type of fault
condition or fault clearing event to which the Fault Code applies.
The Fault Code indicates the specific fault condition or fault clearing
event that has occurred. For fault conditions (Fault Type != 0) the Fault
Code generally represents the bit number of the fault as defined in the
associated Axis Faults attribute. In the case of a Configuration Fault, the
Fault Code represents the Attribute Error Code. For fault clearing
events (Fault Type = 0) the Fault Code identifies the specific fault
clearing event that occurred. Possible fault clearing events are a
module reset, a fault reset request, a shutdown reset request, or a reset
resulting from opening or closing a CIP Motion connection. A Fault
Code of 255 (0xFF) indicates that a Fault Log Reset event occurred.
The Fault Sub Code is an enumeration used to provide additional detail
into the source of the fault condition. The enumeration is specific to the
associated Fault Code. For Configuration Faults, the Fault Sub Code
corresponds to the Attribute Error ID that generated the error condition.
The Stop Action element is an enumerated value that indicates what
form of stopping action the drive initiated in response to the fault
condition.
The State Change element specifies what the final targeted state was
for the fault action.
The Fault Time Stamp represents the time at which the corresponding
fault was detected. The units of the time stamp are based on System
Time in microsecond units.
The CIP Axis Alarm Log attribute is a structure used to implement a
running log of alarms, complete with alarm type, alarm codes, and
timestamps. The elements of this structure is as follows:
The Alarm Log Index points to the latest element in the Alarm Log array.
Each element in the Alarm Log array is called an Alarm Log Record.
The Alarm Log Length element indicates the number of elements in the
Alarm Log array.
The Alarm Type is an enumerated value indicating the type of alarm to
which the Alarm Code applies.
The CIP Axis Alarm Log attribute is used to implement a running log of
alarms, complete with alarm type, alarm codes, and timestamps. The
elements of this structure is as follows:
The Alarm Log Index points to the latest element in the Alarm Log array.
Each element in the Alarm Log array is called an Alarm Log Record.
The Alarm Log Length element indicates the number of elements in the
Alarm Log array.
The Alarm Type is an enumerated value indicating the type of alarm to
which the Alarm Code applies.
The Alarm Code is indicates the specific alarm that has occurred. Alarm
Codes are based on the corresponding bit number of the alarm as
defined in the associated alarm attribute.
Writing to the Fault Log Reset attribute clears the entire Fault Log and
resets the Fault Log Index to the 0th element, records the Fault Log
Reset event and increments the Fault Log Index to 1.
Writing to the Alarm Log Reset attribute clears the entire Alarm Log and
resets the Alarm Log Index to the 0th element, records the Alarm Log
Reset event and increments the Alarm Log Index to 1.
This number is a running count of records added to the fault log. This
number is initialized to 0 at power-up, or by a controller reset, and is
incremented with every record added to the CIP Axis Fault Log. This
attribute may be used by software to determine if there are new fault log
records to upload.
This number is a running count of records added to the alarm log. This
number is initialized to 0 at power-up or by a controller reset, and is
incremented with every record added to the CIP Axis Alarm Log. This
attribute may be used by software to determine if there are new alarm
log records to upload.
See also
Initialization Faults Attributes on page 434
Feedback Attributes The following position feedback related attribute tables associated with
a Motion Control Axis apply to various feedback device and feedback
interface technologies.
Tamagawa (TG), Nikon (NK), and Stahl SSI (SL) are serial interface
protocols for encoders. Track Section (TS) and Track Mover (TM) are
applicable to track-based systems. The position feedback
characteristics of the track split between track sections and track
movers. Section electronics determine feedback resolution and the
feedback range for the Track Section component of the feedback
electronics.
This section defines the minimal set of required attributes to support
CIP Motion device interchangeability. This guarantees that there is
sufficient parametric data provided by the controller for any CIP Motion
compliant drive to effectively interface to a wide range of feedback
device types.
Multiple feedback device interfaces are currently defined by the Motion
Control Axis per axis to serve specific control or master feedback
functions. These feedback devices are accessed using their assigned
logical channels, for example, Feedback 1 and Feedback 2. Each
logical feedback channel is mapped to a physical feedback interface
port of the device, for example Port 1, and Port 2.
See also
General Feedback Info Attributes on page 470
General Feedback Signal Attributes on page 471
Feedback Configuration Attributes on page 456
Feedback Configuration The Feedback Configuration attributes determines how the various
available feedback channels are used to implement the selected
Attributes Control Mode.
Feedback Configuration
Usage Access Data Default Min Max Semantics of Values
Type
Required - All Set/GSV USINT 0 (B, F) 0 15 Enumeration:
1 (E) 0 = No Feedback
2 (C) 1 = Master Feedback
2 = Motor Feedback
3 = Load Feedback
4 = Dual Feedback
5-7 = Reserved
8 = Dual Int Feedback
8-15 = Reserved
When configured, this attribute also sets the initial value for Feedback
Mode. This attribute contains a 4-bit enumerated value that determines
how the various logical feedback channels are used to implement the
selected Control Mode for this axis instance.
Feedback Configuration enumerations provide support for multi-
feedback device control functionality for the various active device
Control Modes, for example, where the device is actively controlling the
motor based on feedback. In these active device Control Modes it is
assumed that logical channel, Feedback 1, is attached directly to the
motor while Feedback 2 is attached to the load side of the mechanical
transmission. Commutation signals for a PM motor are always derived
from the Feedback 1, except in the case of an active redundant
feedback source.
This table describes the Feedback Configuration enumerations:
Bit Usage Name Description
0 R/S No Feedback No Feedback is selected when sensorless open loop or
closed loop control is desired. When performing open loop
control, no feedback signal is required. In closed loop
control, the required feedback signal is estimated by a
sensorless control algorithm based on motor phase voltage
and current signals.
1 R/N Master Feedback Master Feedback assigns an uncommitted feedback channel
to this device axis instance to serve as a master feedback
source when the device is configured for No Control mode
2 R/C Motor Feedback When Motor Feedback is selected, then commutation,
acceleration, velocity, and position feedback signals are all
derived from motor mounted Feedback 1
Feedback Mode
Usage Access Data Default Min Max Semantics of Values
Type
Required - XED Set* BYTE 0 0 15 Bits 0-3: Feedback Mode
Enumeration
0 = No Feedback
1 = Master Feedback
2 = Motor Feedback
3 = Load Feedback
4 = Dual Feedback
5-7 = Reserved
8-15 = Vendor Specific
8 = Dual Int Feedback
Bits 4-5: Feedback Data Type
Enumeration
0 = DINT (32-bit integer)
1 = LINT (64-bit integer)
2-3 = Reserved
Bits 6-7 = Reserved
* Indicates the attribute cannot be set while the drive power structure is enabled (Power Structure Enable bit
in CIP Axis Status is true).
Feedback n Unit
Usage Access Data Default Min Max Semantics of Values
Type
Required - E Set USINT 0 - - Enumeration
DB 0 = Rev
1 = Meter
2-127 = Reserved
128-255 = Vendor Specific
Feedback n Type
Usage Access Data Default Min Max Semantics of Values
Type
Required - E Set USINT 0 - - Enumeration
DB 0 = Not Specified (R)
1 = Digital AqB (O)
2 = Digital AqB with UVW (O)
3 = Digital Parallel (O)
4 = Sine/Cosine (O)
5 = Sine/Cosine with UVW (O)
6 = Hiperface (O)
7 = EnDat Sine/Cosine (O)
8 = EnDat Digital (O)
9 = Resolver (O)
10 = SSI Digital (O)
11 = LDT (O)
12 = Hiperface DSL (O)
13 = BiSS Digital (O)
14 = Integrated (O)
15 = SSI Sine/Cosine (O)
16 = SSI AqB (O)
17 = BiSS Sine/Cosine (O)
18-127 = Reserved
128-255 = Vendor Specific
128 = Tamagawa Serial (O)
129 = Stahl SSI (O)
130 = Track Section (O)
131 = Track Mover (O)
132 = Nikon (O)
Feedback n Polarity
Usage Access Data Default Min Max Semantics of Values
Type
Optional - E Set USINT 0 - - Enumeration
0 = Normal Polarity
1 = Inverted Polarity
2-225 = Reserved
Feedback n Turns
Usage Access Data Default Min Max Semantics of Values
Type
Required - E Set UDINT 1 1 max Feedback Units (Rev)
Rotary Absolute DB dint
Feedback n Length
Usage Access Data Default Min Max Semantics of Values
Type
Required - E Set REAL 1 0.001 Feedback Units (Meters)
Linear Absolute DB
The Feedback n Data Code attribute is the type of feedback data bit
encoding used by designated serial or parallel data interface channel of
a feedback device.
The Feedback n LDT Type attribute determines the LDT type. The
attribute options are Start/Stop and PWM. Start/Stop transducers
receive an input (interrogate) signal to start the measurement cycle and
respond with two pulses on the return line. Timing is either Rising or
The Feedback n Loss Action attribute specifies the action taken in the
event of a loss of Feedback 1 signal. Valid actions are to simply handle
as an Exception, or automatically switch to Sensorless operation where
feedback is estimated based on motor current and voltage signals, or
automatically switch to a scaled version of a redundant feedback
device. In the case of redundant feedback, Feedback 1 is called the
primary feedback source and the redundant channel is the called the
secondary feedback source.
See also
Feedback Attributes on page 453
General Feedback Info Attributes on page 470
General Feedback Signal Attributes on page 471
Interpreting the Attribute Tables on page 89
General Feedback Info These are the general feedback information attributes associated with a
Motion Control Axis.
Attributes
Feedback n Serial Number
Usage Access Data Type Default Min Max Semantics of Values
Optional - E Get SHORT - - - For example,
STRING 0012003400560078
Position Feedback n
Usage Access Data Type Default Min Max Semantics of Values
Require - E Get/GSV DINT - - - Feedback n Counts
See also
Feedback Attributes on page 453
General Feedback Signal Attributes on page 471
Feedback Configuration Attributes on page 456
General Feedback Signal These are the general feedback signal attributes associated with a
Motion Control Axis.
Attributes
Feedback n Position
Usage Access T Data Default Min Max Semantics of Values
Type
Required - E Get T DINT - - - Feedback n Counts
Feedback n Velocity
Usage Access T Data Default Min Max Semantics of Values
Type
Required - E Get T REAL - - - Feedback n Units/Sec
Feedback n Acceleration
Usage Access T Data Default Min Max Semantics of Values
Type
Required - E Get T REAL - - - Feedback n Units/Sec2
The Feedback n Error Code attribute is the error code reported by the
feedback device associated with the Feedback n channel when it
detects an internal error resulting in a Feedback Device Failure
exception.
Feedback nU Position
Valid for n = 1 or 2 only
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - E Get T DINT - - - Feedback n Counts
Feedback nU Velocity
Valid for n = 1 or 2 only
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - E Get T REAL - - - Feedback n Units/Sec
Feedback nU Acceleration
Valid for n = 1 or 2 only
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - E Get T REAL - - - Feedback n Units/Sec2
Feedback nS Position
Valid for n = 3 or 4 only
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - E Get T DINT - - - Scaled Feedback n Counts
Feedback nS Velocity
Valid for n = 3 or 4 only
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - E Get T REAL - - - Scaled Feedback n Units/Sec
Feedback nS Acceleration
Valid for n = 3 or 4 only
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - E Get T REAL - - - Scaled Feedback n Units/Sec2
See also
Feedback Attributes on page 453
General Feedback Signal Attributes on page 471
Feedback Configuration Attributes on page 456
Motion Control Attributes The following attribute tables contain motion control related attributes
associated with a Motion Control Axis Object instance.
Motion Control These are the basic motion control configuration attributes associated
with a motion control axis. These attributes govern the overall behavior
Configuration Attributes of the motion control axis.
Axis features
Usage Access Data Type Default Min Max Value Description
Required - All Set/ DWORD 0 - - Bitmap
GSV 0 = Fine Interpolation (O)
1 = Registration Auto-rearm (O)
2 = Alarm Log (O)
3 = Marker (O)
4 = Home Switch (O)
5 = Hookup Test (O)
6 = Commutation Test (O)
7 = Motor Test (O)
8 = Inertia Test (O)
9 = Sensorless Control (O)
10 = Drive Scaling (O)
11 = Extended Event Block (O)
12 = Integer Command Position (O)
13 = Ext. Motor Test (O)
14 = Control Mode Change (O)
15 = Feedback Model Change (O)
16 = Pass Bus Status (O)
17 = Pass Bus Unload (O)
18 = Ext. Speed for SPM (O)
19 = Ext. Speed for IPM (O)
20 = Ext. Pos. Feedback (O)
21 = Ext. Sub Code Format (O)
22: Ext. Dynamic Motor Test (O)
23: Hookup Test Speed(O)
24-31: (reserved)
The following table provides descriptions of the bit specified Axis feature
attribute values.
Bit Motion Status Description
0 Fine Interpolation (O) Indicates that the axis supports fine interpolation of command
data based on command target time. Fine interpolation is used to
provide smoother command reference signals when the drive
update period is smaller than the controller update period.
1 Registration Auto-rearm (O) Indicates that the axis supports the automatic re-arming
mechanism for registration inputs. This feature is required for
windowed registration support.
2 Alarm Log (O) Indicates that this axis supports the Alarm Log feature. Alarm Log
data is received from the drive using the Alarm bit of the Status
Data Set and updates the Alarm Log of the controller.
3 Marker (O) Indicates that the axis position feedback device supports a
marker function. This functionality is required for Homing
Sequences that employ the marker signal and for the marker
Hookup Test.
4 Home Switch (O) Indicates that the axis supports a home switch input. This
functionality is required for Homing Sequences that employ the
home switch input signal.
5 Hookup Test (O) The axis supports a Hookup Test service. This service is required
to perform a Hookup Test (MRHD) to check wiring to the motor
and feedback components.
Axis configuration
Usage Access Data Default Min Max Value Description
Type
Required - All Set/GSV USINT AOP* 0 5 Enumeration
0 = Feedback Only (O)
1 = Frequency Control (O)
2 = Position Loop (O)
3 = Velocity Loop (O)
4 = Torque Loop (O)
5 = Non-Regenerative AC/DC Converter
(O)
6 = Regenerative AC/DC Converter (O)
7 = Low Harmonic AC/DC Converter (O)
8 = DC/DC Converter (O)
9-127 = Reserved
128-255 Vendor Specific
* The default value can be specified by the specific drive profile (AOP).
The axis configuration attribute determines the general dynamic control
behavior of the motion device axis instance.
3 R/V O/P Velocity Loop Selects the PI Vector Control Method that applies
feedback to provide closed loop cascaded PI control of
motor velocity, and torque, and includes closed loop
control of Iq and Id components of the motor current
vector. Accordingly, the Control Mode attribute is set to
Velocity Control.
4 R/T O/PV Torque Loop Selects the PI Vector Control Method that applies
feedback to provide closed loop PI control of motor
torque through control of Iq and Id components of the
motor current vector. Accordingly, the Control Mode
attribute is set to Torque Control.
Control Mode
Usage Access Data Type Default Min Max Value Description
Required - All Get/ BYTE 0 0 4 Enumeration
Derived from Axis SSV(1) 0 = No Control
Configuration 1 = Position Control
2 = Velocity Control
3 = Acceleration Control
4 = Torque Control
5-15 = Reserved
Bits 4-7 Reserved
Control Method
The Control Method (derived from axis configuration) attribute is an 8-bit
enumerated code that determines the basic control algorithm applied by
the device to control the dynamic behavior of the motor.
See also
Interpreting the Attribute Tables on page 89
Motion Control Modes on page 22
Control Mode Attributes
Motion Control Interface The Motion Control Interface attributes are used by the Logix Designer
application to support the interface to an axis. Interface attributes are
Attributes used to customize what choices appear on the properties pages and
help you structure a motion axis.
Tip: Remember that the attributes that appear in the Logix Designer application are dependent on the current Control Mode
Axis Address
Usage Access Data Type Default Min Max Semantics of Values
Required - Get DINT - - - Absolute Address
All
Axis Instance
Usage Access Data Type Default Min Max Semantics of Values
Required - Get/ DINT - - - Instance Number
All GSV
Group Instance
Usage Access Data Type Default Min Max Semantics of Values
Required - Get/ DINT - - - Instance Number
All GSV
Map Instance
Usage Access Data Type Default Min Max Semantics of Values
Required - Set/ DINT - - - Instance Number
All GSV
Module Channel
Usage Access Data Type Default Min Max Semantics of Values
Required - Set/ USINT 255 - - Channel Number (0, 1, 2, …)
All GSV A value of 255 indicates the
axis is unassigned.
Object class code of the motion engine in the module. The Module
Class Code attribute is the class code of the object in the motion
module which is supporting motion; for example 0xAF is the object ID of
the Servo Module Axis residing in the 1756-M02AE module.
Memory Use
Usage Access Data Type Default Min Max Semantics of Values
Required - Get/ UINT - - - 105 (0x69) = I/O space
All GSV 106 (0x6a) = Data Table space
Controller memory space where this instance of the Motion Control Axis
Object exists. This attribute is initialized as part of the create service
when you create the axis.
The Logix Designer programming application uses this attribute to
create axis instances in I/O memory for axes that are either to be
produced or consumed.
The Memory Use attribute can only be set as part of an axis create
service and is used to control which controller memory the object
instance is created in.
Memory Usage
Usage Access Data Type Default Min Max Semantics of Values
Required - Get DINT - - - Bytes
All
Associated tag data type for this instance of the Motion Control Axis
Object. This attribute is initialized as part of the create service when you
create the axis.
The Axis Data Type attribute and is used to determine which data
template, memory format, and set of attributes are created and
applicable for this axis instance. This attribute can only be set as part of
an axis create service.
State of the configuration state machine for this instance of the Motion
Control Axis Object. The Axis Configuration State attribute is used for
troubleshooting purposes to indicate where in the axis configuration
state-machine this axis presently is. Even consumed and virtual axes
will utilize this attribute. This attribute is valid for all physical and non-
physical data types.
Axis State
Usage Access Data Type Default Min Max Semantics of Values
Required - Get USINT - - - Enumeration
All 0 = Ready
1 = Drive Enable, (direct
drive control)
2 = Servo Control
3 = Faulted
4 = Shutdown
5 = Inhibited
6 = Ungrouped
7 = No Module
8 = Configuring (FW default)
State of this instance of the Motion Control Axis. Indicates the operating
state of the axis. Examples of possible states include: axis-ready, drive
enable, servo control, axis faulted, axis shutdown, axis inhibited, and
axis unassigned.
User Event Task that will be triggered to execute when a Watch event
occurs.
This attribute is set through internal communication from the user Task
object to the Axis object when the Task trigger attribute is set to select
this attributes of an Axis. It cannot be set directly by an external device.
It is available to be read externally for diagnostic information.
The Watch Event Task attribute indicates which user Task will be
triggered when a watch event occurs. An instance value of 0 indicates
that no event task has been configured to be triggered by the Watch
Event.
The user Task is triggered at the same time that the Process Complete
bit is set for the instruction that armed the watch event.
User Event Task that will be triggered to execute when a Home event
occurs.
This attribute is set through internal communication from the user Task
object to the Axis object when the Task trigger attribute is set to select
this attributes of an Axis. It cannot be set directly by an external device.
It is available to be read externally for diagnostic information.
The Home Event Task attribute indicates which user Task will be
triggered when a home event occurs. An instance value of 0 indicates
that no event task has been configured to be triggered by the Home
Event.
The user Task is triggered at the same time that the Process Complete
bit is set for the instruction that armed the home event.
Inhibit Axis
Usage Access Data Type Default Min Max Semantics of Values
Required - Set/ SINT 0 - - 0 triggers an uninhibit.
All SSV 1 triggers an inhibit.
Setting to any non-zero value is
treated the same as a value of 1,
and results in the attribute being
set to a 1.
Axis ID
Usage Access Data Type Default Min Max Semantics of Values
Required - Set/ DINT - - - ID
All GSV
Associated tag data type for this instance of the Motion Control Axis
Object.
The Axis Data Type attribute and is used to determine which data
template, memory format, and set of attributes are created and
applicable for this axis instance.
See also
CIP Axis Attributes on page 243
Motion Control Axis Behavior Model on page 54
Motion Control Signal The Motion Control Signal Attributes associated with the axis provide
access to the current and historical position, velocity, and acceleration
Attributes information of the axis. These values may be used as part of the user
program to implement sophisticated real-time computations associated
with motion control applications.
Important: Configuration of Scaling page parameters is required for any attributes expressed in
position, velocity, or acceleration units to return meaningful values.
Actual Position
Usage Access T Data Default Min Max Semantics of Values
Type
Required - All Get/GSV T REAL - - - Position Units
Tag access is supported by
the value is valid only when
Auto Tag Update of the Motion
Group Object is enabled.
Average Velocity
Usage Access T Data Default Min Max Semantics of Values
Type
Required - All Get/GSV T REAL - - - Position Units / Sec
Actual Velocity
Usage Access T Data Default Min Max Semantics of Values
Type
Required - All Get/ T REAL - - - Position Units / Sec
GSV Tag access is supported but
the value is valid only when
Auto Tag Update of the Motion
Group Object is enabled.
Actual Acceleration
Usage Access T Data Default Min Max Semantics of Values
Type
Required - All Get/ T REAL - - - Position Units / Sec2
GSV Tag access supported but the
value is valid only when Auto
Tag Update of the Motion
Group Object is enabled.
Watch Position
Usage Access T Data Default Min Max Semantics of Values
Type
Required - E Get/ T REAL - - - Position Units
GSV
The two Registration Time values contain the lower 32-bits of CST time
at which their respective registration events occurred. Units for this
attribute are in microseconds.
Interpolation Time
Usage Access T Data Default Min Max Semantics of Values
Type
Required - E Set/ T DINT - - - CST time to Interpolation
SSV
The Interpolation Time attribute is the 32-bit CST time used to calculate
the interpolated positions. When this attribute is updated with a valid
CST value, the Interpolated Actual Position and Interpolated Command
Position values are automatically calculated.
Command Position
Usage Access T Data Default Min Max Semantics of Values
Type
Required - FPV Get/ T REAL - - - Position Units
GSV Tag access is supported but
the value is valid only when
Auto Tag Update of the Motion
Group Object is enabled.
Command Velocity
Usage Access T Data Default Min Max Semantics of Values
Type
Required - FPV Get/ T REAL - - - Position Units / Sec
GSV Tag access is supported but
the value is valid only when
Auto Tag Update of the Motion
Group Object is enabled.
Command Acceleration
Usage Access T Data Default Min Max Semantics of Values
Type
Required - FPV Get/ T REAL - - - Position Units / Sec2
GSV Tag access is supported but
the value is valid only when
Auto Tag Update of the Motion
Group Object is enabled.
Command Torque
Usage Access T Data Default Min Max Semantics of Values
Type
Required - VT Get/ T REAL 0 - + % Rated
SSV
Master Offset
Usage Access T Data Default Min Max Semantics of Values
Type
Required - FPV Get/ T REAL - - - Master Position Units
PV only GSV* Tag access supported but the
value is valid only when Auto
Tag Update of the Motion
Group Object is enabled.
The Master Offset attribute is the position offset that is currently applied
to the master side of the position cam. The Master Offset is returned in
master position units. The Master Offset shows the same unwind
characteristic as the position of a linear axis. Tag access is supported
but the tag value is valid only when Auto Tag Update of the Motion
Group Object is enabled
The Strobe Master Offset attribute is the position offset that was applied
to the master side of the position cam when the last Motion Group
Strobe Position (MGSP) instruction was executed. The Strobe Master
Offset is returned in master position units. The Strobe Master Offset
shows the same unwind characteristic as the position of a linear axis.
The Start Master Offset attribute is the position offset that was applied
to the master side of the position cam when the last Motion Axis Move
(MAM) instruction with the move type set to Absolute Master Offset or
Incremental Master Offset was executed. The Start Master Offset is
returned in master position units. The Start Master Offset shows the
same unwind characteristic as the position of a linear axis.
See also
Motion Control Interface Attributes on page 480
Motion Control Status These are the motion control status attributes associated with a Motion
Control Axis. The Axis Event Bits are located in Event Capture
Attributes Attributes.
The Direct Control Status bit is set by the Motion Drive Start instruction (MDS)
and once set, can only be cleared by executing an MSO instruction from the
Stopped or Stopping State. Similarly, once the Direct Control Status bit is
cleared by the Motion Servo On instruction (MSO), the bit can only be set again
by executing an MDS instruction from the Stopped or Stopping State.
6 Axis Update The Axis Update bit indicates whether or not this axis instance was updated in
Status last execution of Motion Task. In general, axis instances are updated in Motion
Task according to their Axis Update Schedule. Thus, a given axis instance may
or may not be updated during Motion Task execution. When inspected as part of
an Event Task triggered by Motion Group Execution, the Axis Update bit can be
used to qualify program instructions based on whether or not the axis was
updated by the preceding Motion Task.
The Axis Event Bit attributes are a collection of basic event conditions.
This attribute is for use primarily by the system during execution of
various Motion Event instructions.
The Output Cam Status bit is set when an Output Cam has been
initiated. The Output Cam Status bit is reset when the cam position
moves beyond the cam start or cam end position in "Once" execution
mode with no Output Cam pending or when the Output Cam is
terminated by a Motion Disarm Output Cam (MDOC) instruction.
The Output Cam Pending Status bit is set if an Output Cam is currently
pending the completion of another Output Cam. This would be initiated
by executing an Motion Arm Output Cam (MAOC) instruction with
Pending execution selected. As soon as this output cam is armed, being
triggered when the currently executing Output Cam has completed, the
The Output Cam Lock Status bit is set when an Output Cam has been
armed. This would be initiated by executing a Motion Arm Output Cam
(MAOC) instruction with Immediate execution selected, when a pending
output cam changes to armed, or when the axis approaches or passes
through the specified axis arm position. As soon as this output cam
current position moves beyond the cam start or cam stop position, the
Output Cam Lock bit is cleared. This bit is also cleared if the Output
Cam is terminated by a Motion Disarm Output Cam (MDOC) instruction.
The Output Cam Transition Status bit is set when a transition between
the currently armed and the pending Output Cam is in process.
Therefore, each Output Cam controls a subset of Output Bits. The
Output Cam Transition Status bit is reset, when the transition to the
pending Output Cam is complete or when the Output Cam is terminated
by a Motion Disarm Output Cam (MDOC) instruction.
See also
Event Capture Attributes on page 356
Exceptions on page 45
APR Fault Attributes on page 405
Motion Database Storage The following are the Motion Database Storage attributes associated
with a Motion Control Axis.
Attributes
This floating point value represents the lumped model time constant
associated with the drive device for the purposes of computing loop
gains. This attribute is used to store the original Drive Model Time
Constant value for subsequent upload. The Drive Model Time Constant
Base (DMTC_Base) is computed based on the current loop bandwidth,
the velocity loop update time and the feedback sample period according
to the following formula:
DMTC_Base = 2 * 1/(2*PI*Current Loop Bandwidth(Hz)) + Velocity
Loop Update Period + Feedback Sample Period/2
This floating point value represents the peak current rating associated
with the drive device and used to compute peak torque and acceleration
limits. This attribute is used to store the original Drive Rated Peak
Current value for subsequent upload.
This floating point value represents the maximum DC Bus voltage level
that can be sustained during drive operation, which is used to calculate
the factory default value for PM Motor Rotary Bus Overvoltage Speed or
This floating point value represents the lumped model time constant
associated with the regenerative converter device for the purposes of
computing loop gains. This attribute is used to store the original
Converter Model Time Constant value for subsequent upload. The
Converter Model Time Constant Base is computed based on the
converter current loop bandwidth, the bus voltage loop update time and
the bus voltage feedback sample period according to the following
formula:
CMTC_Base = 2 * 1/(2*PI*Current Loop Bandwidth(Hz)) + Bus Voltage
Loop Update Period
This floating point value represents the default bandwidth for the active
and reactive current loops for the regenerative converter. This attribute
is used to store the original default Converter Current Loop Bandwidth
value that was used to compute the Converter Model Time Constant
that is the basis for tuning the converter.
This floating point value represents the continuous output current rating
associated with the regenerative converter and used to compute the
System Capacitance scaling attribute value from the Total Capacitance
of the DC Bus. This attribute is used to store the original Converter
Rated Current value for subsequent upload.
This floating point value represents the peak output current rating
associated with the regenerative converter and used together with the
Converter Rated Current to compute the default Converter Current
Vector Limit attribute value. This attribute is used to store the original
Converter Rated Peak Current value for subsequent upload.
This floating point value represents the input voltage rating associated
with the regenerative converter and used to compute the Bus Voltage
Set Point attribute value. This attribute is used to store the original
Converter Rated Voltage value for subsequent upload.
This floating point value represents the internal bus capacitance of the
regenerative converter and is used to compute the System Capacitance
scaling attribute. This attribute is used to store the original Converter
DC Bus Capacitance value for subsequent upload.
This floating point value represents the power rating of the converter.
This attribute is used to estimate the default AC Line Source Power
value.
This floating point value represents the scaling factor, based on motor
type, which is used to set the factory default value for Torque Loop
Bandwidth. This attribute is used to store the original Current Loop
Bandwidth Scaling Factor value for subsequent upload.
This floating point value represents the RMS voltage rating of the drive
that is used to set the factory default value for the Break Voltage
associated with V/Hz drives. This attribute is used to store the original
Drive Rated Voltage value for subsequent upload.
See also
Auto-Tune Configuration Attributes on page 383
Motor Test Result Attributes on page 401
Hookup Test Result Attributes on page 392
Inertia Test Result Attributes on page 398
Converter Bus Voltage Control Configuration Attributes on page
644
Motion Dynamic These are the motion dynamic configuration attributes associated with
a Motion Control Axis.
Configuration Attributes
Maximum Speed
Usage Access Data Default Min Max Semantics of Values
Type
Required - Set/ REAL FD 0 maxspd Position Units / Sec
FPV SSV
See also
CIP Axis Attributes on page 243
Motion Control Axis Behavior Model on page 54
Motion Homing Use the Homing functionality to establish a machine reference position,
or Home Position for the associated axis. Homing configuration
Configuration Attributes attributes require associated position feedback devices. Homing cannot
be used with drives configured for Encoderless or Sensorless
operation.
This tables describe the motion homing configuration attributes for a
Motion Control Axis.
Home Mode
Usage Access Data Default Min Max Semantics of Values
Type
Required - E Set/SSV USINT 1 - - Enumeration
0 = Passive
1 = Active (C)
2-55 = Reserved
Home Direction
Usage Access Data Default Min Max Semantics of Values
Type
Required - E Set/SSV USINT 1 - - Enumeration
PV Only 0 = Unidirectional forward
1 = Bidirectional forward
2 = Unidirectional reverse
3 = Bidirectional reverse
4-255 = Reserved
Home Sequence
Usage Access Data Type Default Min Max Semantics of Values
Required - E Set/SSV USINT 0 - - Enumeration
0 = Immediate (default)
1 = Home to switch (O)
2 = Home to marker (O)
3 = Home to switch then
marker (O)
4 = Home to torque (O)
5 = Home to torque then
marker (O)
6 = Immediate Absolute (O)
7-255 = Reserved
Determines the motion sequencing used to trigger the desired homing events. Filtering of optional enumerations
based on available hardware support and feedback interface hardware. If the feedback type configured for an axis
does not support a marker signal, these homing sequences cannot be used:
• 2 = Home to marker (O)
• 3 = Home to switch then marker (O)
• 5 = Home to torque then marker (O)
Filtering of optional enumerations may be required based on available
hardware support and feedback interface hardware.
If the controller detects that the state of the home switch at the start of the homing sequence is
active, the controller immediately reverses the homing direction and begins the return leg of the
homing sequence.
Neglecting the mechanical uncertainty of the home limit switch, the accuracy of this homing
sequence depends on the time uncertainty in detecting the home limit switch transitions. The
position uncertainty of the home position is the product of the maximum time for the control to
detect the home limit switch (~10 milliseconds) and the specified Home Return Speed. For this
reason, the Home Return Speed is often made significantly slower than the Home Speed.
For example, if a Home Return Speed of 0.1 inches per second (6 IPM) is specified, the uncertainty of
the home position is calculated as shown below:
Uncertainty = 0.1 Inch/Sec * 0.01 Sec = 0.001 Inch.
The accuracy of this homing sequence depends only on the time delay in detecting the marker
transition. The position uncertainty of the home position is the product of the maximum delay for
the control to detect the marker pulse (~1 microsecond) and the specified Home Speed.
For example, if a Home Speed of 1 inches per second (60 IPM) is specified, the uncertainty of the
home position is calculated as shown below:
Uncertainty = 1 Inch/Sec * 0.000001 Sec = 0.000001 Inch.
If the controller detects that the state of the home switch at the start of the homing sequence is
active, the controller immediately reverses the homing direction and begins the return leg of the
homing sequence.
Active Unidirectional Home to This active homing sequence is useful for single turn rotary and linear encoder applications when
Marker unidirectional motion is required.
When this sequence is performed in the Active Homing Mode, the axis moves in the specified Home
Direction at the specified Home Speed and Home Acceleration until the marker is detected. If the
Home Offset is zero, the Home Position is assigned to the axis position at the moment that the
marker is detected and the axis decelerates to a stop at the specified Home Deceleration.
If Home Offset is non-zero, then the Home Position will be offset from the point where the marker
was detected by this value. The controller then continues to move the axis to the Home Position at
the specified Home Speed and Home Acceleration using a trapezoidal move profile.
The axis position is updated based on the Home Position and Home Offset. Even if the Home Offset is
zero, the position is updated. Zero is a valid number.
By setting a Home Offset greater than the deceleration distance, unidirectional motion to the Home
Position is insured. However, if the Home Offset value is less than the deceleration distance, then the
axis is simply decelerated to a stop at the specified Home Deceleration. The axis does not reverse
direction to move to the Home Position. In this case, the PC-bit leg of the associated MAH instruction
is not set when the IP-bit leg is cleared.
In the case where this homing sequence is performed on a cyclic axis and the Home Offset value is
less than the deceleration distance when the home event is detected, the control automatically adds
one or more revolutions to the move distance. This guarantees the resulting move to the Home
Position is unidirectional.
Passive Immediate Home This is the simplest passive homing sequence type. When this sequence is performed, the controller
immediately assigns the Home Position to the current axis actual position. This homing sequence
produces no axis motion.
Passive Immediate Absolute During this sequence, the drive redefines the actual position and command position to the current
Homing position of the absolute feedback device. If non-zero the Home Offset applies to the current
command and actual position:
Current Position = Absolute Feedback Position - Home Offset.
Tip: The Servo On does not execute during the Passive Immediate Absolute sequence.
Passive Home with Switch This passive homing sequence is useful when an encoder marker is not available or a proximity
switch is being used.
When this sequence is performed in the Passive Homing Mode, an external agent moves the axis
until the home switch is detected. The Home Position is assigned to the axis position at the moment
that the limit switch is detected. If Home Offset is non-zero, then the Home Position will be offset
from the point where the switch is detected by this value.
Passive Home with Marker This passive homing sequence is useful for single turn rotary and linear encoder applications.
When this sequence is performed in the Passive Homing Mode, an external agent moves the axis
until the marker is detected. The home position is assigned to the axis position at the precise
position where the marker was detected. If Home Offset is non-zero, then the Home Position will be
offset from the point where the switch is detected by this value.
Home Position
Usage Access Data Type Default Min Max Semantics of Values
Required - E Set/SSV REAL 0 - maxpos Position Units
maxpo
s
Home Offset
Usage Access Data Type Default Min Max Semantics of Values
Home Speed
Usage Access Data Type Default Min Max Semantics of Values
The Home Speed attribute controls the speed of the jog profile used in
the first leg of an active homing sequence as described in the above
discussion of the Home Sequence Type attribute.
This is not valid for immediate or immediate absolute Home Sequence.
The Home Return Speed attribute controls the speed of the jog profile
used after the first leg of an active bidirectional homing sequence as
described in the above discussion of the Home Sequence Type
attribute.
This is not valid for immediate or immediate absolute Home Sequence.
Home Acceleration
Usage Access Data Type Default Min Max Semantics of Values
Optional - E Set/SSV REAL 0 0 maxacc Position Units / Sec2
PV Only
Home Deceleration
Usage Access Data Default Min Max Semantics of Values
Type
Optional - E Set/ REAL 0 0 maxacc Position Units / Sec2
PV Only SSV
The Home Torque limit attribute is the value temporarily applied by the
controller to Torque Limit Positive and Torque Limit Negative in the
drive during an active Home to Torque sequence.
This is only valid for Home to Torque or Home to Torque then Marker
Home Sequence.
The Home Torque Threshold attribute sets the minimum torque level
needed to detect the hard stop during a Home to Torque sequence. The
drive’s output torque must exceed the specified Home Torque
Threshold for the specified Home Torque Time. The units for Home
Torque Threshold are expressed as a percentage of the operative
Torque Limit, which during the homing sequence is set to the Home
Torque Limit by the controller.
This is only valid for Home to Torque or Home to Torque then Marker
Home Sequence.
See also
Motion Control Configuration Attributes on page 473
Motion Planner These are the motion planner attributes associated with a Motion
Control Axis.
Configuration Attributes
Output Cam Execution Targets
Usage Access Data Default Min Max Semantics of Values
Type
Required - E Get/ DINT 0 0 8 # of Targets
GSV1 Represents the number of Output
Cam nodes attached to this axis.
1
This attribute can be set only when the axis instance is created.
The Output Cam Execution Targets attribute is used to specify the
number of Output Cam nodes attached to the axis. This attribute can
only be set as part of an axis create service and dictates how many
Output Cam Nodes are created and associated to that axis. Each
Output Cam Execution Target requires approximately 5.4k bytes of data
table memory to store persistent data. With four Output Cam Execution
Targets per axis, an additional 21.6k bytes of memory is required for
each axis.
The ability to configure the number of Output Cam Execution Targets
for a specific axis reduces the memory required per axis for users who
do not need Output Cam functionality, or only need 1 or 2 Output Cam
Execution Targets for a specific axis. Each axis can be configured
differently.
This attribute controls the master axis input signal feeding the gearing
and camming functions of the motion planner, including the Master
Position Filter and Master Delay Compensation.
The Soft Travel Limit - Positive attribute sets the maximum positive
travel limit for actual position when Soft Travel Limit Checking is
enabled. If this value is exceeded while commanding motion in the
positive direction, a Soft Travel Limit - Positive exception is generated.
The Soft Travel Limit - Negative attribute sets the maximum negative
travel limit for actual position when Soft Travel Limit Checking is
enabled. If this value is exceeded while commanding motion in the
negative direction, a Soft Travel Limit - Negative exception is generated.
This attribute provides configurable software travel limits through the
Soft Travel Limit - Positive and Soft Travel Limit - Negative attributes. If
the axis is configured for Soft Travel Limit Checking, and the axis
passes outside these travel limits, a Software Travel Limit exception
condition occurs. In the case of a controlled axis, when the axis is
outside the travel limits and no motion is being commanded or motion is
being commanded to bring the axis back within the soft travel range, the
Soft Travel Limit exception is NOT generated. This facilitates recovery
from an existing Soft Travel Limit condition. In this case, a Fault Reset
can be executed to clear the fault, allowing the axis to be enabled, and
then simply commanded back inside the travel limits. For an
uncontrolled axis, such as Feedback Only axis, a Soft Travel Limit
exception is always generated when the axis is outside the travel limits.
In this case the axis must be moved back inside the Travel Limits by
some other means. Any attempt to clear the Travel Limit fault in the
uncontrolled axis case while outside the travel limits results in an
immediate re-issue of the Soft Travel Limit exception.
When Soft Travel Limit Checking is enabled, appropriate values for the
maximum travel in both the Soft Travel Limit Positive and Soft Travel
Limit Negative attributes need to be established with Soft Travel Limit -
Positive value always greater than Soft Travel Limit - Negative value.
Both of these values are specified in the configured Position Units of the
axis.
The Move Repeat Mode attribute controls the repeat functionality of the
MAM instruction.
The Move Repeat Dwell attribute controls the amount of time between
successive move profiles initiated by an MAM instruction in Repeat
Mode.
The Track Mover Length is a floating point value that specifies the
length of the linear track mover. Track Mover Length allows the user to
confirm the proper length of the mover. This value may have future
application for a motion planner-based collision avoidance feature.
See also
Motion Control Status Attributes on page 498
Absolute Position Recovery on page 47
Motion Planner Output These are the motion planner output attributes associated with a Motion
Control Axis.
Attributes
See also
Motion Planner Configuration Attributes on page 527
Motion Scaling Attributes These are the basic motion scaling configuration attributes associated
with a Motion Control Axis. These attributes are involved in conversion
between position, speed, and acceleration expressed in Motion Counts
and Motion Units, and the user-defined Position Unit of the axis. The
motion scaling function is also involved in conversion of Motion Counts
to/from Feedback Counts, and Motion Units to/from Feedback Units.
Scaling Source
Usage Access Data Type Default Min Max Semantics of Values
Required - All Set/ SSV# USINT 0 - - Enumeration:
0 = From Calculator
1 = Direct Scaling Factor Entry
2-255 = reserved
# Indicates the attribute cannot be set while the tracking command (Tracking Command bit in CIP Axis
Status is true).
Travel Mode
Usage Access Data Type Default Min Max Semantics of Values
Required - All Set/ SSV# USINT 0 - - Enumeration:
0 = Unlimited
1 = Limited (E)
2 = Cyclic (E)
3-255 = reserved
# Indicates the attribute cannot be set while the tracking command (Tracking Command bit in CIP Axis Status
is true).
Travel Range
Usage Access Data Type Default Min Max Semantics of Values
Required - E Set/ GSV REAL 1 0+ Position Units
Motion Unit
Usage Access Data Type Default Min Max Semantics of Values
Required - All Set/ GSV USINT 0 - - Enumeration
0 = Motor Rev
1 = Load Rev
2 = Feedback Rev
3 = Motor mm
4 = Load mm
5 = Feedback mm
6 = Motor inch
7 = Load inch
8 = Feedback inch
9 = Motor Rev/s
10 = Load Rev/s
11 = Motor m/s
12 = Load m/s
13 = Motor inch/s
14 = Load inch/s
15-255 = Reserved
Motion Resolution
Usage Access Data Type Default Min Max Semantics of Values
Required - All Set/ SSV# DINT Default 1 231-1 Motion Counts / Motion Unit
Motion
Resolution
The Default Motion Resolution value used for scaling factors, Motion
Resolution, Conversion Constant, and Position Unwind, depends on the
Motion Unit selection according to the following table:
Motion Unit Default Motion Resolution
Motor|Load|Feedback Rev 1,000,000
Motor|Load|Feedback mm 10,000
Motor|Load|Feedback Inch 200,000
Motor|Load|Feedback Rev/s 1,000,000
Motor|Load|Feedback m/s 10,000,000
Motor|Load|Feedback Inch/s 200,000
Fractional Unwind
In some cases, however, you may also want to specifically configure
Motion Resolution value to handle fractional unwind applications or
Motion Polarity
Usage Access Data Default Min Max Semantics of Values
Type
Required - All Set/ SSV# USINT 0 0 1 Enumeration:
0 = Normal Polarity
1 = Inverted Polarity
2-255 = (Reserved)
# Indicates the attribute cannot be set while the tracking command (Tracking Command bit in CIP Axis
Status is true).
Use Motion Polarity to switch the directional sense of the motion control
system. A Normal setting leaves the sign of the motion control
command and actual signal values unchanged from their values in the
drive control structure. An Inverted setting flips the sign of the command
signal values to the drive control structure and flips the sign of the
actual signal values coming from the drive control structure. Also use
Motion Polarity to adjust the sense of the positive direction of the motion
control system to agree with the positive direction on the machine.
When this Boolean attribute is set true (1), it enables the cyclic unwind
capability of the scaling function. This feature provides infinite
positioning range by “unwinding” the axis position whenever the axis
moves through a complete machine cycle. The number of Motion
Counts per machine cycle of the axis is specified by the Cyclic Unwind
Position attribute. Thus, if the axis is configured for Cyclic Operation,
implementation of the Cyclic Unwind Position attribute is required.
If the Cyclic Unwind attribute is false (0), indicating non-cyclic operation,
no “unwind” operation is performed, and unidirectional motion continues
to accumulate position and can eventually exceed the range of the
position representation resulting in a roll-over. For this reason, non-
cyclic travel is typically limited for position control applications.
When the Motion Scaling Configuration is set to Drive Scaling, the CIP
Motion Connection interface and the drive control structure performs the
Motion Polarity. When the Motion Scaling Configuration is set to
Controller Scaling, the controller performs the Motion Polarity inversion.
To maintain directional consistency, the signs of all Signal Attribute
values read from the drive control structure or being written to the drive
control structure are determined by Motion Polarity. A comprehensive
list of Signal Attributes and their access rules is defined in the following
table:
ID Access Rule Signal Attribute Name
1402+o Get Feedback n Position
1403+o Get Feedback n Velocity
1404+o Get Feedback n Acceleration
2380+o Get Feedback nU Position
2381+o Get Feedback nU Velocity
2382+o Get Feedback nU Acceleration
2383+o Get Feedback nS Position
2384+o Get Feedback nS Velocity
2385+o Get Feedback nS Acceleration
62 Get Registration 1 Positive Edge Position
63 Get Registration 1 Negative Edge Position
64 Get Registration 2 Positive Edge Position
65 Get Registration 2 Negative Edge Position
70 Get Home Event Position
360 Set* Controller Position Command - Integer
361 Set* Controller Position Command - Float
362 Set* Controller Velocity Command
363 Set* Controller Acceleration Command
364 Set* Controller Torque Command
365 Get Fine Command Position
Position Units
Usage Access Data Type Default Min Max Semantics of Values
Required - All Set STRING "Position - - "Revs"
Units"
This attribute determines the period of time over which the system
computes Average Velocity for this axis instance.
Range limits based on coarse update period and history array size are
ultimately enforced for Average Velocity Timebase attribute by clamping
to limit rather than generating a value out of range error. Only if the
value is outside the fixed Min/Max limits is an out of range error given.
Conversion Constant
Usage Access Data Default Min Max Semantics of Values
Type
Required - All Set/ REAL Default 10-12 1012 Counts/Position Unit
SSV# Motion
Resolution
# Indicates the attribute cannot be set while the tracking command (Tracking Command bit in CIP Axis
Status is true).
Position Unwind
Usage Access Data Default Min Max Semantics of Values
Type
Required - E Set/ DINT Default 1 109 Counts/Cycle
SSV# Motion
Resolution
# Indicates the attribute cannot be set while the tracking command (Tracking Command bit in CIP Axis
Status is true).
If the axis is configured for cyclic Travel Mode, a value for the Position
Unwind attribute is required. This is the value used to perform electronic
unwind of the cyclic axis' position. Electronic unwind operation provides
infinite position range for cyclic axes by subtracting the position unwind
value from both the actual and command position every time the axis
completes a machine cycle. To avoid accumulated error due to round-
off with irrational conversion constants, the unwind value is expressed
as an integer number of feedback counts per cycle.
See also
Motion Resolution Value Examples on page 546
Motion Resolution Value Motion Resolution is one of the Motion Scaling attributes. These
examples demonstrate how the Motion Resolution value may be used
Examples together with the Conversion Constant to handle various machine
applications.
See also
Motion Scaling Attributes on page 535
Motor Attributes These are the motor configuration attributes associated with a Motion
Control Axis that apply to various motor technologies. These motor
technologies include three-phase motor rotary, linear, permanent
magnet and induction motors. Motor attributes are organized according
to the various motor types.
See also
General Linear Motor Attributes on page 548
General Motor Attributes on page 556
General Permanent Magnet Motor Attributes on page 556
Induction Motor Attributes on page 561
Linear PM Motor Attributes on page 563
General Linear Motor These are the motor configuration attributes that apply specifically to
linear motor types.
Attributes
Linear Motor Pole Pitch
Usage Access Data Default Min Max Semantics of Values
Type
Required Set REAL 50 0 Meters
DB
The Linear Motor Pole Pitch attribute is a floating point value that
specifies the pole pitch of a linear motor in units of meters, and is
equivalent to the electrical cycle length.
The Linear Motor Rated Speed attribute is a floating point value that
specifies the nameplate rated speed of a linear motor. For PM motors,
this is generally specified at rated voltage based on either rated current,
rated force, or rated power. For induction motors this value is the speed
of the motor driven at rated frequency under rated force load. This value
is synonymous with the term base speed.
The Linear Motor Mass attribute is a floating point value that specifies
the unloaded moving mass of a linear motor.
The Linear Motor Max Speed attribute is a floating point value that
specifies the absolute maximum operating speed of a linear motor in
units of m/s. This speed may be determined by the limitations of the
motor, limitations of the drive power structure, or by limitations of the
mechanical system, whichever is less. Specifically, this value can
represent the maximum safe operating speed, maximum continuous no-
load speed, maximum continuous encoder speed, or maximum
continuous bearing speed of the motor. This value can be used by the
drive to determine the Linear Motor Overspeed Factory Limit.
See also
General Motor Attributes on page 550
General Permanent Magnet Motor Attributes on page 556
Induction Motor Attributes on page 561
Linear PM Motor Attributes on page 563
General Motor Attributes These are the general motor attributes that apply to all motor
technologies.
The Motor Data Source attribute specifies the source of motor data for
the drive.
• Datasheet implies that the motor configuration attributes are
entered by the user from a motor datasheet or from motor
nameplate data.
• Database means that configuration software pulls the motor data
from a motor database based on catalog number during the drive
configuration process.
• Drive NV implies that the motor attributes are derived directly
from the drive's nonvolatile memory. In this mode, only a minimal
set of motor and motor feedback (Feedback 1) are required to
configure the drive.
• Motor NV implies that the motor attributes are derived from non-
volatile memory of a motor-mounted smart feedback device
equipped with a serial interface. Again, in this mode, only a
minimal set of motor and motor feedback (Feedback 1) are
required to configure the drive.
In both Drive NV and Motor NV cases, the specific motor and motor
feedback attributes that are sent or not sent to the drive during
configuration are identified in the CIP Drive Set Attr Update Bits
attribute table.
Motor and motor feedback attributes sent to the drive device in Drive
NV or Motor NV are merely to confirm that the controller and the drive
have the agreement on the values of attributes critical to scaling
operation. If the NV attribute values in the drive differ from the values
set by the controller, the drive will reject the values with General Status
indicating an Invalid Attribute Value. The current list of motor and motor
feedback attributes sent to the drive in the NV modes are as follows:
1. Motor Unit
2. Feedback 1 Unit
3. Feedback 1 Type
4. Feedback 1 Startup Method
5. Feedback 1 Cycle Resolution
6. Feedback 1 Cycle Interpolation
7. Feedback 1 Turns
DB
Motor Type
Usage Access Data Type Default Min Max Semantics of Values
Required Set/GSV USINT 0 - - Enumeration:
DB 0 = Not Specified (R)
1 = Rotary Permanent Magnet
(O)
2 = Rotary Induction (O)
3 = Linear Permanent Magnet
(O)
4 = Linear Induction (O)
5 = Rotary Interior Permanent
Magnet (O)
6-127 = (reserved)
128-255 = (vendor specific)
Motor Unit
Usage Access Data Type Default Min Max Semantics of Values
Motor Polarity
Usage Access Data Type Default Min Max Semantics of Values
Optional Set/SSV* USINT 0 - - Enumeration
DB 0 = Normal Polarity
1 = Inverted Polarity
2-255 = Reserved
* Indicates the attribute cannot be set while the drive power structure is enabled (Power Structure Enable bit in
CIP Axis Status is true).
The Motor Rated Voltage attribute is a floating point value that specifies
the nameplate AC voltage rating of the motor. This represents the
phase-to-phase voltage applied to the motor to reach rated speed at full
load.
The Motor Rated Peak Current attribute is a floating point value that
specifies the peak or intermittent current rating of the motor. The peak
current rating of the motor is often determined by either the thermal
constraints of the stator winding or the saturation limits of PM motor
magnetic material.
The Motor Rated Output Power attribute is a floating point value that
specifies the nameplate rated output power rating of the motor. This
represents the power output of motor under full load conditions at rated
current, speed and voltage.
The Motor Integral Thermal Switch attribute specifies if the motor has
an integral thermal switch to detect a Motor Overtemperature condition.
Connection to the motor thermal switch can be through the motor
feedback interface, associated with Axis I/O Status bit, Feedback 1
Thermostat, or through a discrete digital input to the drive, associated
with Axis I/O Status bit, Motor Thermostat. The method of interface to
the thermal switch is left to the drive vendor's discretion.
See also
Motor Attributes on page 60
Induction Motor Attributes on page 561
Linear PM Motor Attributes on page 563
Load Transmission and Actuator Attributes on page 568
Rotary PM Motor Attributes on page 570
General Permanent Magnet These are the motor configuration attributes that apply to Permanent
Magnet motor types in general.
Motor Attributes
PM Motor Resistance
Usage Access Data Type Default Min Max Semantics of Values
Required (SPM, Set/SSV* REAL 0 0 Ohms
IPM and DB
LTS Only)
* Indicates the attribute cannot be set while the drive power structure is enabled (Power Structure Enable bit
in CIP Axis Status is true).
PM Motor Inductance
Usage Access Data Type Default Min Max Semantics of Values
Required Set/SSV* REAL 0 0 Henries
(SPM and LTS DB
Only)
* Indicates the attribute cannot be set while the drive power structure is enabled (Power Structure Enable bit
in CIP Axis Status is true).
PM Motor Lq Inductance
Usage Access Data Type Default Min Max Semantics of Values
Required Set/SSV* REAL 0 0 Henries
(IPM Only) DB
* Indicates the attribute cannot be set while the drive power structure is enabled (Power Structure Enable bit
in CIP Axis Status is true).
PM Motor Ld Inductance
Usage Access Data Type Default Min Max Semantics of Values
Required Set/SSV* REAL 0 0 Henries
(IPM Only) DB
* Indicates the attribute cannot be set while the drive power structure is enabled (Power Structure Enable bit
in CIP Axis Status is true).
See also
General Motor Attributes on page 550
Induction Motor Attributes on page 561
Linear PM Motor Attributes on page 563
Motor Attributes Model on page 60
Rotary PM Motor Attributes on page 570
General Rotary Motor These are the motor configuration attributes that apply specifically to
rotary motor types.
Attributes
Rotary Motor Poles
Usage Access Data Default Min Max Semantics of Values
Type
Required Set/GSV UINT PM: 8 2 max int
IM: 4
DB
The Rotary Motor Poles attribute is an integer that specifies the number
of poles per revolution for rotary motors. This value is always an even
number, as poles always exist in pairs.
The Rotary Motor Inertia attribute is a floating point value that specifies
the unloaded inertia of a rotary motor.
The Rotary Motor Rated Speed attribute is a floating point value that
specifies the nameplate rated speed of a rotary motor. For PM motors,
this is generally specified at rated voltage based on either rated current,
rated torque, or rated power. For induction motors this value is the
speed of the motor driven at rated frequency under rated torque load.
This value is synonymous with the term base speed.
The Rotary Motor Max Speed attribute is a floating point value that
specifies the absolute maximum operating speed of a rotary motor in
units of RPM. This speed may be determined by the limitations of the
motor, limitations of the drive power structure, or by limitations of the
mechanical system, whichever is less. Specifically, this value can
represent the maximum safe operating speed, maximum continuous no-
load speed, maximum encoder speed, maximum continuous motor
bearing speed, or maximum motor speed based on the drive power
structure voltage limit. This value can be used by the drive to determine
the Rotary Motor Overspeed Factory Limit.
The Rotary Motor Fan Cooling Speed attribute selects the output speed
of the motor below which the motor thermal protection method reduces
the threshold used to detect an overload condition due to the reduced
effectiveness of an integral fan cooling system. A value of zero disables
The Rotary Motor Fan Cooling Derating attribute selects the % derating
of the motor overload detection threshold when the motor is operating at
a speed below the specified Rotary Motor Fan Cooling Speed. The
attribute value indicates the level of derating of the overload detection
threshold at 0 speed as a percentage of rated continuous motor current.
The derating profile between the Rotary Motor Fan Cooling Speed and
zero speed is device dependent. This attribute is only applicable when
using the I2T motor thermal protection method.
See also
General Motor Attributes on page 550
General Permanent Magnet Motor Attributes on page 556
General Linear Motor Attributes on page 548
Rotary PM Motor Attributes on page 570
Induction Motor Attributes These are the motor configuration attributes that apply specifically to
induction motor types.
The Induction Motor Rated Slip Speed attribute represents the amount
of slip at motor rated current (full load) and motor rated frequency.
See also
General Motor Attributes on page 550
General Permanent Magnet Motor Attributes on page 556
Linear PM Motor Attributes on page 563
Motor Attributes on page 60
Rotary PM Motor Attributes on page 570
Linear PM Motor Attributes These are the motor configuration attributes that apply specifically to
linear PM motor types.
See also
General Permanent Magnet Motor Attributes on page 556
General Rotary Motor Attributes on page 559
General Linear Motor Attributes on page 548
Induction Motor Attributes on page 561
Velocity Loop Signal Attributes on page 325
Interior Permanent Magnet The following attribute tables list the motor configuration attributes that
apply only to Interior Permanent Magnet (IPM) motor types.
Motor Attributes
An array of floating point values that specify the amount of d-axis flux
saturation in the motor at rate current. The units for d-axis flux
saturation values are percent of Nominal Inductance, such that a value
of 100% means no saturation, and 90% means the inductance is 90%
of its value at zero current given by the PM Motor Ld Inductance
attribute. The PM Motor Ld Flux Saturation value specifies the d-axis
flux saturation at 100% of the Continuous Current Rating.
An array of floating point values that specify the amount of d-axis flux
saturation in the motor at rate current. The units for d-axis flux
saturation values are percent of Nominal Inductance, such that a value
of 100% means no saturation, and 90% means the inductance is 90%
of its value at zero current given by the PM Motor Ld Inductance
attribute. The PM Motor Ld Flux Saturation value specifies the d-axis
flux saturation at 100% of the Continuous Current Rating.
This floating point value represents the maximum speed of the motor as
determined by the Motor Test procedure.
See also
Interpret the Attribute Tables on page 89
Motion Control Configuration Attributes on page 473
Load Transmission and These are the motor configuration attributes that apply specifically to
rotary transmission and linear actuator mechanisms associated with the
Actuator Attributes axis.
Load Type
Usage Access Data Type Default Min Max Semantics of Values
Optional - Scaling Set USINT 0 - - Enumeration
Optional - DB 0 = Direct Rotary
Planning 1 = Direct Linear
2 = Rotary Transmission
3 = Linear Actuator
4-255 = Reserved
Actuator Type
Usage Access Data Default Min Max Semantics of Values
Type
Optional - Scaling Set USINT 0 - - Enumeration
Optional - DB 0 = None (R)
Planning 1 = Screw (O)
2 = Belt and Pulley (O)
3 = Chain and Sprocket (O)
4 = Rack & Pinion (O)
5-255 = Reserved
The Actuator Type attribute indicates the type of mechanism used for
linear actuation.
Actuator Lead
Usage Access Data Default Min Max Semantics of Values
Type
Optional - Scaling Set REAL 1 0+ Actuator Lead Units
Optional - Planner DB
NP Only
The Actuator Lead attribute is a floating point value that represents the
lead or pitch of a screw actuator that is a measure of the linear
movement of the screw mechanism per revolution of the screw shaft.
The Actuator Lead Unit attribute indicates the units of the Actuator Lead
attribute.
Actuator Diameter
Usage Access Data Default Min Max Semantics of Values
Type
Optional - Scaling Set REAL 1 0+ Actuator Diameter Units
Optional - Planner
The Actuator Diameter Unit attribute is a value that indicates the units of
the Actuator Diameter attribute.
See also
Motor Attributes on page 60
General Motor Attributes on page 550
General Permanent Magnet Motor Attributes on page 556
General Rotary Motor Attributes on page 559
General Linear Motor Attributes on page 548
Rotary PM Motor Attributes These are the motor configuration attributes that apply specifically to
rotary motor types.
This value corresponds to the rotary motor speed at which the back-
EMF of the motor equals the maximum operational bus voltage of the
drive. When the extended speed range of a PM motor is not permitted,
this value can be used to limit motor speed to protect the drive from
damage caused from bus overvoltage conditions that occur when
disabling a PM motor at high speed.
When configured for Position Loop or Velocity Loop operation, this bus
overvoltage protection includes limiting the magnitude of the velocity
reference value allowed into the velocity summing junction to the Bus
Overvoltage Speed Limit value using the velocity limiter function. If the
signal entering the velocity limiter exceeds this velocity limit value, and
the PM Motor Extended Speed Permissive is False, the velocity limiter
See also
General Motor Attributes on page 550
General Permanent Magnet Motor Attributes on page 556
General Rotary Motor Attributes on page 559
Motor Attributes Model on page 60
Velocity Loop Signal Attributes on page 325
Safety Attributes The following attributes tables contains attributes associated with safety
functionality.
Axis Safety attributes are used with integrated CIP Safety functionality
associated with a Motion Device Axis Object instance included in a CIP
Motion Safety Drive. These attributes reflect the current state of an
embedded Safety Core within for a CIP Motion Safety Drive device that
is designed to interoperate with an external Safety Controller using a
CIP Safety network connection. For this reason, integrated safety
functions are also referred to as "networked safety".
Guard Safety attributes are used with built-in Safety functionality
associated with a Motion Device Axis Object instance. These built-in
safety attributes relate to the behavior of a configurable Safety Core
(SMSC) within the drive that executes basic drive safety functions using
hardwired safety inputs and safety outputs without the services of a CIP
Safety network connection.
Axis Safety Status The following attribute tables contains axis attributes used with the
integrated Safety functionality associated with a Motion Device Axis
Attributes Object instance included in a CIP Motion Safety Drive. These attributes
reflect the current state of an embedded Safety Core within for a CIP
Motion Safety Drive device that is designed to interoperate with an
external Safety Controller using a CIP Safety connection.
In the Logix Integrated Architecture, many of the safety functions can be
executed either in the drive or in the associated safety controller. A
unique feature of the architecture is that regardless of where the safety
function is executed, the Axis Safety Status and Axis Safety Fault
information reported by these safety functions is the same. This is
achieved by the Safety Status Pass Thru feature where safety functions
executing in the safety controller transmit their fault and status
information to the drive via the Safety Output Assembly where this
information is combined with the fault and status information of safety
function executing in the Safety Core of the drive. The combined safety
function fault and status data is then "Passed Thru" to the associated
Motion Device Axis Object instance attributes.
The following table identifies the supported safety functions:
Short Name Full Name Control Drive Description
STO Safe Torque Off No Yes Disables associated drive power
structure.
SBC Safe Brake Control Yes No Engages safety brake.
SS1 Safe Stop 1 Yes Yes Monitors Category 1 Stop followed by STO.
SS2 Safe Stop 2 Yes No Monitors Category 2 Stop followed by SOS.
SOS Safe Operating Stop Yes No Monitor standstill condition for
movement.
SMT Safe Motor No No Monitor motor temperature for
Temperature overtemperature.
SLT Safely-limited Torque No Yes Prevents the motor from exceeding the
specified torque limit.
SLA Safely-limited No No Monitor acceleration exceeding
Acceleration configured limit.
The Axis Safety State, Axis Safety Status, and Axis Safety Fault
attributes defined below are based on the values read from attributes
resident in objects associated with the Safety Core and are used by the
motion control system to monitor the behavior of the Safety Core via the
CIP Motion connection.
The Axis Safety Faults - Mfg attribute is a collection of bits indicating the
safety fault status of the axis associated with manufacturer specific
safety functionality as reported by the embedded Safety Core of the
device. When a safety fault condition occurs, the Safety Core forces the
axis into a Safe State and, if the Safety Fault Action is set to Major Fault
or Minor Fault, the corresponding bit is set in the Axis Safety Faults Mfg
attribute. An active axis safety fault bit remains latched even if the
underlying safety fault condition is cleared by the Safety Core. A Fault
Reset Request to the associated axis clears the axis safety fault bits,
but the bits immediately set again if the underlying safety fault
conditions are still present.
When the drive detects a Safe Torque Off (STO) Active condition that
was not initiated by a Safe Stop 1 (SS1) Active condition, as reported by
the embedded Safety Core through the Axis Safety Status attribute, and
The Safe Torque Off Action Source attribute determines whether the
drive or the controller initiates the stopping sequence in response a
STO Active condition in the Axis Safety Status attribute that was not
initiated by an SS1 or Safe Stop 2 (SS2) Active condition.
When configured for Connected Drive (default), the drive will initiate the
stopping sequence according to the selected Safe Torque Off Action.
However, the drive must have an open connection to the controller for
the configured stopping action to occur. If the drive is not connected, the
drive would have already initiated the configured Connection Loss
Stopping Action.
When configured for Running Controller, the stopping sequence is
initiated by the connected controller as long as the controller
connection's "Run/Idle" bit in the Real Time (RT) Header is indicating
Run Mode. This allows the controller to provide a programmed stopping
action. If the controller is in Idle Mode, i.e. not actively running the
application program, the connected drive will initiate the stopping
sequence according to the configured Safe Torque Off Action. This
selection is only valid if the connected controller is supplying the
"Run/Idle" Real Time header.
The Safe Stopping Action attribute determines the stopping method that
the drive applies to the motor when:
• An SS1 or SS2 condition occurs. The Axis Safety Status attribute
indicates an SS1 or SS2 condition.
• The Axis Safety Stopping Source is set to the Connected Drive.
The selected stopping method is applied while in the Stopping state and
the final state after the stopping method completes is the Stopped state.
In this final state the device's inverter power structure will either be
Disabled and free of torque, if initiated by an SS1 Active status bit, or
actively held (Hold selection) in a static condition if initiated by an SS2
Active status bit.
Safe Stopping Action Bit Descriptions
Bit Required/Opti Name Description
onal
0 R/C Current Decel Current Decel leaves the power structure and any
O/F active control loops enabled while stopping. If
configured for position control mode, the drive forces
the position reference to hold its current value until
the axis reaches zero speed. Once at zero speed the
position reference is immediately set equal to the
actual position to hold the axis at standstill. If in
velocity control mode, the drive forces the velocity
reference to zero. In either case, forcing the position
or velocity reference signals to a fixed value results
in a rapid increase in control loop error of the moving
axis that saturates the output current of the drive to
the configured Stopping Torque that brings the motor
to a stop. In torque control mode, the drive directly
applies the configured Stopping Torque to the torque
command signal to decelerate the motor. When the
velocity feedback value reaches zero speed, the
torque command is set to zero. In frequency control
mode the Current Vector Limit attribute, rather than
the Stopping Torque attribute, is used to regulate the
stopping current. Once stopped, or the configured
Stopping Time, or factory limit expires, the Current
Decel stopping action is complete.
# Indicates the attribute cannot be set while the tracking command (Tracking Command bit in CIP Axis
Status is true).
This attribute determines whether the drive or the controller initiates the
stopping sequence in response to an SS1 or SS2 Active bit transition in
the Axis Safety Status attribute.
When configured for Connected Drive (default), the drive will initiate the
stopping sequence according to the selected Safe Stopping Action.
However, the drive must have an open connection to the controller for
the configured stopping action to occur. If the drive is not connected, the
drive would have already initiated the configured Connection Loss
Stopping Action.
When configured for Running Controller, the stopping sequence is
initiated by the connected controller as long as the controller
connection's "Run/Idle" bit in the Real Time (RT) Header is indicating
Run Mode. This allows the controller to provide a programmed stopping
action. If the controller is in Idle Mode, i.e. not actively running the
application program, the connected drive will initiate the stopping
sequence according to the configured Safe Stopping Action. This
selection is only valid if the connected controller is supplying the
"Run/Idle" Real Time header.
A 32-bit container holding general purpose Safety Data passed from the
Safety Controller thru the Safety Pass Thru object attribute, Safety Pass
Thru Data A.
A 32-bit container holding general purpose Safety Data passed from the
Safety Controller thru the Safety Pass Thru object attribute, Safety Pass
Thru Data B.
See also
Guard Safety Attributes on page 587
Guard Safety Status Attributes on page 588
Axis Exception Action on page 411
Guard Safety Attributes These are the attributes associated with the built-in Safety functionality
of an axis. These attributes relate to the behavior of a configurable
Safety Core within the drive that executes basic drive safety functions
using hardwired safety inputs and safety outputs. These functions do
not require the services of a CIP Safety network connection. This safety
functionality covers the following safety functions as defined by IEC-
61800-5-2, EN-954-1, and IEC-60204 standards:
• Safe Restart
• Safe Stop
• Safe Limited Speed
• Safe Speed Monitoring
• Safe Maximum Speed
• Safe Direction Monitoring
• Safe Door Monitoring
• Safe Door Monitoring
The Guard Status and Guard Fault attributes are defined in the axis to
monitor the behavior of built-in Drive Safety functionality. The term
Guard is used for these status attributes to differentiate these attributes
from the Safety status attributes associated with the integrated Safety
functionality provided by a CIP Safety connection.
See also
Guard Safety Status Attributes on page 588
Guard Safety Status The Guard Status attribute is a collection of bits indicating the safety
status of the motion axis.
Attributes
Guard Status
Usage Access T Data Type Semantics of Values
3 Guard Stop Input Indicates the current state of the Safe Stop input.
4 Guard Stop Request Indicates if a safe stop operation has been requested. The
safe stop request can be initiated by the Safe Stop Input or in
response to a Safety Fault. The bit is only cleared by a
successful safety reset.
5 Guard Stop In Progress Indicates if the Safe Stop (SS) function of the safety core is in
progress. This bit is set when the Safe Stop input transitions
from on to off and clears at the end of the stop delay or when
a safety fault occurs.
6 Guard Stop Decel Indicates if the Safe Stop (SS) function of the safety core is
actively decelerating the axis. This bit is set after the
monitoring delay expires and clears at the end of the stop
delay or when a fault occurs.
7 Guard Stop Standstill Indicates if the Safe Stop (SS) function of the safety core is in
the safe stopped mode, for example, when it has successfully
stopped the axis and is performing zero speed monitoring.
This bit is set after the stop delay expires and clears when a
fault occurs.
8 Guard Stop Output Indicates the current state of the Safe Stop output.
9 Guard Limited Speed Input Indicates the current state of the Safe Limited Speed (SLS)
input.
10 Guard Limited Speed Request Indicates if a safe speed operation has been requested. The
safe stop request can be initiated by the Safe Limited Speed
input. The bit is only cleared by a successful safety reset.
11 Guard Limited Speed Monitor In Indicates if the Safe Speed (SLS/SSM) monitoring function of
Progress the safety core is actively checking speed. This bit is set when
the Safe Limited Speed input transitions from on to off and
the associated monitoring delay has expired.
12 Guard Limited Speed Output Indicates the current state of the Safe Limited Speed (SLS)
output.
13 Guard Max Speed Monitor In Indicates if the Safe Max Speed (SMS) monitoring function of
Progress the safety core is in progress.
14 Guard Max Accel Monitor In Indicates if the Safe Max Accel (SMA) monitoring function of
Progress the safety core is in progress.
15 Guard Direction Monitor In Indicates if the Safe Direction Monitoring (SDM) function of the
Progress safety core is in progress.
16 Guard Door Control Lock Indicates if the Door Control Output is being commanded to
the Locked state.
17 Guard Door Control Output Indicates the current state of the Safe Door Control output.
18 Guard Door Monitor Input Indicates the current state of the Door Monitor (DM) input.
19 Guard Door Monitor In Progress Indicates if the Safe Door Monitoring (DM) function of the
safety core is in progress.
20 Guard Lock Monitor Input Indicates the current state of the Safe Lock Monitoring input.
21 Guard Enabling Switch Input Indicates the current state of the Safe Enabling Switch Monitor
input.
22 Guard Enabling Switch Monitor In Indicates if the Safe Enabling Switch Monitor (ESM) monitoring
Progress function of the safety core is in progress.
23 Guard Reset Input Indicates the state of the Safety Reset input use to initiate
return to normal operational state of the safety core.
24 Guard Reset Required Indicates that the drive safety function requires a Safety
Reset to permit return to normal operational state.
25 Guard Stop Input Cycle Required Indicates that the drive safety function requires a Stop Input
Status Cycle to permit return to normal operational state.
26 Reserved (Waiting for Stop
Request Removal)
27-31 Reserved
Guard Faults
Usage Access T Data Type Semantics
1 Guard Internal Fault An internal fault has been detected by the Safety Core
hardware. This can includes safety processor faults,
inter-processor communications faults, safety power
supply faults, and gate drive circuitry.
3 Guard Gate Drive Fault Indicates that the Gate Drive (MP OUT) circuit used to
disable the drive power structure has detected an
error.
4 Guard Reset Fault The Safety Reset input was ON at power up.
5 Guard Feedback 1 Fault A problem has been detected with the feedback 1
device.
6 Guard Feedback 2 Fault A problem has been detected with the feedback 2
device.
7 Guard Feedback Speed Compare A speed miss-compare was detected between the two
Fault feedback devices.
8 Guard Feedback Position Compare A position discrepancy was detected between the two
Fault feedback devices.
9 Guard Stop Input Fault A fault has been detected on the Safe Stop input(s).
10 Guard Stop Output Fault A fault has been detected on the Safe Stop cascading
outputs.
11 Guard Stop Decel Fault A speed fault was detected during the deceleration
monitoring.
12 Guard Stop Standstill Fault Zero speed was not detected by the end of the stop
delay.
13 Guard Stop Motion Fault Motion was detected after stop was detected and the
door unlocked.
14 Guard Limited Speed Input Fault A fault has been detected on the Safe Limited Speed
input(s).
15 Guard Limited Speed Output Fault A fault has been detected on the Safe Limited Speed
outputs.
16 Guard Limited Speed Monitor Fault The Safe Limited Speed has been exceeded.
17 Guard Max Speed Monitor Fault The Safe Maximum Speed has been exceeded.
18 Guard Max Accel Monitor Fault The Safe Maximum Acceleration has been exceeded.
19 Guard Direction Monitor Fault Motion in the restricted direction has been detected.
20 Guard Door Monitor Input Fault A fault has been detected on the Door Monitoring
input(s).
21 Guard Door Monitor Fault The Door Monitoring inputs were detected as OFF when
they should have been ON.
22 Guard Door Control Output Fault A fault has been detected on the Door Control outputs.
23 Guard Lock Monitor Input Fault A fault has been detected on Lock Monitoring input(s).
24 Guard Lock Monitor Fault The Lock Monitoring Inputs were detected as OFF when
the Door should have been locked or the Lock
Monitoring Inputs were detected as ON when the Door
was opened.
25 Guard Enabling Switch Monitor Input A fault has been detected on the Enabling Switch
Fault Monitor (ESM) input(s).
26 Guard Enabling Switch Monitor Fault The Enabling Switch Monitor (ESM) Inputs were
detected as OFF when they should have been ON.
27 Guard Feedback 1 Voltage Monitor Monitored voltage level for the Feedback 1 device is out
Fault of allowed range for operation.
28 Guard Feedback 2 Voltage Monitor Monitored voltage level for the Feedback 2 device is
Fault out of allowed range for operation.
29 Reserved (RLM Reset Fault)
30...31 Reserved
See also
Guard Safety Attributes on page 587
Stopping and Braking These are the active stopping and braking related attributes associated
with a Motion Control Axis.
Attributes
Stopping Action
Usage Access Data Default Min Max Semantics of Values
Type
Required - XD Set/SSV# USINT Eq 23 - - Enumeration:
1 for C 0 = Disable & Coast
0 for F 1 = Current Decel & Disable
0 for X 2 = Ramped Decel & Disable
3 = Current Decel & Hold
4 = Ramped Decel & Hold
5-127 = (reserved)
128-255 = (vendor specific)
# Indicates the attribute cannot be set while the tracking command (Tracking Command bit in CIP Axis
Status is true).
# Indicates the attribute cannot be set while the tracking command (Tracking Command bit in CIP Axis
Status is true).
Stopping Torque
Usage Access Data Default Min Max Semantics of Values
Type
Required - C Set/SSV REAL 100 0 103 % Motor Rated
FD
Enable Sequence:
1. Switch to Starting state.
2. Activate Resistive Brake contactor to connect motor to inverter
power structure.
3. Wait for "Resistive Brake Contact Delay" while Resistive Brake
contacts close.
4. Enable inverter power structure.
5. (Optional) Perform Torque Proving operation to verify motor
control of load.
6. Activate Mechanical Brake output to release brake.
7. Wait for "Mechanical Brake Release Delay" while brake releases.
8. Transition to Running state.
Enable Sequence:
1. Switch to Starting state.
2. Activate Resistive Brake contactor to connect motor to inverter
power structure.
3. Wait for "Resistive Brake Contact Delay" while Resistive Brake
contacts close.
4. Enable inverter power structure.
5. (Optional) Perform Torque Proving operation to verify motor
control of load.
6. Activate Mechanical Brake output to release brake.
7. Wait for "Mechanical Brake Release Delay" while brake releases.
8. Transition to Running (or Testing) state.
Zero Speed
Usage Access Data Default Min Max Semantics of Values
Type
Optional - D Set/SSV REAL 1 0 % Motor Rated
FD
This attribute sets the speed threshold associated with the zero speed
criteria of the stop sequence. Zero Speed is specified as a percent of
motor rated speed. When Zero Speed Time attribute is supported, this
attribute sets the speed threshold where the zero speed timer starts.
When the axis speed has been below the Zero Speed threshold for
Zero Speed Time the axis has satisfied the zero speed criteria. In all but
Category 2 stops, this results in action to engage the mechanical brake.
If this attribute is not supported, the zero speed threshold is left to the
vendor’s discretion and typically set to 1% of motor rated speed. Axis
speed in the above description is based on the Velocity Feedback
signal, or in the case of a Frequency Control drive, axis speed is based
on Velocity Reference signal.
When supporting a Load Observer, the zero speed criteria is not based
on the Velocity Estimate since that signal can differ considerably from
the actual speed of the motor. When the Load Observer is configured to
apply the Velocity Estimate to the velocity loop summing junction as
Velocity Feedback, the zero speed criteria must be based on the
velocity feedback signal input to the Load Observer.
This attribute sets the amount of time that the axis speed must be below
the zero speed threshold, set by the Zero Speed attribute or established
by the drive vendor, before satisfying the zero speed criteria. In all but
Category 2 stops, when this attribute is set it results in action to engage
the mechanical brake. If this attribute is not supported, the amount of
time needed to satisfy the zero speed criteria is left to the vendor’s
discretion and typically is immediate (0). Axis speed in the above
description is based on the Velocity Feedback signal, or in the case of a
This enumerated value allows the drive to tailor motor control behavior
for vertical load applications. When the Enabled enumeration is
selected, the drive attempts, whenever possible, to avoid applying
Category 0 stop actions in response to Major Fault conditions. The drive
may tailor other aspects of its behavior to best handle vertical loads.
Proving Configuration
Usage Access Data Default Min Max Semantics of Values
Type
Optional - D Set/SSV USINT 0 - - Enumeration:
FD 0 = Disabled
1 = Enabled
2 - 255 = Reserved
This attribute enables the operation of the drive's Torque Proving and
Brake Proving functions that work in conjunction with mechanical brake
control. When Proving is enabled, the mechanical brake must be set as
soon as the drive is disabled. When the brake is under the control of the
axis state machine this is automatic. But when controlled externally,
failure to set the brake when the drive is disabled can cause a free fall
condition on a vertical application.
When enabled, the drive performs a Torque Prove test of the motor
current while in the Starting state to "prove" that current is properly
flowing through each of the motor phases before releasing the brake.
Should the Torque Prove test fail, a Motor Phase Loss exception is
generated.
While Torque Proving functionality is applicable to drive Control Modes
that are not capable of generating reliable holding torque based on a
feedback device, such as Frequency Control and Sensorless Velocity
Control, Torque Proving should not be used in these modes for
applications where holding torque is critical to safe operation, such as in
a typical lift or crane application.
Proving tests are performed when enabling or disabling the drive axis.
During these state transitions a series of operations are performed by
the drive to ensure the proper function of the motor (Torque Proving)
and the brake (Brake Proving).
This attribute sets the percent of motor rated torque applied to the motor
by the Torque Prove test as part of the Torque Proving function
executed in the Starting state. The Torque Prove test applies current to
the motor to "prove" that current is properly flowing through each of the
motor phases before releasing the brake.
This attribute sets the percent of motor rated torque applied to the motor
by the Brake Test as part of the Torque Proving function executed in the
Starting state. This Brake Test proactively tests the ability of the
mechanical brake to hold the maximum anticipated load before
releasing the brake and allowing operation. Should the Brake Test
detect brake slip, a Brake Slip exception is generated.
If the Brake Test Torque attribute value is 0 the Brake Test is not
performed in the Starting state.
This attribute determines the amount of time the drive will take to ramp
the applied torque of the motor down to zero during the Brake Proving
test in the Stopping or Aborting state. The Brake Prove Ramp Time
determines the ramp down rate of the applied torque output by dividing
This attribute determines the amount of brake slip allowed after the
brake is engaged. If this tolerance is exceeded while the brake is
engaged, a Brake Slip exception is generated. Brake slip can therefore
be monitored in any axis state where the brake is engaged.
The DC Injection Brake Current attribute defines the brake current level
injected into an induction motor stator when DC Injection Brake is
selected as the Stopping Action. This attribute is specified as a percent
of motor rated speed.
The DC Injection Brake Time attribute defines the amount of time that
the DC brake current is injected into an induction motor stator when DC
Injection Brake is selected as the Stopping Action. This attribute is
specified in seconds.
The Flux Braking Enable attribute value determines if the drive device is
to apply additional flux current to the induction motor in an effort to
increase motor losses and reduce the deceleration time while in the
This attribute is used to enable the optional Auto Sag feature that, in the
event of detected a brake slip condition, safely lowers the load to the
floor in a series of controlled Auto Sag Slip Increments. When a brake
slip condition is detected and Auto Sag is enabled, the drive not only
sets the standard Brake Slip exception, but the drive also sets the Brake
Malfunction start inhibit. This prevents the drive from restarting after the
load has been safely lowered to the floor.
This attribute sets the incremental amount of brake slip allowed by the
drive's optional Auto Sag function before restoring holding torque. When
brake slip occurs, the drive allows this amount of displacement and then
automatically enables the power structure and applies holding torque to
arrest the slip. The drive then ramps the motor torque to zero based on
the Brake Prove Ramp Time while checking for slip. Should brake slip
continue, the cycle repeats. In crane and lift applications, this repeating
"Auto Sag" cycle is designed to lower the load in a controlled series of
Auto Sag Slip Increments until the load reaches the ground.
This attribute sets the time limit over which the drive checks for brake
slip as performed by the Auto Sag function before restoring holding
torque. When brake slip occurs, the drive allows this amount of time
before automatically enabling the power structure and applying holding
torque. The drive then ramps the motor torque to zero based on the
Brake Prove Ramp Time while checking for slip. Generally, in a brake
slip situation, the Auto Sag Slip Time Limit expires when the load
See also
Stopping Sequences on page 606
Proving Operation Sequences on page 610
State Behavior on page 63
Motor Attributes on page 60
CIP Axis Attributes on page 243
Stopping Sequences There are three different stopping sequences defined for stopping and
braking related attributes. These three stopping sequences align with
the following IEC-60204-1 Stop Categories:
• Category 0 Stop: Drive immediately disables inverter power
structure.
• Category 1 Stop: Drive decelerates motor to a stop and then
disables power structure.
See also
Stopping and Braking Attributes on page 594
Proving Operational Proving tests are performed when enabling or disabling the drive axis.
During these state transitions a series of operations are performed by
Sequences the drive to ensure the proper function of the motor (Torque Proving)
and the brake (Brake Proving).
The following flow charts define these operational sequences in the
context of a drive enable transition and a drive disable or abort
transition.
See also
Stopping and Braking Attributes on page 594
Stopping Sequences on page 606
Start Inhibits Attributes These are the Start Inhibit related attributes associated with a Motion
Control Axis Object instance. Start Inhibits are conditions that prevent
transition of the axis from the Stopped State into any of the operational
states.
A bit map that specifies the current state of all standard conditions that
inhibits starting of the axis.
A bit map that specifies the current state of all Rockwell Automation
specific conditions that inhibits starting of the axis.
See also
Standard Start Inhibits on page 615
Rockwell Automation Specific Start Inhibits on page 616
CIP Axis Attributes on page 243
Standard Start Inhibits This table defines the list of standard start inhibits associated with the
Start Inhibits attribute.
Bit Inhibit Condition Description
0 -- Reserved -- This bit cannot be used since the Start Inhibit Code is defined by
the associated bit number and Start Inhibit Code of 0 means no
fault condition is present.
1 Axis Enable Input The Enable Input is not active.
2 Motor Not Configured The associated motor has not been configured for use.
3 Feedback Not Configured The associated feedback device has not been configured. The
offending feedback channel is encoded in the associated
Fault/Alarm Sub Code.
4 Commutation Not Configured The associated PM motor commutation function has not been
configured for use.
5 Safe Torque Off Active The integrated Safe Torque Off safety function is active based on
the Safe Torque Off Active bit (bit 3) of the Axis Safety Status
attribute being set.
6 Converter Bus Unload The Converter Bus Unload bit (bit 3) of the Control Status
attribute from the controller is set, indicating that the converter
supplying power to this drive axis has requested that it not draw
power from the DC Bus.
7-15 --Reserved--
This table maps the Standard Start Inhibit bits with their Logix Designer
Start Inhibit tag names. Start Inhibit bit names always end with an Inhibit
suffix.
Bit Tag
0 NA
1 AxisEnableInputInhibit
2 MotorNotConfiguredInhibit
3 FeedbackNotConfiguredInhibit
4 CommutationNotConfiguredInhibit
5 SafeTorqueOffActiveInhibit
6 ConverterBusUnload
See also
Start Inhibit Attributes on page 614
Rockwell Automation Specific Start Inhibits on page 616
Axis Safety Status Attributes on page 573
Rockwell Automation The following table defines a list of standard start inhibits associated
with the Start Inhibits attribute.
Specific Start Inhibits Bit Inhibit Condition Description
6 Safety Reset The safety reset input needs to be toggled before the safety board will
Required allow motion again.
7 Safety Not The embedded safety function of the drive has not been configured.
Configured
8 Stop Command There is an active Stop Command present. For example, the Stop button
Active on the drive is behind held active. This inhibit condition prevents the drive
from starting when the Stop Command is active.
9 Feedback Device The feedback device is being reset. A feedback device reset process is
Reset typically performed after a Feedback Loss condition. This inhibit condition
prevents the drive from Starting until the feedback reset process is
completed.
10 Brake Malfunction The start inhibit is set when the Auto Sag function is enabled, and the
brake slip is detected based on motor movement exceeding the
configured Brake Slip Tolerance while the mechanical brake is engaged.
This typically indicates that the mechanical brake may not be capable of
holding the load.
11 AC Line Contactor The start inhibit is set when state of the AC Line Contactor OK digital input
Input differs from the state of Contactor Enable Digital Output. When this start
inhibit is set it generally indicates that AC Line Contactor is not working
correctly and is not capable of charging the dc bus. This start inhibit is
checked only when a digital input is configured for the AC Line Contactor
OK function.
12 Track Section Not This start inhibit is set on a track cart or mover axis when the track
Enabled section axes associated with the current position of this cart or mover are
not in the Running state and therefore cannot apply force to this cart or
mover..
13 Track Mover Motor There is a track-wide mismatch in mover motor configuration.
Mismatch
14-15 --Reserved--
This table maps the Start Inhibit bits with their Logix Designer Start
Inhibit tag names. Start Inhibit bit names always end with an Inhibit
suffix.
Bit Tag
0 -
1 VoltsHertzCurveDefinitionInhibit
2 MotorFeedbackRequiredInhibit
3 SpeedLimitConfigurationInhibit
4 TorqueProveConfigurationInhibit
5 SafeTorqueOffInhibit
6 SafetyResetRequiredInhibit
7 SafetyNotConfiguredInhibit
8 StopCommandActiveInhibit
9 FeedbackDeviceResetInhibit
10 BrakeMalfunctionInhibit
11 ACLineContactorInputInhibit
12 TrackSectionNotEnabledInhibit
13 TrackMoverMotorMismatchInhibit
See also
Start Inhibit Attributes on page 614
Standard Start Inhibits on page 615
CIP Axis Attributes on page 243
DC Bus Condition Attributes These are Motion Control Axis attributes associated with the DC Bus
including functionality to address both under-voltage and over-voltage
conditions.
DC Bus Voltage
Usage Access T Data Default Min Max Semantics of Values
Type
Required – XBD Get T REAL - - - Volts
!LTM
The Bus Regulator Voltage Level attribute sets the DC Bus voltage level
for the DC Bus Regulator when the Bus Regulator Set Point Source is
set to Bus Regulator Voltage Level.
The Bus Regulator Set Point Source attribute is the enumerated value
that determines the source of the DC Bus voltage level to be used by
the DC Bus Regulator.The DC Bus Voltage Nominal selection sets the
DC Bus voltage level used by the DC Bus Regulator to a vendor
specific percentage above the time averaged DC Bus voltage given by
the DC Bus Voltage Nominal attribute.
The Bus Regulator Voltage Level selection sets the DC Bus voltage
level used by the DC Bus Regulator to the voltage determined by the
configured Bus Regulator Voltage Level attribute.
Bus Regulator Kp
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - C Set REAL 10 0 % Motor Rated/Volt
The Bus Regulator Kp attribute sets the proportional gain for the DC
Bus Regulator.
The DC Bus Regulator is used in cases where the drive does not have
the ability to regulate the DC Bus voltage through other means
(regenerative converter or shunt regulator) while the motor is
decelerating and driving energy into the DC Bus. It does this by limiting
the amount of torque producing current, Iq, and thereby limiting the
deceleration rate of the motor to keep the DC Bus voltage under the
level that produces a DC Bus overvoltage condition.
When actively limiting current, the Current Limit Source attribute
indicates Bus Regulator Limit.
The DC Bus Regulator is only applicable when the Bus Regulator
Action attribute is set to either Adjust Frequency or Both – Frequency
First.
Bus Regulator Ki
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - C Set REAL 100 0 (% Motor Rated/Volt)/Seconds
The Bus Regulator Ki attribute sets the integral gain for the DC Bus
Regulator.
The Bus Limit Regulator Kp attribute sets the proportional gain for the
DC Bus Limit Regulator.
The DC Bus Regulator is used in cases where the drive does not have
the ability to regulate the DC Bus voltage through other means
(regenerative converter or shunt regulator) while the motor is
decelerating and driving energy into the DC Bus. It does this by limiting
the rate of change of the velocity reference signal into the frequency
control function of the drive. When used with the Bus Limit Active
Current regulator, this regulator keeps the DC Bus voltage under the
level that produces a DC Bus overvoltage condition.
The Bus Limit Regulator Kd attribute sets the derivative gain for the DC
Bus Limit Regulator
The Bus Limit Active Current Regulator Ki attribute sets the integral gain
for the DC Bus Limit Active Current Regulator.
Bus Configuration
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - XBD Set USINT - - - Enumeration:
0 = Standalone
1 = Shared AC/DC
2 = Shared DC
3 = Shared DC - Non CIP Converter
4 = Shared DC/DC
5-255 = (reserved)
The Bus Voltage Select value indicates the expected bus voltage level
of the drive application. High bus voltage selection is usually associated
with drive running on the North American power grid, while operating in
Europe a Low Bus Voltage selection would be appropriate. This
parameter can be used to compensate for these different bus voltage
levels in the current loop.
The Shunt Regulator Resistor Type defines using either the Internal or
External Shunt resistor.
Use the External Shunt Power attribute after configuring the external
shunt resistor. The External Shunt Power attribute value specifies the
power rating of the external shunt resistor, in Kilowatts.
Use the External Shunt Pulse Power attribute after configuring the
external shunt resistor. The attribute value specifies the power for
delivering to the external shunt resistor for one second, without
exceeding the rated element temperature. There are approximations to
help determine this attribute if this information is not available
from your vendor. Shunt Pulse Power (Kilowatts) = 75,000 * lbs, where
lbs is the weight of the resistor wire element.
Tip: Shunt Pulse Power is not the weight of the resistor.
The Power Loss Action attribute sets the reaction to a DC Bus under-
voltage condition when the DC Bus voltage or AC Line RMS voltage
drops below a hard-coded threshold in the device or the configured
Sets the Level for Power Loss as percent of nominal DC Bus Voltage or
nominal AC Line Voltage.
Shutdown Action
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - BD Set USINT 0 (D) - - Enumeration:
1 (B) 0 = Disable (R/D)(O/G)
1 = Drop DC Bus (R/B) (O/D)
2-127 = Reserved
128-255 = Vendor Specific
Shutdown Action selects the action for the device when a Shutdown
Request initiates.
Disable, the default action for a drive, immediately disables the device's
power structure according to the Category 0 Stop Sequence. For a
regenerative converter, this action immediately disables the converter’s
power structure to stop regenerative power flow.
If Drop DC Bus is selected, action can be taken to drop the DC Bus
voltage as well. This is generally done by opening an AC Contactor
Enable output provided by the device that controls power to the
converter.
The Shutdown Action executes the Category 0 Stop Sequence for a
drive.
When the Power Loss Action is set to Coast Thru, Ride Thru, or Decel
Regen, this attribute sets the timeout value before a Bus Power Loss
exception is generated by the drive, or a Converter AC Power Loss
exception is generated by the converter, in response to a Power Loss
condition. For details, see the Power Loss Action attribute table earlier
in this topic.
The Pre-Charge Hold Control attribute controls the axis state transition
out of the Pre-Charge state. When set to Enabled by the controller
during device initialization, the axis remains in the Pre-Charge state,
See also
Motion Planner Configuration Attributes on page 527
State Behavior on page 63
Converter AC Line Input The following attribute tables contain attributes related to the AC Line
input to a Converter.
Attributes
Converter AC Line These are the regenerative converter AC line monitoring attributes
associated with the AC Line input to a Converter.
Monitoring Attributes
AC Line Frequency
Usage Access T Data Default Min Max Semantics of Values
Type
Required - G Get/GSV T REAL - - - Hertz
AC Line Current
Usage Access T Data Default Min Max Semantics of Values
Type
Required - G Get/GSV T REAL - - - Amps (RMS)
AC Line Voltage
Usage Access T Data Default Min Max Semantics of Values
Type
Required - G Get/GSV T REAL - - - Volts (RMS)
The AC Line Voltage Time Constant attribute sets the low pass filter
time constant applied to the AC Line Voltage to determine the AC Line
Voltage Nominal attribute value.
Apparent Power, Sc, is the vector sum of active and reactive power and
is always a positive value. It is specified in Volt-Amperes. Active power,
Pc, is the real or active component of apparent power delivered to the
load and can be positive (motoring) or negative (regenerating). Reactive
power, Qc, is the imaginary or reactive component of apparent power
delivered to the AC line. A positive value of reactive power indicates
that reactive power is absorbed (lagging reactive power) from the line
by the converter. A negative value of reactive power indicates that
reactive power is delivered (leading reactive) to the AC line from the
converter.
AC Line 1 Current
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - G Get/GSV REAL - - - Amps (RMS)
AC Line 2 Current
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - G Get/GSV REAL - - - Amps (RMS)
AC Line 3 Current
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - G Get/GSV REAL - - - Amps (RMS)
Where:
Iavg = (IL1+IL2+IL3)/3
IL#(max) = Max(IL1,IL2,IL3)
AC Line 1 Voltage
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - G Get/GSV REAL - - - Volts (RMS)
AC Line 2 Voltage
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - G Get/GSV REAL - - - Volts (RMS)
AC Line 3 Voltage
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - G Get/GSV REAL - - - Volts (RMS)
Where:
VLL(avg) = (VL1+VL2+VL3)/3
VLL(max) = Max(VL1,VL2,VL3)
The AC Line Sync Error attribute represents the phase error associated
with the AC line synchronization function of the regenerative converter.
See also
Converter AC Line Configuration Attributes on page 634
Converter AC Line These are the regenerative converter AC Line configuration attributes
associated with the AC Line input to a converter.
Configuration Attributes
Converter AC Input Frequency
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - G Set/SSV USINT 1 - - Enumeration:
0 = 50 Hz
1 = 60 Hz
2-255 = Reserved
The AC Line Sync Error Tolerance attribute sets the maximum allowed
phase error associated with the AC line synchronization function of the
regenerative converter. Exceeding this limit results in an AC Line Sync
Loss exception.
See also
Converter Bus Voltage Control Signal Attributes on page 646
Converter Current Reference Signal Attributes on page 651
AC Line Condition Attributes on page 637
Converter AC Line Source These are the converter AC Line source configuration attributes
associated with the AC Line input to a Converter.
Configuration Attributes
AC Line Source Select
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - G Set/SSV USINT 0 - - Enumeration:
0 = AC Line A
1 = AC Line B (Alternate)
2-255 = Reserved
The AC Line Source Power attribute sets the power rating of the
transformer or generator feeding power to the converter as a
percentage of the converter's power rating.
The AC Line Source Power - Alternate attribute selects the power rating
of the alternate transformer or generator feeding power to the converter
as a percentage of the converter's power rating.
See also
Converter AC Line Monitoring Attributes on page 628
AC Line Condition Attributes These are the Motion Control Axis attributes pertaining to various
conditions of the AC Line input primarily for a Regenerative Converter.
The AC Line Voltage Sag Action sets the reaction to a Voltage Sag
condition when any one of the AC Line phase voltages drops below a
hard-coded threshold in the device or the configured AC Line Voltage
Sag Threshold. This provides a specific (configured) response to an
incoming AC Line Voltage Sag condition while the device is running.
See Power Loss Action for semantics of these enumerated actions.
The AC Line Voltage Sag Threshold attribute sets the level for AC Line
Voltage Sag as percent of nominal AC Line Voltage. Nominal voltage is
defined by the AC Line Voltage Nominal attribute. Measured AC Line
Voltage values less than this threshold indicate an AC Line Voltage Sag
condition.
When the AC Line Voltage Sag Action is set to Ride Thru, this attribute
sets the timeout value before an AC Line Voltage Sag exception is
generated by the device in response to a Voltage Sag condition. A
value of 0 in this case results in an immediate exception.
The Converter Input Phase Loss Action attribute sets the reaction to an
AC input phase loss condition. This provides a specific (configured)
response to an incoming phase loss while the converter is running.
See Power Loss Action for semantics of these enumerated actions.
When the Converter Input Phase Loss Action is set to Ride Thru, this
attribute sets the timeout value before a Converter AC Phase Loss
Exception is generated by the device in response to the Converter Input
Phase Loss condition. A value of 0 in this case results in an immediate
exception.
When the AC Line Frequency Change Action is set to Ride Thru, this
attribute sets the timeout value before an AC Line Frequency Change
exception is generated by the converter in response to an AC Line
Frequency Change condition. A value of 0 in this case results in an
immediate exception.
The AC Line Sync Loss Action attribute sets the reaction to a loss of AC
line synchronization by the converter’s line synchronization function (for
example, PLL). This provides a specific (configured) response to an
When the AC Line Sync Loss Action is set to Ride Thru, this attribute
sets the timeout value before an AC Line Sync exception is generated
by the converter in response to an AC Line Sync Loss condition. A
value of 0 in this case results in an immediate exception.
See also
DC Bus Condition Attributes on page 617
Converter Control These are the Motion Device Axis Object attributes related to the
Converter function of a CIP Motion device.
Attributes
Converter Types The Converter function of a CIP Motion device covers a wide range of
power conversion technologies from simple non-regenerative AC/DC
converters, typically known as diode rectifiers, to sophisticated
regenerative AC/DC converters that provide closed loop control of DC
bus voltage as well as active and reactive current flow back to the grid.
This also includes support for DC/DC power converters.
The following attribute table is used to identify the type of Converter
function.
Converter Type
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - BD Get/GSV USINT - - - Enumeration:
0 = Passive AC/DC
1 = Active AC/DC
2 = DC/DC
34-127 = Reserved
128-255 = Vendor Specific
See also
Converter Control Mode Attributes on page 641
Converter Control Mode The attribute table contains attributes that govern the overall control
behavior of a regenerative converter in the Motion Control Axis.
Attributes
Converter Configuration
Usage Access T Data Default Min Max Semantics of Values
Type
Required - G Set/GSV USINT AOP* - - Enumeration
0 = Bus Voltage Control
1 = Active Current Control (O)
2-255 = Reserved
* The default value can specified by the specific drive profile (AOP).
The Converter Configuration attribute determines the general control
behavior of the regenerative or low harmonic AC/DC converter axis
instance. This attribute is used by the controller to set the Converter
Control Mode attribute that is sent to the drive during initial
configuration. When the Converter Configuration is configured in Logix
Designer application, the Converter Control Mode is also updated.
This table provides descriptions of the Converter Configuration
enumerations.
Enumeration Required/ Optional Name Description
0 R/G Bus Voltage Control The Bus Voltage Control provides closed loop control of
DC bus voltage, and includes closed loop control of
Active and Reactive components of AC line current.
This value is applied by the controller to the Converter
Control Mode attribute and sent to the drive.
1 O/G Active Current Control The Active Current Control provides closed loop control
of Active and Reactive components of AC line current.
This value is applied by the controller to the Converter
Control Mode attribute and sent to the drive.
2-255 Reserved -
See also
Drive General Purpose I/O Attributes on page 361
CIP Axis Status Attributes on page 339
State Behavior on page 63
Converter Bus Voltage These are the bus voltage control configuration attributes associated
with a regenerative converter.
Control Configuration
Attributes Bus Voltage Set Point
Usage Access T Data Type Default Min Max Semantics of Values
The Bus Voltage Set Point attribute sets the reference voltage used to
actively regulate the DC Bus Voltage of the converter when in the
Running state and the Bus Voltage Reference Source is set to Manual.
The Bus Voltage Rate Limit attribute sets the DC Bus rate limit for the
Bus Voltage Set Point that becomes the DC Bus Reference signal when
the Bus Voltage Reference Source is set to Manual.
See also
Converter Current Reference Signal Attributes on page 651
Converter Bus Voltage These are the attributes of the bus voltage control loop associated with
a regenerative converter.
Control Signal Attributes
The Bus Voltage - High Limit attribute is the high limit for the Bus
Voltage Reference signal established by the regenerative converter.
The Bus Voltage - Low Limit attribute is the low limit for the Bus Voltage
Reference signal established by the regenerative converter. This limit is
typically derived from the AC Line Voltage Nominal attribute value.
The Bus Voltage Error attribute is the error between the Bus Voltage
Reference and Bus Voltage Feedback signals that is the output of the
bus voltage loop summing junction.
The Bus Voltage Loop Output attribute is the output of the bus voltage
loop forward path representing the total control effort of the bus voltage
control loop.
The Bus Observer Voltage Rate Estimate attribute is the output of the
Bus Observer that, when the Bus Observer block is enabled, is applied
to the voltage rate summing junction. When the Bus Observer is
enabled, this signal compensates for disturbances to the DC Bus
relative to an ideal DC Bus model with fixed capacitance. When the Bus
Observer is disabled, this signal is 0.
The Bus Observer Current Estimate attribute is the product of the Bus
Observer Voltage Rate Estimate signal and the current System
Capacitance value, Kc. In the Load Observer configuration, this signal
represents the estimated current disturbances to the DC Bus relative to
an ideal DC Bus model. When the Load Observer is disabled, this
signal is 0.
See also
Converter Bus Voltage Control Configuration Attributes on page
646
Converter Current Reference Configuration Attributes on page
649
Converter AC Line Monitoring Attributes on page 628
Converter Current These are the current reference configuration attributes associated with
a Regenerative Converter.
Reference Configuration
Attributes System Capacitance
Usage Access T Data Default Min Max Semantics of Values
Type
Required - G Set/SSV REAL 0 0 % Rated (Volts/Second)
Voltage Control FD
only
The Active Current Command attribute sets the reference current used
to actively regulate the Active Current of the converter when in the
Running state and configured for AC Line Current Control mode. A
positive value implies motoring current. A negative value implies
regenerative current.
The Active Current Low Pass Filter Bandwidth attribute is the break
frequency for the low pass filter applied to active current reference
signal. A value of 0 for this attribute disables this feature.
The Active Current Rate Limit attribute sets the magnitude limit on the
rate of change of the converter's active current reference signal. This
attribute applies only when configured for AC Line Current Control
mode.
The Reactive Current Rate Limit sets the magnitude limit on the rate of
change of the converter's reactive current reference signal. This
attribute applies only when configured for AC Line Current Control
mode.
Kc
Usage Access T Data Default Min Max Semantics of Values
Type
Required - G Set REAL - - - % Rated/(Volts/Second)
Voltage Control
only
The Kc attribute is the scaling gain value that converts voltage rate
commanded by the bus voltage control loop into equivalent active
current, expressed as a percent of the converter’s current rating.
Properly set, this value represents the total system capacitance of the
DC bus.
See also
Converter Control Mode Attributes on page 641
Converter Types on page 640
Converter Current These are the current reference signal attributes associated with a
Regenerative Converter.
Reference Signal Attributes
Active Current Reference
Usage Access T Data Default Min Max Semantics of Values
Type
Required - G Get/GSV T Real - - - % Rated
See also
Converter Control Mode Attributes on page 641
Converter Current Control Signal Attributes on page 654
Converter Current Reference Configuration Attributes on page
649
Converter Current Control These are the current control configuration attributes for the
Regenerative Converter.
Configuration Attributes
Converter Current Loop Bandwidth
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - G Set/SSV REAL 0 0 Loop Bandwidth Units
FD
The Converter Current Vector Limit attribute sets the value applied to
current vector limiter to provide a configurable limit to the magnitude of
the converter's active and reactive current reference signals.
See also
Converter Current Control Signal Attributes on page 654
Converter Current Control These are the active and reactive current control attributes for the
associated Motion Device Axis of a Regenerative Converter.
Signal Attributes
Converter Operative Current Limit
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - G Get T REAL - - - % Rated
The Active Power Limit attribute is the current limit that corresponds to
the maximum active power transfer between the AC Line and the
converter. This value is calculated by the converter based on the value
of the source impedance between the converter and the AC Line, and
the DC Bus Voltage level.
% Rated is defined as percent of the Converter Rated Input Current.
The Reactive Power Limit attribute is the current limit that corresponds
to the maximum reactive power transfer between the AC Line and the
converter. This value is calculated by the converter based on the value
of the source impedance between the converter and the AC Line, and
the DC Bus Voltage level.
% Rated is defined as percent of the Converter Rated Input Current.
The Active Current Error attribute is the error between active current
reference and active current feedback signals that is the output of the
active power producing current loop summing junction.
The Active Voltage Output attribute is the active power producing output
voltage from the active current control loop.
See also
Converter Current Reference Signal Attributes on page 651
Axis Info Attributes on page 330
Converter Reactive Power These are the reactive power control attributes for the Motion Device
Axis Object for a Regenerative Converter.
Control Attributes
Reactive Power Set Point
Usage Access T Data Default Min Max Semantics of Values
Type
Optional - G Set REAL 0 - % Rated
The Reactive Power Set Point attribute sets the reference current used
to actively regulate the AC Line Reactive Power of the converter when
in the Running state. Attribute units are expressed in percent for
Converter Rated Output Power (Attr ID 724).
Positive value indicates lagging kVAR and negative value indicates
leading kVAR.
The Reactive Power Rate Limit attribute sets the active current rate limit
for AC Line Reactive Power Set Point input. The output of the Reactive
Power Rate Limit function is the AC Line Reactive Power Reference
signal. Attribute units are expressed in percent for Converter Rated
Output Power (Attr ID 724) per second.
See also
Axis Info Attributes on page 330
Converter Output Attributes These are the converter output related attributes associated with
Motion Control Axis.
See also
DC Bus Condition Attributes on page 617
Exceptions The various motion attributes can result in exceptions that can be
configured to present either a fault or alarm.
Standard Exceptions The following table lists the standard exception conditions associated
with the CIP Axis Exceptions, CIP Axis Faults, and CIP Axis Alarms
attributes and their extension attributes, Axis Exceptions 2, Axis Faults
2, and Axis Alarms 2. While the CIP Axis Exceptions, CIP Axis Faults,
and CIP Axis Alarms attributes and their extensions are all required in
the CIP Motion device implementation, support for each individual
exception condition is optional.
The Rule column in the following table indicates the Device Function
Codes where the associated exception is applicable.
• B = Converters
• D = Frequency, Position, Velocity, and Torque Control modes
• E = Feedback Only
The enumerations for exceptions is as follows:
• 0 = Ignore (All)
• 1 = Alarm (All)
• 2 = Fault Status Only (B, D)
• 3 = Stop Planner (D)
Standard exceptions
Array Rule Exception Description
Index
0 - Reserved This bit cannot be used since the alarm codes and fault code are defined by the
associated exception bit number and an alarm code or fault code of 0 means no
alarm or fault condition is present.
1 XD Motor Overcurrent Motor current has exceeded its rated peak or instantaneous current limit.
2 XD Motor Commutation Permanent magnet motor commutation problem detected, such as an illegal state
'111' or '000' for UVW commutation signals, S1, S2, and S3.
3 D Motor Overspeed FL Motor speed has exceeded the Motor Overspeed Factory Limit attribute
associated with the motor type.
4 D Motor Overspeed UL Motor speed has exceeded the user-defined speed limit given by Motor Overspeed
User Limit.
5 XD Motor Overtemperature FL Motor temperature has exceeded the Motor Overtemperature Factory Limit, or the
integrated motor thermal switch has tripped.
6 XD Motor Overtemperature UL Motor temperature has exceeded the user defined temperature limit given by
Motor Overtemperature User Limit.
7 XD Motor Thermal Overload FL Motor thermal model or I2T overload value has exceeded its factory set thermal
capacity limit given by Motor Thermal Overload Factory Limit.
8 XD Motor Thermal Overload UL Motor thermal model or I2T overload value has exceeded its user-defined thermal
capacity given by Motor Thermal Overload User Limit.
14 XD Inverter Thermal Overload Inverter thermal model or I2T overload value has exceeded its user-defined
UL thermal capacity given by the Inverter Thermal Overload User Limit.
15 BD Converter Overcurrent Converter current has exceeded the factory set peak or instantaneous current
limit.
16 BD Converter Ground Current FL Ground Current has exceeded its factory set current limit given by the Converter
Ground Current Factory Limit.
17 BD Converter Ground Current UL Ground Current has exceeded user-defined limit given by the Converter Ground
Current User Limit.
18 BD Converter Overtemperature Converter temperature has exceeded its factory set temperature limit given by
FL the Converter Overtemperature Factory Limit.
19 BD Converter Overtemperature Converter temperature has exceeded the user-defined temperature limit given by
UL the Converter Overtemperature User Limit.
20 BD Converter Thermal Overload Converter thermal model or I2T overload value has exceeded its factory set
FL thermal capacity limit given by the Converter Thermal Overload Factory Limit.
21 BD Converter Thermal Overload Converter thermal model or I2T overload value has exceeded its user-defined
UL thermal capacity given by the Converter Thermal Overload User Limit.
22 XBD Converter AC Power Loss Multiple AC phases have been lost on the AC line to the converter, usually as a
result of opening an AC line contactor. For regenerative converters, this
exception is generated at the expiry of the configured Power Loss Time while
attempting to Ride Thru a Power Loss condition. When associated with an
external converter in a Shared AC/DC or Shared DC bus configuration, the AC
Power Loss condition detected by the converter can be conveyed using the CIP
Motion connection's Control Status element. Generally, this exception is not
asserted unless the device's power structure is enabled.
24 BD Converter AC Phase Short A short has been detected between an AC phase and another AC phase or ground.
25 BD Converter Pre-Charge A problem has been detected in the pre-charge circuitry of the converter
Failure preventing the DC Bus from charging to an acceptable voltage level.
26 --Reserved-- -
27 XBD Bus Regulator Bus Regulator temperature has exceeded its factory set temperature limit given
Overtemperature FL by the Bus Regulator Overtemperature Factory Limit.
28 XBD Bus Regulator Bus Regulator temperature has exceeded the user-defined temperature limit
Overtemperature UL given by the Bus Regulator Overtemperature User Limit.
29 XBD Bus Regulator Thermal Bus Regulator thermal model or I2T overload value has exceeded its factory set
Overload FL thermal capacity limit given by the Bus Regulator Thermal Overload Factory Limit.
30 XBD Bus Regulator Thermal Bus Regulator thermal model or I2T overload value has exceeded its user-defined
Overload UL thermal capacity given by the Bus Regulator Thermal Overload User Limit.
31 XBD Bus Regulator Failure The bus regulator (shunt) has a failed.
32 XBD Bus Module Failure The bus module failed. Fault/Alarm Sub Code identifies the specific type of bus
module that failed.
33 XBD Bus Undervoltage FL DC Bus voltage level is below the factory set limit given by Bus Undervoltage
Factory Limit.
34 XBD Bus Undervoltage UL DC Bus voltage level is below user defined limit given by Bus Undervoltage User
Limit, or device defined limit if the user limit attribute is not supported.
35 XBD Bus Overvoltage FL DC Bus voltage level is above the factory set limit given by the Bus Overvoltage
Factory Limit.
36 XBD Bus Overvoltage UL DC Bus voltage level is above user-defined limit given by Bus Overvoltage User
Limit, or device defined limit if the user limit attribute is not supported.
37 XBD Bus Power Loss DC Bus voltage level is below the Bus Power Loss Threshold for more than the
timeout period specified by the Bus Power Loss Time value.
38 XBD Bus Power Fuse Blown DC bus power loss due to blown fuse.
39 D Bus Power Leakage DC Bus power leak has been detected when configured for Standalone operation.
This can occur when the drive, configured for Standalone operation, is incorrectly
wired to share DC bus power.
40 XBD Bus Power Sharing An external converter sharing DC Bus power with this drive in a Shared AC/DC or
Shared DC configuration has requested that this drive stop consuming power
from the shared DC Bus. This may require that the drive be disabled to remove its
DC Bus Power load from the failed converter. When there is no communication
link between this drive and the external converter, the controller can monitor the
DC Bus Unload bit of the converter axes and, if set, it can initiate Bus Power
Sharing exceptions on all drives associated with the failed converter. See the DC
Bus Unload status bit definition associated with the Axis Status attribute for a
detailed description of this behavior.
41 E Feedback Signal Noise FL Noise induced A/B channel state changes (illegal states) from a feedback device
were detected by the drive. Specifically, the number of these noise events that
have occurred on this channel has exceeded the Feedback Noise Factory Limit.
The offending feedback channel number is encoded in the associated fault/alarm
sub code.
51 D Hardware Overtravel Axis moved beyond the physical travel limits in the negative direction and
Negative activated the Negative Overtravel limit switch.
52 E Position Overtravel Positive Axis actual position exceeded the configured Position Limit - Positive attribute
value in the positive direction. (Drive Scaling only).
53 E Position Overtravel Negative Axis actual position exceeded the configured Position Limit - Negative attribute
value in the negative direction. (Drive Scaling only).
54 P Excessive Position Error The Position Error value of the position control loop has exceeded the configured
value for Position Error Tolerance.
55 PV Excessive Velocity Error The Velocity Error value of the velocity control loop has exceeded the configured
value for Velocity Error Tolerance.
56 C Overtorque Limit Motor torque has risen above user-defined maximum torque level given by
Overtorque Limit.
57 C Undertorque Limit Motor torque has dropped below user-defined minimum torque level given by
Undertorque Limit.
58 B Excessive Bus Voltage Error The Bus Voltage Error value of the bus voltage control loop has exceeded the
configured value for Bus Voltage Error Tolerance.
59 XBD Ambient Temperature Rise The temperature in the module has risen higher than expected, or failed to rise to
the expected operating value for the load and ambient measured temperature.
60 All Illegal Control Mode Controller has specified an unsupported Control Mode or Feedback Mode
See also
Rockwell Automation Specific Exceptions on page 671
Standard CIP Axis Fault and Based on the Exception Action configuration, Exception conditions can
become Faults or Alarms. The naming convention for Faults is to
Alarm Names append a 'Fault' suffix to the Exception name. Similarly, the convention
for Alarms is to append an 'Alarm' suffix to the Exception name.
This table lists the resulting Fault names associated with the Standard
Exception conditions.
0
1 Motor Overcurrent Alarm
2 Motor Commutation Alarm
3 Motor Overspeed FL Alarm
4 Motor Overspeed UL Alarm
5 Motor Overtemperature FL Alarm
6 Motor Overtemperature UL Alarm
7 Motor Thermal Overload FL Alarm
8 Motor Thermal Overload UL Alarm
9 Motor Phase Loss Alarm
10 Inverter Overcurrent Alarm
11 Inverter Overtemperature FL Alarm
12 Inverter Overtemperature UL Alarm
13 Inverter Thermal Overload FL Alarm
14 Inverter Thermal Overload UL Alarm
15 Converter Overcurrent Alarm
16 Converter Ground Current FL Alarm
17 Converter Ground Current UL Alarm
18 Converter Overtemperature FL Alarm
19 Converter Overtemperature UL Alarm
20 Converter Thermal Overload FL Alarm
21 Converter Thermal Overload UL Alarm
22 Converter AC Power Loss Alarm
See also
Standard Exceptions on page 662
Rockwell Automation Specific Exceptions on page 671
Rockwell Automation This table defines a list of Rockwell Automation specific exception
conditions associated with the CIP Axis Exceptions-RA, CIP Axis
Specific Exceptions Faults-RA, and CIP Axis Alarms-RA attributes and their extension
attributes, Axis Exceptions 2 Mfg, Axis Faults 2 Mfg, and Axis Alarms 2
Mfg attributes. While the CIP Axis Exceptions - RA, CIP Axis Faults -
RA, and CIP Axis Alarms - RA attributes and their extensions are all
Required in the CIP Motion device implementation, support for each of
the individual exception conditions therein is left Optional.
The Rule column in the following table indicates the Device Function
Codes where the associated exception is applicable.
• B = Converters
• D = Frequency, Position, Velocity, and Torque Control modes
• E = Feedback Only
The enumerations for exceptions is as follows:
• 0 = Ignore (All)
• 1 = Alarm (All)
• 2 = Fault Status Only (B, D)
• 3 = Stop Planner (D)
• 4 = Disable (R)
• 5 = Shutdown (R)
0 - --Reserved-- This bit cannot be used since the Alarm Codes and Fault Code are
defined by the associated exception bit number and an Alarm Code
or Fault Code of 0 means no alarm or fault condition is present.
9 - --Reserved-- -
10 ALL Control Module Kinetix: The control module temperature has exceeded its limit.
Overtemperature FL Rhino: The temperature sensor on the Main Control Board detected
excessive heat.
11 ALL Control Module The control module temperature exceeds the user-defined limit
Overtemperature UL specified in Control Module Overtemperature User Limit.
12 BD Converter Pre-Charge Converter estimates that the pre-charge circuit has exceeded its
Overload FL factory limit due to excessive power cycling.
14 XBD Excessive Current Feedback Current in one or more phases has been lost or remains below a
Offset preset level.
15 BD Regenerative Power Supply The hardware Regeneration OK input was deactivated while the
Failure drive was enabled.
16 XD PWM Frequency Reduced Carrier Frequency foldback due to excessive Junction
Temperature.
17 XD Current Limit Reduced Current Limit reduced due to excessive Junction Temperature or
due to Overload Protection.
18 D Torque Prove Failure (O) Actual feedback indicates error in torque proving.
19 D Decel Override (O) The drive is not following a commanded deceleration because it is
attempting to limit bus voltage.
24 BD Converter Pre-Charge Input Pre-Charge Input has been deactivated while the axis power
Deactivated structure is enabled and supplying current to the DC Bus or motor.
25 BD DC Common Bus Error has been detected related to Common Bus operation.
26 ALL Runtime Error Runtime assertions detected.
27 D Backplane Communication Error in communicating over the modular backplane.
Error
28 D Safety Module Error in communicating to the Safety module.
Communication Error
29 BD AC Line Contactor AC Line Contactor is missing or is incorrectly wired. This condition
is checked upon entering the Pre-Charge state if AC Line Contactor
Checking is Enabled and an AC Line Contactor OK digital input is
provided.
30 G AC Line Resonance FL Converter has detected AC line resonance current that has
exceeded the factory set limit given by AC Line Resonance Factory
Limit.
31 G AC Line Resonance UL Converter has detected AC line resonance current that has
exceeded the user set limit given by AC Line Resonance User Limit,
or device defined limit if the user limit attribute is not supported.
32 XPT Track Stop One or more track sections or movers requests a track stop. The
track-wide stop notification occurs when a major fault is initiated
by a mover or section axis on the track. All axes are notified
anytime one or more movers on the track are forced to stop which
could potentially impede motion of other movers on the track. Only
enabled axis instances would assert this exception.
33 PT Lost Mover Association A logical axis instance lost association with a physical mover on
the track.
34 X Unassociated Mover A track section has detected a physical mover that has no
associated logical mover axis instance on the track.
35-39 - -- Reserved --
40 BD Peripheral Hardware FL Peripheral hardware has failed.
41 BD Peripheral Hardware UL Peripheral hardware event has occurred. There is no user limit
attribute currently defined for this exception.
42 BD Peripheral Over Peripheral temperature has exceeded its factory set temperature
Temperature FL limit given by the Peripheral Over Temperature Factory Limit.
43 BD Peripheral Over Peripheral temperature has exceeded the user defined
Temperature UL (O) temperature limit given by Peripheral Over Temperature User Limit
or a, or device defined limit if the user limit attribute is not
supported.
44 BD Peripheral Under Peripheral temperature has fallen below its factory set
Temperature FL temperature limit given by Peripheral Under Temperature Factory
Limit.
45 BD Peripheral Under Peripheral temperature has fallen below the user defined
Temperature UL temperature limit given by Peripheral Under Temperature User
Limit, or device defined limit if the user limit attribute is not
supported.
46 BD Peripheral Communication A peripheral communication error has occurred that has exceeded
FL the factory high limit.
47 BD Peripheral Communication A peripheral communication error has occurred that has exceeded
UL (O) the factory low limit. There is no user limit attribute currently
defined for this exception.
48-49 - - -
50 BD Adapter Communication FL An adapter communication error has occurred that has exceeded
the factory high limit.
51 BD Adapter Communication UL An adapter communication error has occurred that has exceeded
the factory low limit. There is no user limit attribute currently
defined for this exception.
52-54 - -- Reserved -- -
55 BD Phase Thermal Imbalance A phase thermal imbalance has occurred between parallel power
modules.
56 BD DC Bus Voltage Imbalance A DC bus voltage imbalance has occurred between parallel power
modules exceeding the allowable difference for an extended time
period. Connections through the DC Link fuse or DC Bus connection
harness are possible causes.
57-62 - -
63 All Product Specific (O) Product Specific (exotic) exceptions by Sub Code.
64-127 - -- Reserved --
See also
Rockwell Automation Specific CIP Axis Alarm Names on page
675
Rockwell Automation Specific CIP Axis Fault Names on page
674
Rockwell Automation Specific Initialization Faults on page 436
Rockwell Automation Specific Start Inhibits on page 616
Standard Exceptions on page 662
Rockwell Automation Based on the Exception Action configuration, Exception conditions can
become Faults or Alarms. The naming convention for Faults is to
Specific CIP Axis Fault append a Fault suffix to the Exception name. Similarly, the convention
for Alarms is to append an Alarm suffix to the Exception name. This
Names table lists the resulting Fault names associated with the above
exception conditions.
See also
Rockwell Automation Specific Exceptions on page 671
Rockwell Automation Specific CIP Axis Alarm Names on page
675
Rockwell Automation Specific Initialization Faults on page 436
Rockwell Automation Specific Start Inhibits on page 616
Rockwell Automation The following table lists the resulting Alarm names associated with the
Rockwell Automation specific exception conditions.
Specific CIP Axis Alarm Bit Object CIP Axis Alarm Name
Names 1 Commutation Startup Alarm
4 Feedback Filter Noise Alarm
5 Feedback Battery Loss Alarm
6 Feedback Battery Low Alarm
7 Feedback Incremental Count Error Alarm
See also
Rockwell Automation Specific Exceptions on page 671
Rockwell Automation Specific CIP Axis Fault Names on page
674
Rockwell Automation Specific Initialization Faults on page 436
Rockwell Automation Specific Start Inhibits on page 616
See also
CIP Axis Attributes on page 243
Interpret the Attribute Tables on page 89
Module Configuration Block The following collection of Module Class Attributes are stored in the
controller and sent to the module as part of the Configuration Block of
Attributes the Forward_Open service.
Configuration Bits
Usage Access T Data Default Min Max Semantics of Values
Type
Required - All BYTE 0 - - Bitmap:
0 = Verify Power Structure
(O/D)
1 = Networked Safety Bit Valid
(O/D)
2 = Allow Networked Safety
(O/D)
3...7 = Reserved
See also
Module Configuration Attributes on page 677
Module Feedback Port Attributes on page 695
Module Class Attributes The following collection of Module Class Attributes are stored in the
controller and used to configure Motion Device Axis Object Class
attributes associated with the CIP Motion device. These attributes
generally apply to the CIP Motion connection behavior. If these Module
Class attributes are included in the CIP Motion Control Axis Object
implementation, the attribute values are the same for all axis instances
associated with the module. In such an implementation, the controller
need only apply the Module Class attribute value for one of the axis
Represents the high limit delay threshold for a Controller to Device (C-
to-D) Connection update. This delay is specified in units of Controller
Update Periods. Exceeding this limit results in a Control Connection
Update Fault.
Sync Threshold
Usage Access T Data Default Min Max Semantics of Values
Type
Optional Set DINT 10000 1 109 Nanoseconds
Default: device dependent
minimum value
See also
Module Axis Attributes on page 680
Module Configuration Attributes on page 677
Module Axis Attributes Module Axis attributes are used to configure common components of a
CIP Motion device, for example the Bus Converter, Bus Regulator, and
so on, that apply to all axis instances of the device. If these Module
Class attributes are included in the CIP Motion Control Axis Object
implementation, the attribute values are the same for all axis instances
associated with the device. This is generally enforced by configuration
software.
If the value for a given Module Configuration attribute is not the same
for each axis instance of the device, the Module Configuration attribute
value for instance 1 determines the configuration of the device
component.
PWM Frequency
Usage Access T Data Type Default Min Max Semantics of Values
This 8-element array sets the carrier frequency for the Pulse Width
Modulation output to the motor. Drive derating is required at higher
PWM frequencies due to switching losses. Current loop update time is
tied directly to the PWM frequency so loop performance generally
increases with increasing PWM rate. Note that each drive instance in a
multi-axis drive module can have an independently configured PWM
frequency. The indexed elements of this array correspond to axis
instances 1 thru 8. Individual elements of this attribute are only
applicable to axis instances whose associated Inverter Support bit is
set. Array elements that are not applicable or not configured are set to
0.
Bus Configuration
Usage Access T Data Type Default Min Max Semantics of Values
This value indicates the expected bus voltage level of the drive
application. High bus voltage selection is usually associated with drive
running on the North American power grid, when operating in Europe a
Low Bus Voltage selection would be appropriate. This parameter can be
used to compensate for these different bus voltage levels in the current
loop.
Duty Select
Usage Access T Data Type Default Min Max Semantics of Values
3-255 = (reserved)
This 8-element array indicates the duty level of the drive application and
balances the continuous and intermittent overload capacity of the drive
and motor accordingly. Since this value is tied to a specific drive inverter
and motor, the setting can vary for each axis instance supported by a
multi-axis drive module. The indexed elements of this array correspond
to axis instances 1 thru 8. Array elements that are not applicable or
configured are set to 0.
Normal Duty provides nominal continuous rating at the expense of lower
overload capacity.
Heavy Duty provides highest overload capacity at the expense of a
lower continuous rating.
Light Duty provides highest continuous rating at the expense of lower
overload capacity.
Specification for the continuous and overload ratings under Normal,
Heavy, and Light Duty are left to the discretion of the drive vendor.
Duty Select is used to determine the level of thermal protection for the
motor and the inverter during drive operation.
This enumerated selection indicates the Bus Sharing Group the drive is
assigned to. Physically, a Bus Sharing Group represents a collection of
drives that are wired together in a Shared AC/DC or Shared DC Bus
Configuration. Assignment to a Bus Sharing Group limits the DC Bus
Unload action initiated by a converter in the group, and the resultant
Bus Power Sharing exceptions, to Shared AC/DC and Shared DC
drives in the converter's assigned Bus Group. Drives assigned to other
Bus Groups are, therefore, unimpacted.
If the drive's Bus Configuration indicates Standalone operation, the only
valid enumeration for the Bus Sharing Group is Standalone.
If the drive's Bus Configuration indicates Shared AC/DC or Shared DC
operation, the drive should be assigned to a specific Bus Group. The
Standalone enumeration in this case is invalid.
If the drive supports the optional Bus Configuration attribute, the Bus
Sharing Group is required in the drive profile implementation.
Duty Select
Usage Access T Data Type Default Min Max Semantics of Values
This 8-element array indicates the duty level of the drive application and
balances the continuous and intermittent overload capacity of the drive
and motor accordingly. Since this value is tied to a specific drive inverter
and motor, the setting can vary for each axis instance supported by a
multi-axis drive module. The indexed elements of this array correspond
to axis instances 1 thru 8. Array elements that are not applicable or
configured are set to 0.
• "Normal" Duty provides nominal continuous rating at the expense
of lower overload capacity.
• "Heavy" Duty provides highest overload capacity at the expense
of a lower continuous rating.
• "Light" Duty provides highest continuous rating at the expense of
lower overload capacity.
Specification for the continuous and overload ratings under Normal,
Heavy, and Light Duty are left to the discretion of the drive vendor.
Duty Select is used to determine the level of thermal protection for the
motor and the inverter during drive operation.
This value configures the drive for the intended AC line voltage applied
to the converter.
This attribute sets the user limit for the Converter Overtemperature UL
exception.
This attribute sets the user limit for the Converter Thermal Overload UL
exception.
This attribute sets the user limit for the Converter Ground Current UL
exception.
This attribute sets the user limit for the Bus Regulator Overtemperature
UL exception.
This attribute sets the user limit for the Bus Regulator Thermal UL
exception.
This attribute sets the user limit for the Bus Overvoltage UL exception.
Unlike the corresponding Factory Limit, which is specified in Volts, the
User Limit is based on the percentage of Nominal Bus Voltage during
operation.
This attribute sets the user limit for the Bus Undervoltage UL exception.
Unlike the corresponding Factory Limit, which is specified in Volts, the
This attribute sets the user limit for the Control Module Overtemperature
UL exception.
This attribute sets the user limit for the Converter Pre-Charge Overload
UL exception.
This attribute sets the reference voltage used to actively regulate the
DC Bus Output Voltage output of Bus Converter power structure
instance n when in the Running state.
Power structure instance attributes are only applicable when supporting
multiple converter power structure generated DC Bus outputs per axis
object instance
This attribute sets the reference voltage used to actively regulate the
Bus Voltage output of Bus Converter power structure instance n when
in the Running state.
Power structure instance attributes are only applicable when supporting
multiple converter power structure generated DC Bus outputs per axis
object instance.
This attribute sets the User Limit for the Bus Overvoltage UL exception
associated with the DC Bus output of DC converter power structure
instance n when supporting multiple converter power structure
generated DC Bus outputs per axis object instance. Unlike the
corresponding Factory Limit, which is specified in Volts, the User Limit
is based on percent of the corresponding DC Bus Voltage Set Point n
during operation.
This attribute is only applicable to DC Converter Types.
See also
Standard Exceptions on page 662
Module Feedback Port Attributes on page 695
Module Configuration Attributes on page 677
Module Feedback Port Module Axis attributes are used to configure the feedback ports of the
device module. Each device module may be equipped with multiple
Attributes feedback ports that can be freely mapped to the various feedback
channels of a CIP Motion axis instance.
See also
Feedback Interface Types on page 453
Module Timing Attributes on page 696
Module Configuration Attributes on page 677
Module Timing Attributes The following attributes configure various time related aspects of CIP
Motion device.
Time Diagnostics
Usage Access T Data Type Default Min Max Semantics of Values
See also
Motion Control Modes on page 22
Module Support Attributes on page 698
Module Configuration Attributes on page 677
Module Support Attributes The following AOP Module C-tag parameters are used by configuration
software to determine the size of various array data needed to
configure the CIP Motion device and whether attributes associated with
the converter function will be sent to the CIP Motion device. These
parameters are not attributes of any object and are not sent to the CIP
Motion device.
Inverter Support
Usage Access T Data Type Default Min Max Semantics of Values
Firmware only parameter (does not go to the device) that controls how
much of the Digital Input Configuration array is sent to the device for a
given axis instance.
Important: This attribute is only needed if Digital Input Configuration is
supported.
The number of configurable inputs can vary for each axis instance
supported by a multi-axis drive module. The indexed elements of this
array correspond to axis instances 1 thru 8. Array elements that are not
applicable or configured are set to 0.
Firmware only parameter (does not go to the device) that specifies the
axis instance that sources the configurable digital inputs for a given axis
of the device.
Important: This attribute is only needed if Digital Input Configuration is
supported.
This enumerated selection indicates the primary Bus Sharing Group the
device is assigned to. Physically, a Bus Sharing Group represents a
collection of devices that are wired together on a primary DC Bus with in
a Shared AC/DC, Shared DC/DC, or Shared DC Bus Configuration.
Assignment to a Bus Sharing Group limits the DC Bus Unload action
initiated by a converter in the group, and the resultant Bus Power
Sharing exceptions, to Shared AC/DC, Shared DC/DC, and Shared DC
devices in the converter's assigned Bus Group. Drives assigned to
other Bus Groups are, therefore, unaffected.
If the device’s Bus Configuration indicates Standalone operation, the
only valid enumeration for the Bus Sharing Group is Standalone.
If the device’s Bus Configuration indicates Shared AC/DC, Shared
DC/DC, or Shared DC operation, the device should be assigned to a
specific primary Bus Group. The Standalone enumeration in this case is
invalid.
If the device’s supports the optional Bus Configuration attribute, the Bus
Sharing Group is required in the drive profile implementation.
FW only parameter (does not go to the device) but controls how many
Cyclic Read attributes can be configured for a given axis instance. The
number of configurable inputs can vary for each axis instance supported
by a multi-axis drive module. The indexed elements of this array
correspond to axis instances 1 thru 8. Array elements that are not
applicable or configured are set to 0.
FW only parameter (does not go to the device) but controls how many
Cyclic Writes attributes can be configured for a given axis instance. The
number of configurable inputs can vary for each axis instance supported
by a multi-axis drive module. The indexed elements of this array
correspond to axis instances 1 thru 8. Array elements that are not
applicable or configured are set to 0.
Track ID
Usage Access T Data Type Default Min Max Semantics of Values
See also
Module Axis Attributes on page 680
Module Configuration Attributes on page 677
D
device function codes 95
Drive supported optional attributes 119
E
Event Capture Behavior 43
exceptions 664
F
Fault and Alarm Behavior 45
I
identify motion axis attributes based on
device function codes 99
Integrated Motion Axis Control Modes and
Methods 21
Literature Library Find installation instructions, manuals, brochures, and technical data publications. rok.auto/literature
Product Compatibility and Download Center Get help determining how products interact, check features and capabilities, and rok.auto/pcdc
(PCDC) find associated firmware.
Documentation feedback
Your comments help us serve your documentation needs better. If you have any suggestions on how to improve our content, complete the form at
rok.auto/docfeedback.
Rockwell Automation maintains current product environmental information on its website at rok.auto/pec.
Allen-Bradley, expanding human possibility, Logix, Rockwell Automation, and Rockwell Software are trademarks of Rockwell Automation, Inc.
Trademarks not belonging to Rockwell Automation are property of their respective companies.
Rockwell Otomayson Ticaret A.Ş. Kar Plaza İş Merkezi E Blok Kat:6 34752, İçerenkÖy, İstanbul, Tel: +90 (216) 5698400 EEE YÖnetmeliğine Uygundur