XM-124 Standard Dynamic Measurement Module User Manual

XM-124 Standard Dynamic Measurement Module User Manual
User Manual
XM-124 Standard Dynamic Measurement Module
Catalog Number 1440-SDM02-01RA
Important User Information
Read this document and the documents listed in the additional resources section about installation, configuration, and
operation of this equipment before you install, configure, operate, or maintain this product. Users are required to
familiarize themselves with installation and wiring instructions in addition to requirements of all applicable codes, laws,
and standards.
Activities including installation, adjustments, putting into service, use, assembly, disassembly, and maintenance are required
to be carried out by suitably trained personnel in accordance with applicable code of practice.
If this equipment is used in a manner not specified by the manufacturer, the protection provided by the equipment may be
impaired.
In no event will Rockwell Automation, Inc. be responsible or liable for indirect or consequential damages resulting from the
use or application of this equipment.
The examples and diagrams in this manual are included solely for illustrative purposes. Because of the many variables and
requirements associated with any particular installation, Rockwell Automation, Inc. cannot assume responsibility or
liability for actual use based on the examples and diagrams.
No patent liability is assumed by Rockwell Automation, Inc. with respect to use of information, circuits, equipment, or
software described in this manual.
Reproduction of the contents of this manual, in whole or in part, without written permission of Rockwell Automation,
Inc., is prohibited.
Throughout this manual, when necessary, we use notes to make you aware of safety considerations.
WARNING: Identifies information about practices or circumstances that can cause an explosion in a hazardous
environment, which may lead to personal injury or death, property damage, or economic loss.
ATTENTION: Identifies information about practices or circumstances that can lead to personal injury or death, property
damage, or economic loss. Attentions help you identify a hazard, avoid a hazard, and recognize the consequence.
IMPORTANT
Identifies information that is critical for successful application and understanding of the product.
Labels may also be on or inside the equipment to provide specific precautions.
SHOCK HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that dangerous
voltage may be present.
BURN HAZARD: Labels may be on or inside the equipment, for example, a drive or motor, to alert people that surfaces may
reach dangerous temperatures.
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).
Allen-Bradley, Rockwell Software, Rockwell Automation, and XM are trademarks of Rockwell Automation, Inc.
Trademarks not belonging to Rockwell Automation are property of their respective companies.
Summary of Changes
This manual contains new and updated information. Changes throughout this
revision are marked by change bars, as shown to the right of this paragraph.
New and Updated
Information
This table contains the changes made to this revision.
Topic
Page
Added notes for the Full Scale and Low Pass Filter Corner fields in the Signal
Processing table.
66
Added notes for the Frequency Maximum in Spectrum/Waveform Measurement
Options table.
67
Added notes for the Frequency Maximum in Band Measurement Options table.
71
Updated Module Outputs.
97
Updated XM Services table.
100
Added resolutions for the Major Recoverable Fault parameter in Identity Object
Status table.
116
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
3
Summary of Changes
Notes:
4
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Table of Contents
Preface
Purpose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Additional Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Chapter 1
Install the XM-124 Standard Dynamic
Measurement Module
European Hazardous Location Approval . . . . . . . . . . . . . . . . . . . . . . .
North American Hazardous Location Approval . . . . . . . . . . . . . . . .
Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Module Components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
XM Installation Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Wiring Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Power Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Grounding Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Mount the Terminal Base Unit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Mount the Terminal Base Unit on a DIN Rail . . . . . . . . . . . . . . . . . .
Interconnect Terminal Base Units . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Mount to Panel or Wall. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Wire the Terminal Base Unit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Terminal Block Assignments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Connecting Power. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Connect the Relay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Connect the Tachometer Signal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Connect the Buffered Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Connect the Transducer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Connect the Remote Relay Reset Signal . . . . . . . . . . . . . . . . . . . . . . . .
Connect the Setpoint Multiplication Switch. . . . . . . . . . . . . . . . . . . .
Connect the 4…20 mA Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Serial Port Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DeviceNet Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Mount the Module. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Set the Module DIP Switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Switch 1 - DIP Switch Enable (0) / Disable (1). . . . . . . . . . . . . . . . . .
Switch 2 - Normal/Legacy Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Switches 3 and 4 - Set DeviceNet Communication Rate . . . . . . . . .
Switches 5…10 - Set DeviceNet Address . . . . . . . . . . . . . . . . . . . . . . . .
Electronic Data Sheets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ADR for XM Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Power Up the Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
14
15
15
16
17
17
17
19
23
24
25
26
27
27
30
30
32
33
34
46
47
47
48
49
51
52
52
53
53
53
55
56
57
Chapter 2
Configure the XM-124 Standard
Dynamic Measurement Module
XM Serial Configuration Utility Software. . . . . . . . . . . . . . . . . . . . . . . . . .
Application Help. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Module Selection and Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Passwords and Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configurations and Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring the XM-124 Standard Dynamic Measurement Module .
Configure the Channel Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
59
59
60
61
61
62
63
5
Table of Contents
Configure the Tachometer Properties . . . . . . . . . . . . . . . . . . . . . . . . . .
Alarm, Relay, and 4…20 mA Output Parameters . . . . . . . . . . . . . . . .
Relay Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4…20 mA Output Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Triggered Trend Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SU/CD Trend Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
I/O Data Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Firmware Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
View Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
78
80
82
85
86
87
89
92
93
93
Chapter 3
Operate the Module
Module Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Module Outputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Transition to Program Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Transition to Run Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Reset Switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
XM Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Invalid Configuration Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
XM-124 Module I/O Message Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
Poll Message Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
COS Message Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Bit-Strobe Message Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Chapter 4
Trends
Triggered . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
SU/CD. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Appendix A
Status Indicators
Status Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Module Status (MS) Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Relay Indicator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Network Status (NS) Indicator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Channel 1 and Channel 2 Status Indicators. . . . . . . . . . . . . . . . . . . . . . . .
Tachometer Status Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Setpoint Multiplier Indicator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
111
112
112
112
112
113
113
Appendix B
CIP Objects
6
Identity Object
(Class Code 01H) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Class Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Instance Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
115
115
116
116
117
Table of Contents
DeviceNet Object
(Class Code 03H). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Class Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Instance Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Assembly Object
(Class Code 04H). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Class Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Instance Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Assembly Instance Attribute Data Format . . . . . . . . . . . . . . . . . . . . .
Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Connection Object
(Class ID 05H) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Class Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Instance Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Discrete Input Point Object (Class ID 08H) . . . . . . . . . . . . . . . . . . . . . .
Class Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Instance Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Analog Input Point
(Class ID 0AH). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Class Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Instance Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Parameter Object
(Class ID 0FH) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Class Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Instance Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Acknowledge Handler Object (Class ID 2BH) . . . . . . . . . . . . . . . . . . . .
Class Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Instance Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Alarm Object (Class ID 31DH) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Class Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Instance Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Band Measurement Object (Class ID 31EH) . . . . . . . . . . . . . . . . . . . . . .
Class Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
117
117
118
118
118
118
119
119
119
122
123
123
123
123
124
124
124
125
125
126
126
126
126
127
127
128
128
132
133
133
133
134
134
134
134
134
134
135
136
136
136
136
7
Table of Contents
Instance Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Channel Object
(Class ID 31FH) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Channel Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Instance Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Device Mode Object
(Class ID 320H) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Class Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Instance Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Overall Measurement Object (Class ID 322H) . . . . . . . . . . . . . . . . . . . .
Class Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Instance Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Relay Object (Class ID 323H). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Class Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Instance Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Spectrum Waveform Measurement Object
(Class ID 324H) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Class Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Instance Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Get_Spectrum_Chunk/Get_Waveform_Chunk . . . . . . . . . . . . . . .
Speed Measurement Object (Class ID 325H) . . . . . . . . . . . . . . . . . . . . . .
Class Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Instance Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Measurement Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Tachometer Channel Object (Class ID 326H). . . . . . . . . . . . . . . . . . . . .
Class Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Instance Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Transducer Object
(Class ID 328H) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Class Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Instance Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Vector Measurement Object (Class ID 329H) . . . . . . . . . . . . . . . . . . . . .
Class Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
8
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
137
137
138
138
138
138
139
140
140
140
140
141
141
141
141
142
142
143
143
143
144
145
145
145
145
147
147
151
151
151
151
152
152
153
153
153
154
154
154
154
155
155
155
Table of Contents
Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Instance Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4…20 mA Output Object (Class ID 32AH) . . . . . . . . . . . . . . . . . . . . . . .
Class Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Instance Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
155
156
156
157
157
157
157
157
Appendix C
History of Changes
Index
1440-UM001B-EN-P, December 2013 . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
9
Table of Contents
Notes:
10
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Preface
Purpose
This manual describes how to install, configure, and operate the XM® 124
Standard Dynamic Measurement Module. It also contains instruction on
collecting trend data, including start-up or coast-down data.
Additional Resources
These documents contain additional information concerning related products
from Rockwell Automation.
Resource
Description
XM-124 Standard Dynamic Measurement Installation
Instructions, publication 1440-IN001
Provides general guidelines for installing the XM124 Standard Dynamic Measurement module.
XM-120 Eccentricity Module User Guide,
publication GMSI10-UM010
Provides instructions for the use of the XM120 Eccentricity module.
XM-121 Absolute Shaft Module User Guide,
publication GMSI10-UM014
Provides instructions for the use of the XM121 Absolute Shaft module.
Industrial Automation Wiring and Grounding Guidelines,
publication 1770-4.1
Provides general guidelines for installing a Rockwell
Automation industrial system.
Product Certifications website, http://www.ab.com
Provides declarations of conformity, certificates, and
other certification details.
You can view or download publications at
http:/www.rockwellautomation.com/literature/. To order paper copies of
technical documentation, contact your local Allen-Bradley distributor or
Rockwell Automation sales representative.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
11
Preface
Notes:
12
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Chapter
1
Install the XM-124 Standard Dynamic
Measurement Module
This chapter discusses how to install and wire the XM-124 Standard Dynamic
Measurement Module (catalog number 1440-SDM02-01RA). It also describes
the module indicators and the basic operations of the module.
Topic
Page
XM Installation Requirements
17
Mount the Terminal Base Unit
23
Wire the Terminal Base Unit
27
Connecting Power
30
Electronic Data Sheets
55
ADR for XM Modules
56
Power Up the Module
57
ATTENTION: Environment and Enclosure
This equipment is intended for use in a Pollution Degree 2 industrial
environment, in overvoltage Category II applications (as defined in
IEC 60664-1), at altitudes up to 2000 m (6562 ft) without derating.
This equipment is not intended for use in residential environments and may not
provide adequate protection to radio communication services in such.
This equipment is supplied as open-type equipment. It must be mounted within an
enclosure that is suitably designed for those specific environmental conditions that
will be present and appropriately designed to prevent personal injury resulting
from accessibility to live parts. The enclosure must have suitable flame-retardant
properties to prevent or minimize the spread of flame, complying with a flame
spread rating of 5VA or be approved for the application if nonmetallic. The interior
of the enclosure must be accessible only by the use of a tool. Subsequent sections
of this publication may contain additional information regarding specific enclosure
type ratings that are required to comply with certain product safety certifications.
In addition to this publication, see the following:
• Industrial Automation Wiring and Grounding Guidelines, publication 1770-4.1,
for additional installation requirements
• NEMA 250 and IEC 60529, as applicable, for explanations of the degrees of
protection provided by enclosures
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
13
Chapter 1
Install the XM-124 Standard Dynamic Measurement Module
ATTENTION: Prevent Electrostatic Discharge
This equipment is sensitive to electrostatic discharge, which can cause internal
damage and affect normal operation. Follow these guidelines when you handle
this equipment:
• Touch a grounded object to discharge potential static.
• Wear an approved grounding wrist strap.
• Do not touch connectors or pins on component boards.
• Do not touch circuit components inside the equipment.
• Use a static-safe workstation, if available.
• Store the equipment in appropriate static-safe packaging when not in use.
European Hazardous Location Approval
European Zone 2 Certification (The following applies when the product bears the Ex Marking)
This equipment is intended for use in potentially explosive atmospheres as defined by European Union Directive 94/9/EC
and has been found to comply with the Essential Health and Safety Requirements relating to the design and
construction of Category 3 equipment intended for use in Zone 2 potentially explosive atmospheres, given in Annex II to
this Directive.
Compliance with the Essential Health and Safety Requirements has been assured by compliance with EN 60079-0, EN
60079-15, and EN 60079-11.
ATTENTION: This equipment is not resistant to sunlight or other sources of UV
radiation.
WARNING: The following warnings apply to installations of the XM-124.
• This equipment must be installed in an enclosure providing at least IP54
protection when applied in Zone 2 environments.
• This equipment shall be used within its specified ratings defined by Rockwell
Automation.
• Provision shall be made to prevent the rated voltage from being exceeded by
transient disturbances of more than 140% of the rated voltage when applied in
Zone 2 environments.
• Secure any external connections that mate to this equipment by using screws,
sliding latches, threaded connectors, or other means provided with this
product.
• Do not disconnect equipment unless power has been removed or the area is
known to be nonhazardous.
• This equipment shall be mounted in an ATEX certified enclosure with a
minimum ingress protection rating of at least IP54 (as defined in IEC60529)
and used in an environment of not more than Pollution Degree 2 (as defined in
IEC 60664-1) when applied in Zone 2 environments. The enclosure must use a
tool removable cover or door.
• This equipment must be used only with ATEX certified Rockwell Automation
terminal bases.
14
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Install the XM-124 Standard Dynamic Measurement Module
Chapter 1
North American Hazardous Location Approval
Introduction
The following information applies when operating
this equipment in hazardous locations:
Informations sur l'utilisation de cet équipement
en environnements dangereux:
Products marked "CL I, DIV 2, GP A, B, C, D" are suitable for
use in Class I Division 2 Groups A, B, C, D, Hazardous
Locations and nonhazardous locations only. Each product is
supplied with markings on the rating nameplate
indicating the hazardous location temperature code. When
combining products within a system, the most adverse
temperature code (lowest "T" number) may be used to
help determine the overall temperature code of the
system. Combinations of equipment in your system are
subject to investigation by the local Authority Having
Jurisdiction at the time of installation.
Les produits marqués "CL I, DIV 2, GP A, B, C, D" ne
conviennent qu'à une utilisation en environnements de
Classe I Division 2 Groupes A, B, C, D dangereux et non
dangereux. Chaque produit est livré avec des marquages
sur sa plaque d'identification qui indiquent le code de
température pour les environnements dangereux.
Lorsque plusieurs produits sont combinés dans un
système, le code de température le plus défavorable
(code de température le plus faible) peut être utilisé pour
déterminer le code de température global du système.
Les combinaisons d'équipements dans le système sont
sujettes à inspection par les autorités locales qualifiées
au moment de l'installation.
WARNING:
Explosion Hazard • Do not disconnect equipment
unless power has been removed or
the area is known to be
nonhazardous.
• Do not disconnect connections to
this equipment unless power has
been removed or the area is known
to be nonhazardous. Secure any
external connections that mate to
this equipment by using screws,
sliding latches, threaded
connectors, or other means
provided with this product.
• Substitution of components may
impair suitability for Class I,
Division 2.
• If this product contains batteries,
they must only be changed in an
area known to be nonhazardous.
AVERTISSEMENT:
Risque d’Explosion • Couper le courant ou s'assurer
que l'environnement est classé
non dangereux avant de
débrancher l'équipement.
• Couper le courant ou s'assurer
que l'environnement est classé
non dangereux avant de
débrancher les connecteurs. Fixer
tous les connecteurs externes
reliés à cet équipement à l'aide de
vis, loquets coulissants,
connecteurs filetés ou autres
moyens fournis avec ce produit.
• La substitution de composants
peut rendre cet équipement
inadapté à une utilisation en
environnement de Classe I,
Division 2.
• S'assurer que l'environnement est
classé non dangereux avant de
changer les piles.
The XM-124 standard dynamic measurement module is part of the
Allen-Bradley® XM® Series, a family of distributed machine condition monitoring
and protection devices. The 1440-SDM02-01RA is a 2-channel general purpose
monitor that supports measurements of dynamic inputs such as vibration,
pressure, and strain as well as position measurements. The module is typically
used to monitor shaft, casing, and pedestal vibration in rotating equipment.
Inputs accepted include non-contact eddy current probes, standard integrated
electronics piezoelectric (IEPE) accelerometers, velocity transducers, AC voltage
output, or DC voltage output measurement devices. The module also accepts a
tachometer input to provide speed measurement and order analysis functions.
The module can work with most tachometer signal sources including eddy
current probe, unpowered magnetic probe, and other powered and unpowered
tachometer sensors.
Outputs include digital measures communicated via a DeviceNet network, two
4…20 mA analog outputs, and a single onboard relay. Output buffers exist for
each vibration input channel as well as for the tachometer input.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
15
Chapter 1
Install the XM-124 Standard Dynamic Measurement Module
The module provides onboard processing of critical vibration parameters and
advanced alarm and relay logic. The XM-124 module can act independently, or it
can serve data to integrated automation and control systems that can then act to
protect machinery from failures or inform operators of abnormal conditions or
fault.
Module Components
Operation of the XM-124 standard dynamic measurement module requires the
XM-940 Dynamic Measurement Module Terminal Base Unit (not included).
Figure 1 - XM-124 Module Components
DY NAMIC ME A
S U R E ME N
XM-940 Dynamic Measurement Module
Terminal Base Unit
Catalog Number 1440-TB-A
T
XM-124 Standard Dynamic Measurement
Module
Catalog Number 1440-SDM02-01RA
• XM-940 Dynamic Measurement Module Terminal Base - A DIN railmounted base unit that provides terminations for all field wiring required
by XM vibration modules, including the XM-124 module.
IMPORTANT
XM-124 module certifications are valid only when used with the 1440-TBA/C revision of the terminal base.
• XM-124 Standard Dynamic Measurement Modules - The modules mount
on the XM-940 terminal base via a keyswitch and a 96-pin connector. The
modules contain the measurement electronics, processors, relay, and serial
interface port for local configuration.
IMPORTANT
16
The XM-441 Expansion Relay module may be connected to the XM-124
module via the XM-940 terminal base. When connected to the module, the
Expansion Relay module simply ‘expands’ the capability of the XM-124
module by adding four additional epoxy-sealed relays. The module controls
the Expansion Relay module by extending to it the same logic and
functional controls as the on-board relay.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Install the XM-124 Standard Dynamic Measurement Module
XM Installation
Requirements
Chapter 1
This section describes wire, power, grounding, and terminating resistor
requirements for an XM system.
ATTENTION: The installation requirements may be different for different
XM modules. The following requirements apply only to the 1440-SDM0201RA module. Refer to the user manual for the specific XM module for its
requirements.
The XM-124 module is designed so that it may be used to replace an XM120 or XM-121 module, revisions D01 or later. If an earlier revision of an
XM-120/XM-121 module is being replaced, wiring changes may be
required. Refer to the XM-120/XM-121 User Manual for details.
If replacing an XM-120/XM-121 module and the XM-120/X-121’s onboard
relay is being used, be sure that the relay requirements and wiring solution
are considered, as differences exist between the onboard relays of the
XM-120/XM-121 and the XM-124 module.
ATTENTION: The XM-124 module requires a minimum clearance of 25 mm
(1 in.) from the top and bottom of the device.
Wiring Requirements
Use solid or stranded wire. All wiring must meet the following specifications:
• 2.1…0.3 mm2 (14…22 AWG) copper conductors without pretreatment;
8.4 mm2 (8 AWG) required for grounding the DIN rail for
electromagnetic interference (EMI) purposes
• Recommended strip length 8 mm (0.31 in.)
• Minimum insulation rating of 300V
• Soldering the conductor is forbidden
• Wire ferrules can be used with stranded conductors; copper ferrules
recommended
Power Requirements
Before installing your module, calculate the power requirements of all modules
interconnected via their side connectors. The total current draw through the side
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
17
Chapter 1
Install the XM-124 Standard Dynamic Measurement Module
connector cannot exceed 3 A. Refer to the specifications for the specific modules
for power requirements.
ATTENTION: A separate power connection is necessary if the total current draw
of the interconnecting modules is greater than 3 A.
Figure 2 is an illustration of wiring modules using separate power connections.
Figure 2 - XM Modules with Separate Power Connections
Any limited power
source that satisfies
the requirements
specified below
Table 1 - Power Supply Requirements
XM Power Supply Requirements
Protection
Listed Class 2 rated supply
Fused (1) ITE Listed SELF supply
Fused (1) ITE Listed PELV supply
18
Output Voltage
24V DC ± 10%
Output Power
100 W max (~4 A @ 24V DC)
Static Regulation
±2%
Dynamic Regulation
±3%
Ripple
<100 mV pp
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Install the XM-124 Standard Dynamic Measurement Module
Chapter 1
XM Power Supply Requirements
Output Noise
Per EN50081-1
Overshoot
< 3% at turn-on, < 2% at turn-off
Hold-up Time
As required (typically 50 mS at full rated load)
(1) When a fused supply is used, the fuse must be a 5 A, listed, fast-acting fuse such as provided by Allen-Bradley part number 14405AFUSEKIT.
See XM Power Supply Solutions Application Technique, publication ICM-AP005,
for guidance in architecting power supplies for XM systems.
IMPORTANT
Grounding Requirements
Use these grounding requirements to be sure of safe electrical operating
circumstances, and to help avoid potential EMI and ground noise that can cause
unfavorable operating conditions for your XM system.
DIN Rail Grounding
ATTENTION: This product is grounded through the DIN rail to chassis ground.
Use zinc-plated yellow-chromate steel DIN rail to assure proper grounding. The
use of other DIN rail materials (for example, aluminum or plastic) that can
corrode, oxidize, or are poor conductors, can result in improper or intermittent
grounding. Secure DIN rail to mounting surface approximately every 200 mm
(7.8 in.) and use end-anchors appropriately.
The DIN rail must be connected to a ground bus or grounding electrode
conductor using (8.4 mm2) 8 AWG or 1-in. copper braid. The grounding wire
can be connected to the DIN rail using a DIN rail grounding block.
Figure 3 - DIN Rail Grounding Block
1
1
Use 8.4 mm (8 AWG) wire.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
19
Chapter 1
Install the XM-124 Standard Dynamic Measurement Module
Figure 4 - XM System DIN Rail Grounding
1
1440-VST02-01RA
DYNAMIC MEASUREMENT
1440-REX00-04RD
EXPANSION RELAY
1440-VST02-01RA
DYNAMIC MEASUREMENT
1440-REX00-04RD
EXPANSION RELAY
Power
Supply
2
2
1440-RMA00-04RC
MASTER RELAY
1440-REX00-04RD
EXPANSION RELAY
1440-TSP02-01RB
POSITION
1440-REX00-04RD
EXPANSION RELAY
2
1
1440-VST02-01RA
DYNAMIC MEASUREMENT
1440-REX00-04RD
EXPANSION RELAY
1440-VST02-01RA
DYNAMIC MEASUREMENT
1440-REX00-04RD
EXPANSION RELAY
Power
Supply
1
Use 2.1 mm2 (14 AWG) wire.
2
Use 8.4 mm2 (8 AWG) wire.
Panel/Wall Mount Grounding
The XM modules can also be mounted to a conductive mounting plate that is
grounded. See Figure 6. Use the grounding screw hole provided on the terminal
base to connect the mounting plate to the Functional Earth terminals. See
Figure 5.
20
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Install the XM-124 Standard Dynamic Measurement Module
Chapter 1
Figure 5 - Grounding Screw on XM Terminal Base
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
21
Chapter 1
Install the XM-124 Standard Dynamic Measurement Module
Figure 6 - Panel/Wall Mount Grounding
2
1
Class 2
Supply
1
Class 2
Supply
1
Use 2.1 mm2 (14 AWG) wire. If it is desired to isolate the power supply because of possible ground loops, do not connect 24V
common to earth, as illustrated.
2
Use 8.4 mm2 (8 AWG) wire.
24V Common Grounding
The XM system is sourced by a single Class 2 power supply. We recommend that
the 24V power to the XM modules is grounded.
22
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Install the XM-124 Standard Dynamic Measurement Module
Chapter 1
DeviceNet Grounding
The XM-124 and XM-940 are able to use an external DeviceNet power supply. If
DeviceNet V- is not grounded elsewhere, connect DeviceNet V- to earth ground
at one of the XM modules, as shown in Figure 7.
Figure 7 - Grounded DeviceNet V- at XM Module
To
Ground
Bus
Figure 8 - Grounded DeviceNet V- at DeviceNet Power Supply
DNet
Power
Supply
V-
V+
DNet Power V+
DNet Power V-
For more information on the DeviceNet installation, refer to the ODVA
Planning and Installation Manual - DeviceNet Cable System, which is available
on the ODVA website (http://www.odva.org).
Mount the Terminal Base
Unit
The XM family includes several different terminal base units to serve all of the
XM modules. The 1440-TB-A/C terminal base is the only terminal base used
with the XM-124 standard dynamic measurement module (catalog number
1440-SDM02-01RA).
The terminal base can be DIN rail or wall/panel mounted.
WARNING: If you insert or remove the module while backplane power is on, an
electrical arc can occur. This could cause an explosion in hazardous location
installations.
Be sure that power is removed or the area is nonhazardous before proceeding.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
23
Chapter 1
Install the XM-124 Standard Dynamic Measurement Module
ATTENTION: Do not remove or replace a Terminal Base unit while power is
applied. Interruption of the backplane can result in unintentional operation or
machine motion.
IMPORTANT Install the overlay slide label to protect serial connector and electronics when the
serial port is not in use.
IMPORTANT XM-124 module certifications are valid only when used with the 1440-TBA/C revision of the terminal base.
Mount the Terminal Base Unit on a DIN Rail
Use the following steps to mount the terminal base unit on a DIN rail
(Allen-Bradley catalog no. 199-DR1 or 199-DR4).
1. Position the terminal base on the 35 x 7.5 mm DIN rail (A).
A
B
A
31887-M
Position terminal base at a slight angle and hook over the top of the DIN rail.
2. Slide the terminal base unit over leaving room for the side connector (B).
24
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Install the XM-124 Standard Dynamic Measurement Module
Chapter 1
3. Rotate the terminal base onto the DIN rail with the top of the rail hooked
under the lip on the rear of the terminal base.
31883-M
4. Press down on the terminal base unit to lock the terminal base on the DIN
rail.
If the terminal base does not lock into place, use a screwdriver or similar
device to open the locking tab, press down on the terminal base until flush
with the DIN rail and release the locking tab to lock the base in place.
Interconnect Terminal Base Units
Follow the steps below to install another terminal base unit on the DIN rail.
IMPORTANT
Terminal base units are mounted left to right on the DIN rail.
1. Position the terminal base on the 35 x 7.5 mm DIN rail (A).
2. Make certain the side connector (B) is fully retracted into the base unit.
3. Slide the terminal base unit over tight against the neighboring terminal
base.
Make sure the hook on the terminal base slides under the edge of the
terminal base unit.
4. Press down on the terminal base unit to lock the terminal base on the DIN
rail.
If the terminal base does not lock into place, use a screwdriver or similar
device to open the locking tab, press down on the terminal base until flush
with the DIN rail and release the locking tab to lock the base in place.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
25
Chapter 1
Install the XM-124 Standard Dynamic Measurement Module
5. Gently push the side connector into the side of the neighboring terminal
base to complete the backplane connection.
Mount to Panel or Wall
Installation on a wall or panel consists of the following:
• Laying out the drilling points on the wall or panel
• Drilling the pilot holes for the mounting screws
• Installing the terminal base units and securing them to the wall or panel
Use the following steps to install the terminal base on a wall or panel.
1. Lay out the required points on the wall/panel as shown in the drilling
dimension drawing below.
Side Connector
40.10
[1.577]
35.51
[1.398]
23.50
[.925]
94.01
[3.701]
2. Drill the necessary holes for the #6 self-tapping mounting screws.
3. Secure the terminal base unit using two #6 self-tapping screws.
To install another terminal base unit, retract the side connector into the
base unit.
Make sure it is fully retracted.
26
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Install the XM-124 Standard Dynamic Measurement Module
Chapter 1
4. Position the terminal base unit up tight against the neighboring terminal
base.
Make sure the hook on the terminal base slides under the edge of the
terminal base unit.
5. Gently push the side connector into the side of the neighboring terminal
base to complete the backplane connection.
6. Secure the terminal base to the wall with two #6 self-tapping screws.
Wire the Terminal Base Unit
Wiring to the module is made through the terminal base unit on which the
module mounts. The XM-124 module is compatible only with the XM-940
terminal base unit, catalog number 1440-TB-A.
Figure 9 - XM-940 Terminal Base Unit
XM-940 (catalog number 1440-TB-A)
Terminal Block Assignments
The terminal block assignments for the XM-124 standard dynamic measurement
module are described below.
ATTENTION: The terminal block assignments are different for different
XM modules. Table 2 applies only to the XM-124 module.
Refer to the installation instructions for the specific XM module for its
terminal assignments.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
27
Chapter 1
Install the XM-124 Standard Dynamic Measurement Module
The XM module’s revision number is on the product label (which is on the
front of the XM module, as shown below).
TIP
Revision Number of
XM Module
WARNING: EXPLOSION HAZARD. Do not disconnect connections to this
equipment unless power has been removed or the area is known to be
nonhazardous. Secure any external connections that mate to this
equipment by using screws, sliding latches, threaded connectors, or
other means provided with this product.
Table 2 - Terminal Block Assignments
28
No.
Name
Description
0
Xducer 1 (+)
Vibration transducer 1 connection
1
Xducer 2 (+)
Vibration transducer 2 connection
2
Buffer 1 (+)
Vibration signal 1 buffered output
3
Buffer 2 (+)
Vibration signal 2 buffered output
4
Tach/Signal In (+)
Tachometer transducer/signal input, positive side
5
Buffer Power 1 IN
Channel 1 buffer power input
Connect to terminal 6 for positive biased transducers or terminal 21 for negative biased
transducers
6
Positive Buffer Bias
Provides positive (-5 V to +24 V) voltage compliance to buffered outputs
Connect to terminals 5 (CH 1) and 22 (CH 2) for positive bias transducers
7
TxD
Personal computer serial port, transmit data
8
RxD
Personal computer serial port, receive data
9
XRTN1
Circuit return for TxD and RxD
10
Chassis
Connection to DIN rail ground spring or panel mounting hole
11
4…20 mA 1 (+)
12
4…20 mA 1 (-)
4…20 mA output
300 ohm maximum load
13
Chassis
Connection to DIN rail ground spring or panel mounting hole
14
Chassis
Connection to DIN rail ground spring or panel mounting hole
15
Chassis
Connection to DIN rail ground spring or panel mounting hole
16
Xducer 1 (-)1
Vibration transducer 1 connection
17
1
Xducer 2 (-)
Vibration transducer 2 connection
18
Signal Common1
Vibration buffered output return
19
TACH Buffer
Tachometer transducer/signal output
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Install the XM-124 Standard Dynamic Measurement Module
Chapter 1
Table 2 - Terminal Block Assignments
No.
Name
Description
20
Tachometer (-)
Tachometer transducer/signal return, TACH Buffer return
21
Buffer/Xducer Pwr (-)
Provides negative (-24 V to +9 V) voltage compliance to buffered outputs
Connect to terminals 5 (CH 1) and 22 (CH 2) for negative bias transducers
Transducer power supply output, negative side; used to power external sensor (40 mA maximum
load)
22
Buffer Power 2 IN
Channel 2 buffer power input
Connect to terminal 6 for positive biased transducers or terminal 21 for negative biased
transducers
23
CAN_High
DeviceNet bus connection, high differential (white wire)
24
CAN_Low
DeviceNet bus connection, low differential (blue wire)
25
+24 V Out
Internally connected to 24 V In 1 (terminal 44)
Used to daisy chain power if XM modules are not plugged into each other
If power is not present on terminal 44, there is no power on this terminal
26
DNet V (+)
DeviceNet bus power input, positive side (red wire)
27
DNet V (-)
DeviceNet bus power input, negative side (black wire)
28
24 V Common1
Internally connected to 24 V Common (terminals 43 and 45)
Used to daisy chain power if XM modules are not plugged into each other
29
4…20 mA 2 (+)
30
4…20 mA 2 (-)
4…20 mA output
300 ohm maximum load
31
Chassis
Connection to DIN rail ground spring or panel mounting hole
32
Chassis
Connection to DIN rail ground spring or panel mounting hole
33
Chassis
Connection to DIN rail ground spring or panel mounting hole
34
Chassis
Connection to DIN rail ground spring or panel mounting hole
35
Chassis
Connection to DIN rail ground spring or panel mounting hole
36
Chassis
Connection to DIN rail ground spring or panel mounting hole
37
Chassis
Connection to DIN rail ground spring or panel mounting hole
38
Chassis
Connection to DIN rail ground spring or panel mounting hole
39
SetPtMult
Switch input to activate Set Point Multiplication (active closed)
40
Switch RTN
Switch return, shared between SetPtMult and Reset Relay
41
Reset Relay
Switch input to reset internal relay (active closed)
42
Reserved
43
24 V Common1
Internally DC-coupled to circuit ground
44
+24 V In
Connection to primary external +24 V power supply, positive side
45
24 V Common1
Connection to external +24 V power supply, negative side (internally DC-coupled to circuit
ground)
46
Reserved
47
Relay Common
Relay Common contact
48
Relay N.O.
Relay Normally Open contact
49
Reserved
50
Reserved
51
Reserved
1
Terminals are internally connected and isolated from the chassis terminals.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
29
Chapter 1
Install the XM-124 Standard Dynamic Measurement Module
Connecting Power
Power supplied to the module must be nominally 24V DC (±10%) and must be a
Class 2 rated source.
Wire the DC-input power supply to the terminal base unit as shown in
Figure 10.
Figure 10 - DC Input Power Supply Connections
24V dc
Power
Supply
+
-
-
IMPORTANT
A Class 2 circuit can be provided by use of an NEC Class 2 rated power
supply, or by using a SELV or PELV rated power supply with a 5 A current
limiting fuse installed before the XM module.
IMPORTANT
24V DC needs to be wired to terminal 44 (+24V In) to provide power to the
device and other XM modules linked to the wired terminal base via the side
connector.
ATTENTION: The power connections are different for different XM
modules. Refer to the installation instructions for your specific XM
module for complete wiring information.
Connect the Relay
The XM-124 module has Normally Open relay contacts, which close when the
control output is energized.
The alarms associated with the relay and whether the relay is normally deenergized (non-failsafe) or normally energized (failsafe) depends on the
configuration of the module. Refer to Relay Parameters on page 82 for details.
30
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Install the XM-124 Standard Dynamic Measurement Module
Chapter 1
Table 3 shows the on-board relay connections for the modules.
TIP
The Expansion Relay module can be connected to the module to provide
additional relays. Refer the XM-441 Expansion Relay Module User Manual
for wiring details.
IMPORTANT
The NO terminal descriptions correspond to a de-energized (unpowered)
relay.
When the relay is configured for non-failsafe operation, the relay is
normally de-energized.
When the relay is configured for failsafe operation, the relay is normally
energized, and the behavior of the NO terminals is inverted.
Table 3 - Relay Connections for the XM-124 Module
Configured for
Failsafe Operation
Wire Contacts
Nonalarm
Alarm
Closed
Opened
Configured for
Non-Failsafe Operation
COM
47
NO
48
Wire Contacts
Nonalarm
Alarm
Opened
Closed
Relay Terminals
Relay Terminals
Contact
COM
47
NO
48
Figure 11 - Relay Connection Wiring, Normally Closed and Normally Opened
Contact
Contact
COM NO
COM NO
Power
Source
+
–
Power
Source
M
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
+
–
32377 M
31
Chapter 1
Install the XM-124 Standard Dynamic Measurement Module
Connect the Tachometer Signal
The XM-124 module provides a single tachometer input signal. The signal
processing performed on the tachometer signal depends on the configuration of
the module. See page 78 for a description of the tachometer parameters.
IMPORTANT
If you are not using the tachometer input, set the Pulses per Revolution
parameter to zero (0). This disables the tachometer measurement and
prevents the module from indicating a tachometer fault (TACH indicator
flashing yellow). A tachometer fault occurs when no signal pulses are
received on the tachometer input signal for a relatively long period.
Connecting a Magnetic Pickup Tachometer
Figure 12 shows the wiring of a magnetic pickup tachometer to the terminal base
unit.
Figure 12 - Magnetic Pickup Tachometer Signal Connection
Connecting a Hall Effect Tachometer Sensor
Figure 13 shows the wiring of a Hall Effect Tachometer Sensor, catalog number
44395, to the terminal base unit.
Figure 13 - Hall Effect Tachometer Signal Connection
32
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Install the XM-124 Standard Dynamic Measurement Module
Chapter 1
Connecting a Non-contact Sensor to the Tachometer Signal
Figure 14 shows the wiring of a non-contact sensor to the tachometer input
signal.
Figure 14 - Non-contact Sensor to Tachometer Signal Connection
4
18
Signal Common
20 21
31
Tach Input Signal
-24V DC
-24
SIG
COM
S hield Floating
Shield
Isolated Sensor Dri ver
Connect the Buffered Outputs
The XM-124 module provides buffered outputs of all transducer input signals.
The buffered output connections can be used to connect the module to portable
data collectors or other online systems.
Figure 15 shows the buffered output connections for the modules.
Figure 15 - Buffered Output Connections
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
33
Chapter 1
Install the XM-124 Standard Dynamic Measurement Module
IMPORTANT
The voltage operating range of the buffered outputs must be configured to
coincide with the corresponding transducer bias range. This operating
range is configured by placing a jumper from terminal 5 (channel 1) and
terminal 22 (channel) to either terminal 6 (Positive Buffer Bias) or terminal
21 (Buffer -), depending on the transducer. See Table 4. The buffered
output operating range is configured independently per channel.
Table 4 - Configuring Buffered Output Input Range
Transducer
Input Range
Channel
Connect Terminal
To Terminal
Negative Bias
-24…9V
1
5
21
2
22
21
1
5
6
2
22
6
1
----
----
2
----
----
Positive Bias
Non-Bias
-5…24V
-5…9V
Connect the Transducer
The XM-124 module can accept inputs from any Allen-Bradley non-contact
eddy current probe, a standard IEPE accelerometer, a velocity transducer, AC
voltage output, or a DC voltage output measurement device.
Connect an IEPE Accelerometer
The following figures show the wiring of an IEPE accelerometer to the terminal
base unit.
ATTENTION: You may ground the cable shield at either end of the cable.
Do not ground the shield at both ends. Recommended practice is to
ground the cable shield at the terminal base and not at the transducer.
Any convenient chassis terminal may be used (see Terminal Block
Assignments on page 27).
34
IMPORTANT
The internal transducer power supply is providing power to the IEPE
accelerometer. Make certain the IEPE Power parameter is enabled. Refer
to Transducer Object (Class ID 328H) on page 154.
IMPORTANT
A jumper from terminal 5 to terminal 6 is required for channel 1 buffered
output. A jumper from terminal 22 to terminal 6 is required for channel 2
buffered output. See Connect the Buffered Outputs on page 33.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Install the XM-124 Standard Dynamic Measurement Module
Chapter 1
Figure 16 - IEPE Accelerometer to Channel 1 Wiring
TYPICAL WIRING
FOR IEPEWIRING
ACCELEROMETER
TYPICAL
FOR IEPE ACCELEROMETER
TO
STANDARD DYNAMIC MEASUREMENT
MODULE CHANNEL
1
TOXM-124
XM-120/121DYNAMIC
MEASUREMENT
MODULE
CHANNEL 1
Pin A - Signal
Pin B - Common
Cable shield not
connected at this end
Signal Common
Channel 1 Input Signal
16
Shield
0
37
Jumpering terminal 5
to terminal 6 configures
CH 1 buffer for -5V to +24V
5
6
Figure 17 - IEPE Accelerometer to Channel 2 Wiring
TYPICAL
WIRING FOR IEPE ACCELEROMETER
TYPICAL WIRING
FOR IEPE ACCELEROMETER
TO XM-120/121 DYNAMIC MEASUREMENT MODULE CHANNEL 2
TO XM-124 STANDARD DYNAMIC MEASUREMENT MODULE CHANNEL 2
Pin A - Signal
Pin B - Common
Cable shield not
connected at this end
Channel 1 Input Signal
Signal Common
Channel 2 Input Signal
Shield
17
38
22
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
1
6
Jumpering terminal 6 to
terminal 22 configures
CH 2 buffer for -5V to +24V
35
Chapter 1
Install the XM-124 Standard Dynamic Measurement Module
Connect a Non-contact Sensor
The figures below show the wiring of a non-contact sensor to the terminal base
unit.
ATTENTION: You may ground the cable shield at either end of the cable.
Do not ground the shield at both ends. Recommended practice is to
ground the cable shield at the terminal base and not at the transducer.
Any convenient chassis terminal may be used (see Terminal Block
Assignments on page 27).
IMPORTANT
The internal transducer power supply is providing power to the non-contact
sensor.
IMPORTANT
A jumper from terminal 5 to terminal 21 is required for channel 1 buffered
output. A jumper from terminal 22 to terminal 21 is required for channel 2
buffered output. See Connect the Buffered Outputs on page 33.
Figure 18 - Non-contact Sensor to Channel 1 Wiring
TYPICAL
WIRING FOR
NON-CONTACT
TYPICAL
WIRING
FORSENSOR
NON-CONTACT SENSOR
TO XM-120/121
DYNAMIC
MEASUREMENT
MODULE
TO XM-124 STANDARD
DYNAMIC
MEASUREMENT MODULE
CHANNEL 1 CHANNEL 1
Isolated Sensor Driver
-24
SIG
COM
Shield
Floating
Signal Common
Channel 1 Input Signal
Shield
-24V DC
36
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
16
0
37
21
5
Jumpering terminal 5 to
terminal 21 configures
CH 1 buffer for -24V to +9V
Install the XM-124 Standard Dynamic Measurement Module
Chapter 1
Figure 19 - Non-contact Sensor to Channel 2 Wiring
TYPICAL
WIRINGWIRING
FOR NON-CONTACT
SENSOR
TYPICAL
FOR NON-CONTACT
SENSOR
TO XM-124 STANDARD
DYNAMIC
MEASUREMENT MODULE
CHANNEL CHANNEL
2
TO XM-120/121
DYNAMIC
MEASUREMENT
MODULE
2
Isolated Sensor Driver
-24
SIG
COM
Shield
Floating
Signal Common
Channel 2 Input Signal
Shield
-24V DC
17
1
38
21
22
Jumpering terminal 21 to
terminal 22 configures
CH 2 buffer for -24V to +9V
Connect a Passive Transducer
The figures below show the wiring of a passive transducer, such as a velocity
sensor, to the terminal base unit.
ATTENTION: You may ground the cable shield at either end of the cable.
Do not ground the shield at both ends. Recommended practice is to
ground the cable shield at the terminal base and not at the transducer.
Any convenient chassis terminal may be used (see Terminal Block
Assignments on page 27).
IMPORTANT
The module does not power the sensor. It measures only the input voltage.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
37
Chapter 1
Install the XM-124 Standard Dynamic Measurement Module
Figure 20 - Velocity Sensor to Channel 1 Wiring
TYPICALTYPICAL
WIRING FOR WIRING
COIL-BASEDFOR
VELOCITY
SENSOR
COIL-BASED
VELOCITY SENSOR
TO XM-124
DYNAMIC
MEASUREMENT
MODULE CHANNEL 1MODULE CHANNEL 1
TOSTANDARD
XM-120/121
DYNAMIC
MEASUREMENT
Pin A - Common
Pin B - Signal
Cable shield not
connected at this end
Signal Common
Channel 1 Input Signal
Shield
16
0
37
Figure 21 - Velocity Sensor to Channel 2 Wiring
TYPICAL WIRINGTYPICAL
FOR COIL-BASED
VELOCITY
SENSOR
WIRING
FOR
COIL-BASED VELOCITY SENSOR
TO XM-124TO
STANDARD
DYNAMICDYNAMIC
MEASUREMENT
MODULE CHANNEL 2 MODULE CHANNEL 2
XM-120/121
MEASUREMENT
Pin A - Common
Pin B - Signal
Cable shield not
connected at this end
Signal Common
Channel 2 Input Signal
Shield
38
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
17
1
38
Install the XM-124 Standard Dynamic Measurement Module
Chapter 1
Connect a Powered Sensor
The figures below show the wiring of a powered sensor, such as the Model 580
Vibration Pickup, to the terminal base unit.
ATTENTION: You may ground the cable shield at either end of the cable.
Do not ground the shield at both ends. Recommended practice is to
ground the cable shield at the terminal base and not at the transducer.
Any convenient chassis terminal may be used (see Terminal Block
Assignments on page 27).
IMPORTANT
A jumper from terminal 5 to terminal 6 is required for channel 1 buffered
output. A jumper from terminal 22 to terminal 6 is required for channel 2
buffered output. See Connect the Buffered Outputs on page 33.
ATTENTION: Figure 22 and Figure 23 show the wiring of a Model 580
Vibration Pickup, which is a +24 V transducer. The +24 V sensors
powered from pin 25 do not use the redundant power connection to
the XM-124 module. So if primary 24 V power is lost, the +24 V sensor
will lose power regardless of whether the XM-124 module remains
powered through the redundant power terminals.
If redundant power is required then use a redundant power supply (AllenBradley 1606-series is recommended).
Figure 22 - Powered Sensor to Channel 1 Wiring
WIRING
FOR
MODEL 580 VIBRATION PICKUP
TYPICAL WIRINGTYPICAL
FOR MODEL 580
VIBRATION
PICKUP
TO XM-120/121 DYNAMIC MEASUREMENT MODULE CHANNEL 1
TO XM-124 STANDARD DYNAMIC MEASUREMENT MODULE CHANNEL 1
+24V DC
Common
Signal
Cable shield not
connected at this end
Signal Common
Channel 1 Input Signal
Shield
16
0
37
5
6
+24V DC
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Jumpering terminal 5
to terminal 6 configures
CH 1 buffer for -5V to +24V
25
39
Chapter 1
Install the XM-124 Standard Dynamic Measurement Module
Figure 23 - Powered Sensor to Channel 2 Wiring
WIRING FOR MODEL 580 VIBRATION PICKUP
TYPICAL WIRINGTYPICAL
FOR MODEL 580
VIBRATION PICKUP
TO XM-120/121 DYNAMIC MEASUREMENT MODULE CHANNEL 2
TO XM-124 STANDARD DYNAMIC MEASUREMENT MODULE CHANNEL 2
+24V DC
Common
Signal
Cable shield not
connected at this end
Signal Common
Channel 2 Input Signal
Shield
17
38
22
+24V DC
1
6
Jumpering terminal 6
to terminal 22 configures
CH 2 buffer for -5V to +24V
25
Connect a Process DC Voltage Signal
The following figures show the wiring from a process DC voltage signal to the
terminal base unit.
ATTENTION: You may ground the cable shield at either end of the cable.
Do not ground the shield at both ends. Recommended practice is to
ground the cable shield at the terminal base and not at the transducer.
Any convenient chassis terminal may be used (see Terminal Block
Assignments on page 27).
IMPORTANT
40
The module does not power the sensor. It measures only the input voltage.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Install the XM-124 Standard Dynamic Measurement Module
Chapter 1
Figure 24 - DC Voltage Signal to Channel 1 Wiring
TYPICAL WIRING FOR PROCESS DC VOLTAGE SIGNAL
TYPICAL WIRING
FOR PROCESS DC VOLTAGE SIGNAL
TO XM-120/121 DYNAMIC MEASUREMENT MODULE CHANNEL 1
TO XM-124 STANDARD DYNAMIC MEASUREMENT MODULE CHANNEL 1
Process DC
Source
Cable shield not
connected at this end
Signal Common
Channel 1 Input Signal
Shield
16
0
37
Figure 25 - DC Voltage Signal to Channel 2 Wiring
TYPICAL WIRINGTYPICAL
FOR PROCESSWIRING
DC VOLTAGEFOR
SIGNALPROCESS DC VOLTAGE SIGNAL
XM-120/121
DYNAMIC MEASUREMENT
TO XM-124TO
STANDARD
DYNAMIC MEASUREMENT
MODULE CHANNEL 2 MODULE CHANNEL 2
Process DC
Source
Cable shield not
connected at this end
Signal Common
Channel 2 Input Signal
Shield
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
17
1
38
41
Chapter 1
Install the XM-124 Standard Dynamic Measurement Module
Connect an IEPE Accelerometer and Non-contact Sensor
The following figure shows the wiring of an IEPE accelerometer to channel 1 and
the wiring of a non-contact sensor to channel 2.
ATTENTION: You may ground the cable shield at either end of the cable.
Do not ground the shield at both ends. Recommended practice is to
ground the cable shield at the terminal base and not at the transducer.
Any convenient chassis terminal may be used (see Terminal Block
Assignments on page 27).
42
IMPORTANT
Make certain the IEPE Power parameter for channel 1 is enabled so power
is provided to the accelerometer. Refer to Transducer Object (Class ID 328H)
on page 154.
IMPORTANT
The internal transducer power supply is providing power to the non-contact
sensor.
IMPORTANT
A jumper from terminal 5 to terminal 6 is required for channel 1 buffered
output. A jumper from terminal 22 to terminal 21 is required for channel 2
buffered output. See Connect the Buffered Outputs on page 33.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Install the XM-124 Standard Dynamic Measurement Module
Chapter 1
Figure 26 - IEPE Accelerometer and Non-contact Sensor Wiring
TYPICAL WIRING FOR IEPE ACCELEROMETER AND NON-CONTACT
SENSOR
TO WIRING
XM-120/121
DYNAMIC MEASUREMENT
MODULE
TYPICAL
FOR IFPF ACCELEROMETER
AND NON-CONTACT
SENSOR TO XM-124 STANDARD DYNAMIC MEASUREMENT MODULE
Pin A - Signal
Pin B - Common
Cable shield not
connected at this end
Signal Common
Channel 1 Input Signal
Shield
16
17
0
1
Signal Common
Channel 2 Input Signal
37
*
21
22
-24V DC
5
6
*
*Note: Jumpering terminal 5 to terminal 6
configures CH 1 buffer (-5V to +24V)
Jumpering terminal 21 to terminal 22
configures CH 2 buffer (-24V to +9V)
13
Shield
-24
SIG
COM
S hield Floating
Isolated Sensor Driver
Connect Two Accelerometers and a Non-Contact Sensor
The following figure shows the wiring of two IEPE accelerometers and a noncontact sensor to the terminal base. The IEPE accelerometers are wired to
channel 1 and channel 2. The non-contact sensor is wired to the tachometer
input signal.
WARNING: You may ground the cable shield at either end of the cable.
Do not ground the shield at both ends. Recommended practice is to
ground the cable shield at the terminal base and not at the transducer.
Any convenient chassis terminal may be used (see Terminal Block
Assignments on page 27).
IMPORTANT
Make certain the IEPE Power parameter is enabled for both channel 1 and
channel 2 so power is provided to the accelerometers. Refer to Transducer
Object (Class ID 328H) on page 154.
IMPORTANT
Transducer DC bias is monitored on all signals.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
43
Chapter 1
Install the XM-124 Standard Dynamic Measurement Module
A jumper from terminal 5 to terminal 6 is required for channel 1 buffered
output. A jumper from terminal 22 to terminal 6 is required for channel 2
buffered output. See Connect the Buffered Outputs on page 33.
IMPORTANT
Figure 27 - Two IEPE Accelerometers and a Non-contact Sensor Wiring
TYPICALTYPICAL
WIRING
TWO
ACCELEROMETERS
AND
WIRINGFOR
FOR TWO
IFPF IEPE
ACCELEROMETERS
AND
NON-CONTACT SENSOR
XM-120/121
DYNAMIC
MEASUREMENT
NON-CONTACTTO
SENSOR
TO XM-124 STANDARD
DYNAMIC
MEASUREMENT MODULEMODULE
Pin A - Signal
Pin B - Common
Pin A - Signal
Pin B - Common
Cable shield not
connected at this end
Cable shield not
connected at this end
Signal Common
Channel 1 Input Signal
Shield
Signal Common
Tach Input Signal
-24V DC
*
36
37
16
17
18
20
21
22
0
1
4
5
6
Signal Common
Channel 2 Input Signal
Shield
*
* Note: Jumpering terminal 5 to terminal 6
configures CH 1 buffer (-5V to +24V)
Jumpering terminal 22 to terminal 6
configures CH 2 buffer (-5V to +24V)
Shield
31
-24
SIG
COM
Shield
Floating
Isolated Sensor Driver
Connect a Velocity Sensor and Two Non-contact Sensors
The following figure shows the wiring of a velocity sensor and two non-contact
sensors to the terminal base unit. The velocity sensor is wired to channel 1. The
first non-contact sensor is wired to channel 2, and the other non-contact sensor is
wired to the tachometer input signal.
ATTENTION: You may ground the cable shield at either end of the cable.
Do not ground the shield at both ends. Recommended practice is to
ground the cable shield at the terminal base and not at the transducer.
Any convenient chassis terminal may be used (see Terminal Block
Assignments on page 27).
44
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Install the XM-124 Standard Dynamic Measurement Module
Chapter 1
IMPORTANT
Transducer DC bias is monitored on all signals.
IMPORTANT
A jumper from terminal 22 to terminal 21 is required for channel 2 buffered
output. See Connect the Buffered Outputs on page 33.
Figure 28 - Velocity Sensor and Two Non-contact Sensor Wiring
TYPICAL WIRING FOR COIL-BASED VELOCITY SENSOR AND TWO
NON-CONTACT SENSORS TO XM-120/121 DYNAMIC MEASUREMENT MODULE
Pin A - Common
Pin B - Signal
-24
SIG
COM
Cable shield not
connected at this end
Signal Common
Channel 1 Input Signal
Shield
Signal Common
Tach Input Signal
-24V DC
36
16
17
18
0
1
20
21
22
4
Signal Common
Channel 2 Input Signal
-24V DC*
* Note: Jumpering terminal 22 to
terminal 21 configures
CH 2 buffer (-24V to 9V)
13
Shield
Shield
31
-24
SIG
COM
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
45
Chapter 1
Install the XM-124 Standard Dynamic Measurement Module
Connect the Remote Relay Reset Signal
If you set the module relay to latching and the relay activates, the relay stays
activated even when the condition that caused the alarm has ended. The remote
relay reset signal enables you to reset your module relay remotely after you have
corrected the alarm condition. This includes latched relays in the Expansion
Relay module when it is attached to the XM-124 module.
TIP
If you set a module relay to latching, make sure that any linked relays, such
as relays in an XM-440 Master Relay Module, are not configured as
latching. When both relays are set to latching, the relay in each module has
to be independently reset when necessary.
TIP
You can discretely reset a relay using the serial or remote configuration tool.
Wire the Remote Relay Reset Signal to the terminal base unit as shown in
Figure 29.
Figure 29 - Remote Relay Reset Signal Connection
ATTENTION: The Switch Input circuits are functionally isolated from
other circuits. We recommend that the Switch RTN signal be grounded
at a signal point. Connect the Switch RTN signal to the XM terminal base
(chassis terminal) or directly to the DIN rail, or ground the signal at the
switch or other equipment that is wired to the switch.
A single switch contact can also be shared by multiple XM modules wired in
parallel as shown in Figure 30.
ATTENTION: The relay reset connections may be different for different
XM modules. Figure 30 applies only to the XM-124 module. Refer to the
installation instructions for the module for its terminal assignments.
46
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Install the XM-124 Standard Dynamic Measurement Module
Chapter 1
Figure 30 - Typical Multiple XM Modules Remote Relay Reset Signal Connection
Connect the Setpoint Multiplication Switch
You can configure the module to multiply the alarm setpoints, or inhibit the
alarms during the start-up period. This can be used to avoid alarm conditions that
can occur during start-up, for example, when the monitored machine passes
through a critical speed.
Wire the Setpoint Multiplication switch to the terminal base unit as shown in
Figure 31.
Figure 31 - Setpoint Multiplication Connection
ATTENTION: The Switch Input circuits are functionally isolated from
other circuits. We recommend that the Switch RTN signal be grounded
at a signal point. Connect the Switch RTN signal to the XM terminal base
(chassis terminal) or directly to the DIN rail, or ground the signal at the
switch or other equipment that is wired to the switch.
Connect the 4…20 mA Outputs
The modules include an isolated 4…20 mA per channel output into a maximum
load of 300 ohms. The measurements that the 4…20 mA output tracks and the
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
47
Chapter 1
Install the XM-124 Standard Dynamic Measurement Module
signal levels that correspond to the 4 mA and 20 mA are configurable. Refer
to Alarm, Relay, and 4…20 mA Output Parameters on page 80 for details.
Wire the 4…20 mA outputs to the terminal base unit as shown in Figure 32.
Figure 32 - 4…20 mA Output Connections
-
ATTENTION: The 4…20 mA outputs are functionally isolated from
other circuits. We recommend that the outputs be grounded at a single
point. Connect the 4…20 mA (-) to the XM terminal base (chassis
terminal) or directly to the DIN rail, or ground the signal at the other
equipment in the 4…20 mA loop.
Serial Port Connection
The XM-124 module includes a serial port connection that lets you connect a
personal computer to it and configure the module’s parameters via the Serial
Configuration software utility.
There are two methods of connecting an external device to the module’s serial
port:
• Terminal Base Unit - There are three terminals on the terminal base unit
you can use for the serial port connection. They are TxD, RxD, and RTN
(terminals 7, 8, and 9, respectively). If these three terminals are wired to a
DB-9 female connector, then a standard RS-232 serial cable with 9-pin
(DB-9) connectors can be used to connect the module to a personal
computer (no null modem is required).
Wire the DB-9 connector to the terminal block as shown.
48
XM-124 Terminal Base Unit
(catalog number 1440-TB-A)
DB-9 Female Connector
TX Terminal (terminal 7) ----------------------
Pin 2 (RD - receive data)
RX Terminal (terminal 8) ----------------------
Pin 3 (TD - transmit data)
RTN Terminal (terminal 9) ---------------------
Pin 5 (SG - signal ground)
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Install the XM-124 Standard Dynamic Measurement Module
Chapter 1
• Mini-connector - The mini-connector is on the top of the module, as
shown below.
Figure 33 - Mini-connector
Mini-connector
A special cable (catalog number 1440-SCDB9FXM2) is required for this
connection. The connector that inserts into the personal computer is a
DB-9 female connector, and the connector that inserts into the module is a
USB Mini-B male connector. The default communication rate is
19.2 Kbps.
WARNING: If you connect or disconnect the serial cable with power applied to
the module or the serial device on the other end of the cable, an electrical arc
can occur. This could cause an explosion in hazardous location installations.
Be sure that power is removed or the area is nonhazardous before proceeding.
IMPORTANT
If 24 V Common is not referenced to earth ground, we recommend you use an
RS-232 isolator, such as Phoenix PSM-ME-RS232/RS232-P (catalog number
1440-ISO-232-24), to protect both the XM module and the computer.
WARNING: The Serial port is intended for temporary local programming
purposes only and not intended for permanent connection. If you connect or
disconnect the serial cable with power applied to this module or the serial
device on the other end of the cable, an electrical arc can occur. This could
cause an explosion in hazardous location installations.
Be sure that power is removed or the area is nonhazardous before proceeding.
DeviceNet Connection
The XM-124 module includes a DeviceNet connection that lets the modules
communicate with a programmable logic controller (PLC), distributed control
system (DCS), or another XM module.
The DeviceNet network is an open, global, industry-standard communication
network designed to provide an interface through a single cable from a
programmable controller to a smart device such as the XM-124 module. As
multiple XM modules are interconnected, the DeviceNet network also serves as
the communication bus and protocol that efficiently transfers data between the
XM modules.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
49
Chapter 1
Install the XM-124 Standard Dynamic Measurement Module
Connect the DeviceNet cable to the terminal base unit as shown.
Connect
To
Terminal
Red Wire
DNet V+
26 (optional—see note)
White Wire
CAN High
23
Bare Wire
Shield (chassis)
10
Blue Wire
CAN Low
24
Black Wire
DNet V-
27
IMPORTANT
The DeviceNet power circuit through the XM module interconnect, which is
rated at only 300 mA, is not intended or designed to power DeviceNet loads.
Doing so could damage the module or terminal base.
If the module is configured to operate in Normal mode (fully ODVA compliant),
DNet V+ must be connected. Refer to Connecting Power on page 30.
ATTENTION: You must ground the DeviceNet shield at only one location.
Connecting the DeviceNet shield to terminal 10 will ground the DeviceNet
shield at the XM module. If you intend to terminate the shield elsewhere, do
not connect the shield to terminal 10.
ATTENTION: The DeviceNet network must also be referenced to earth at only
one location. Connect DNet V- to earth or chassis at one of the XM modules.
ATTENTION: The DNet V+ and DNet V- terminals are inputs to the XM module.
Do not attempt to pass DeviceNet power through the XM terminal base to
other non-XM equipment by connecting to these terminals. Failure to comply
may result in damage to the XM terminal base and/or other equipment.
IMPORTANT
Terminate the DeviceNet network and adhere to the requirements and
instructions in the ODVA Planning and Installation Manual - DeviceNet Cable
System, which is available on the ODVA website (http://www.odva.org).
WARNING: If you connect or disconnect the DeviceNet cable with power
applied to this module or any device on the network, an electrical arc can
occur. This could cause an explosion in hazardous location installations.
Be sure that power is removed or the area is nonhazardous before proceeding.
50
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Install the XM-124 Standard Dynamic Measurement Module
Mount the Module
Chapter 1
The XM-124 standard dynamic measurement module (catalog number 1440SDM02-01RA) is used only with the 1440-TB-A/C terminal base.
WARNING: If you insert or remove the module while backplane power
is on, an electrical arc can occur. This could cause an explosion in
hazardous location installations. Be sure that power is removed or the
area is nonhazardous before proceeding.
WARNING: If you connect or disconnect wiring while the field-side
power is on, an electrical arc can occur. This could cause an explosion in
hazardous location installations. Be sure that power is removed or the
area is nonhazardous before proceeding.
IMPORTANT
See XM Power Supply Solutions Application Technique, publication ICM-AP005,
for guidance in architecting power supplies for XM systems.
1. Make certain the keyswitch (D) on the terminal base unit (E) is at position
1 as required for the module.
C
D
B
E
F
A
DYNAMIC MEASUR
EMENT
1440-DYN02-01R
J
G
31886
2. Make certain the side connector (B) is pushed all the way to the left. You
cannot install the module unless the connector is fully extended.
3. Make sure that the pins on the bottom of the module are straight so they
align properly with the connector in the terminal base unit.
4. Position the module (A) with its alignment bar (G) aligned with the
groove (F) on the terminal base.
5. Press firmly and evenly to seat the module in the terminal base unit. The
module is seated when the latching mechanism (C) is locked into the
module.
Repeat the above steps to install another module in its terminal base.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
51
Chapter 1
Install the XM-124 Standard Dynamic Measurement Module
Set the Module DIP Switch
Under the slide at the top of the module is a 10 position DIP switch that is used
for setting the modules DeviceNet behavior, node address and communication
rate. The switches are number from left to right and applied as shown in the
illustration below and in the following table.
Figure 34 - XM-124 Module DIP Switch Bank
Table 5 - DIP Switch Functions and Defaults
Switch
Purpose
Function
Out-of-box
Default Value
Out-of-box
Switch Setting
1
DIP switch disable
Determines whether DIP switches 3…10 are enabled. When this switch is
in the off position, DIP switches 3…10 set the module’s node address and
communication rate. When the switch is on, the device ignores DIP
switches 3…10 and uses the network address and communication rate
programmed in nonvolatile storage.
Switches enabled
Off
2
Network mode
Sets the DeviceNet behavior of the module to either Normal mode (ODVA
compliant) or Legacy mode, which is consistent with earlier XM module
versions.
Normal (fully
compliant)
On
3, 4
Data rate
When switch #1 is off (0), sets the DeviceNet communication rate.
125 Kbps
Both off
5…10
Node address
When switch #1 is off (0), sets the DeviceNet node address.
63
All on
IMPORTANT
Install the overlay slide label to protect serial connector and electronics when
not adjusting the switch.
Switch 1 - DIP Switch Enable (0) / Disable (1)
If the module’s DeviceNet address is set in firmware, then the DIP switch must be
disabled.
IMPORTANT
52
When earlier XM modules are included on a network it is left up to you to
guarantee that no nodes exist with the same MAC ID and that no more than
one Client device is configured to access the same device using the Predefined
Master/Slave Connection Set. Bus errors can occur if either of these conditions
exists.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Install the XM-124 Standard Dynamic Measurement Module
Chapter 1
Switch 2 - Normal/Legacy Mode
In most cases, the module must be left in Normal (default) mode. However, if the
module is used to replace an existing XM-12X module, and DeviceNet V+ is not
wired, then the mode must be set to Legacy.
IMPORTANT
When DIP Switch #2 is set to Legacy mode (OFF), the XM 124 continues to
communicate even when DNet V+ is not present. If connections are
established when DNet V+ is restored, other XM modules do not perform a
Duplicate MAC Address check. Consequently if an address conflict exists it may
not be detected and erroneous data or unexpected behaviors including
potentially a BUS OFF condition can result.
IMPORTANT
When DIP Switch #2 is set to Normal mode (ON), the XM-124 module behaves
per the DeviceNet standard and does not communicate when power is not
present on DeviceNet V+. At any time that power is detected on DeviceNet
V+ the XM-124 module performs a Duplicate MAC Address check and, in the
event that a module with a duplicate address is detected, terminates all
communication.
TIP
Legacy mode is consistent with how previous XM modules, including the XM12x modules, behaved with respect to the presence of power on DeviceNet V+.
However, in both Legacy and Normal mode, an XM-124 module performs a
Duplicate MAC Address check when the module detects power applied to
DeviceNet V+. This is a change in behavior from earlier XM modules.
Switches 3 and 4 - Set DeviceNet Communication Rate
These switches are ignored if switch #1 is in the on (1) position (switch disabled).
Use these switches to set the communication rate per the following table.
Communication Rate
SW 3
SW 4
125 Kbps
0
0
250 Kbps
0
1
500 Kbps
1
0
Auto Communication
1
1
Switches 5…10 - Set DeviceNet Address
Follow these steps to set the node address.
1. Refer to DeviceNet Node Address table on page 55 for the switch settings
of a specific address.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
53
Chapter 1
Install the XM-124 Standard Dynamic Measurement Module
2. Using a pointed tool, slide switches 5…10 to the appropriate positions (1
or 0).
Down Position = 0
EXAMPLE
54
If you want the node address to be 4 then set dip switches 5…8 as follows.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Install the XM-124 Standard Dynamic Measurement Module
Chapter 1
Table 6 - DeviceNet Node Addresses
0
0
0
0
1
0
0
0
0
0
2
0
0
0
0
3
0
0
0
4
0
0
5
0
6
32
1
0
0
0
0
0
1
33
1
0
0
0
0
1
1
0
34
1
0
0
0
1
0
0
1
1
35
1
0
0
0
1
1
0
1
0
0
36
1
0
0
1
0
0
0
0
1
0
1
37
1
0
0
1
0
1
0
0
0
1
1
0
38
1
0
0
1
1
0
7
0
0
0
1
1
1
39
1
0
0
1
1
1
8
0
0
1
0
0
0
40
1
0
1
0
0
0
9
0
0
1
0
0
1
41
1
0
1
0
0
1
10
0
0
1
0
1
0
42
1
0
1
0
1
0
11
0
0
1
0
1
1
43
1
0
1
0
1
1
12
0
0
1
1
0
0
44
1
0
1
1
0
0
13
0
0
1
1
0
1
45
1
0
1
1
0
1
14
0
0
1
1
1
0
46
1
0
1
1
1
0
15
0
0
1
1
1
1
47
1
0
1
1
1
1
16
0
1
0
0
0
0
48
1
1
0
0
0
0
17
0
1
0
0
0
1
49
1
1
0
0
0
1
18
0
1
0
0
1
0
50
1
1
0
0
1
0
0
1
0
0
1
1
51
1
1
0
0
1
1
0
1
0
1
0
0
52
1
1
0
1
0
0
0
1
0
1
0
1
53
1
1
0
1
0
1
0
1
0
1
1
0
54
1
1
0
1
1
0
0
1
0
1
1
1
55
1
1
0
1
1
1
0
1
1
0
0
0
56
1
1
1
0
0
0
0
1
1
0
0
1
57
1
1
1
0
0
1
0
1
1
0
1
0
58
1
1
1
0
1
0
0
1
1
0
1
1
59
1
1
1
0
1
1
0
1
1
1
0
0
60
1
1
1
1
0
0
0
1
1
1
0
1
61
1
1
1
1
0
1
0
1
1
1
1
0
62
1
1
1
1
1
0
0
1
1
1
1
1
63
1
1
1
1
1
1
23
24
25
26
27
28
29
30
31
Electronic Data Sheets
SW
4
Communication rate selection.
0
SW
3
Communication rate selection.
0
SW
2
DeviceNet behavior mode selection.
0(1)
SW
1
Disable DIP switch. Must be 0 if setting bus address with switches 5…10.
SW7 SW8 SW9 SW1
0
22
SW
4
Communication rate selection.
SW5 SW6
21
SW
3
Communication rate selection.
Node
Addr
20
SW
2
DeviceNet behavior mode selection.
SW5 SW6 SW7 SW8 SW9 SW1
0
19
SW
1
Disable DIP switch. Must be 0 if setting bus address with switches 5…10.
Node
Addr
Electronic data sheet (EDS) files are simple text files used by network
configuration tools, such as RSNetWorx™ software, version 3.0 or later, to help
you identify products and easily commission them on a network. The EDS files
describe a product’s device type, product revision, and configurable parameters
on a DeviceNet network.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
55
Chapter 1
Install the XM-124 Standard Dynamic Measurement Module
The EDS files for the XM modules are installed on your computer with the XM
configuration software. The latest EDS files can also be obtained at
http://www.ab.com/networks/eds or by contacting your local Rockwell
Automation representative.
Refer to your DeviceNet documentation for instructions on registering the EDS
files.
ADR for XM Modules
Automatic device replacement (ADR) is a feature of an Allen-Bradley DeviceNet
scanner. It provides a means for replacing a failed device with a new unit, and
having the device configuration data set automatically. Upon replacing a failed
device with a new unit, the ADR scanner automatically downloads the
configuration data and sets the node address.
IMPORTANT
We recommend that ADR not be used in safety related applications. If the
failure of the ADR server, and a subsequent power cycle, would result in the
loss of protection for a machine, then do not implement ADR.
ADR can be used with XM modules but keep the following in mind when setting
up the XM modules:
• The ADR scanner can not download the configuration data to an XM
module if the module has a saved configuration in its nonvolatile memory.
This happens because the saved configuration is restored and the module
enters Run mode when the power is cycled. (Configuration parameters
cannot be downloaded while an XM module is in Run mode.) XM
modules must be in Program mode for the ADR configuration to be
downloaded and this occurs only when there is no saved configuration.
TIP
56
To delete a saved configuration from nonvolatile memory, use the Delete
service in RSNetWorx for DeviceNet software or perform the following steps in
the XM Serial .
1. From the File menu, choose Save As.
2. Enter a file name for the configuration.
3. Click OK.
4. Click the Module tab.
5. Click Reset to reset the module to factory defaults.
6. From the File menu, choose Open.
7. Select the configuration file and choose OK.
Make sure to disable auto save. From the Device menu, clear the Auto Save
Configuration checkmark.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Install the XM-124 Standard Dynamic Measurement Module
Chapter 1
• An XM module enters Run mode automatically after the ADR scanner
restores the module’s configuration only if the module is in Run mode at
the time the configuration is saved to the scanner. If the module is in
Program mode when the configuration is saved, then the module remains
in Program mode after the configuration is downloaded by the ADR
scanner.
• The ADR scanner saves and restores only the configuration parameters
contained in the module’s EDS file. Some XM parameters are not included
in the EDS file because they are not supported by either the EDS
specification or the tools that read the EDS files, for example RSNetWorx
for DeviceNet software. These configuration parameters are not restored
with ADR.
Below is a list of the configuration parameters that are not included in the
EDS file and can not be saved or restored with ADR:
– Channel Name
– Tachometer Name
– Alarm Name
– Relay Name
– All Triggered Trend related parameters
– All SU/CD Trend related parameters
– Custom Assembly structure
• The ADR and trigger group functions cannot be used together. A module
can have only one primary master so a module cannot be both configured
for ADR and included in a trigger group. The ADR scanner must be the
primary master for the modules configured for ADR. The XM-440
Master Relay module must be the primary master for modules included in
a trigger group.
Power Up the Module
The module performs a self-test at powerup. The self-test includes a status
indicator test and a device test. During the status indicator test, the indicators are
turned on independently and in sequence for approximately 0.25 seconds.
The device test occurs after the Status Indicator test. The Module Status (MS)
indicator is used to indicate the status of the device self-test.
MS Indicator State
Description
Flashing Red and Green
Device self-test is in progress.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
57
Chapter 1
58
Install the XM-124 Standard Dynamic Measurement Module
MS Indicator State
Description
Solid Green or Flashing Green
Device self-test completed successfully, and the firmware
is valid and running.
Flashing Red
Device self-test competed, the hardware is OK, but the
firmware is invalid, the firmware download is in progress,
or, the node address or communication rate DIP switch
settings have been changed and do not match the
settings in use.
Solid Red
Unrecoverable fault, hardware failure, or Boot Loader
program may be corrupted.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Chapter
2
Configure the XM-124 Standard Dynamic
Measurement Module
The XM-124 module is configured by using the XM Serial Configuration Utility
software. This section details the configuration process and associated
parameters.
XM Serial Configuration
Utility Software
Topic
Page
XM Serial Configuration Utility Software
59
Configuring the XM-124 Standard Dynamic Measurement Module
62
The Serial Configuration Utility is a tool provided for you to locally configure
any XM Series module, except for the 1440-DYN02-01RJ Dynamic
Measurement Module, which is used exclusively with and configured from a
Logix controller. The tool is available on the Rockwell Automation Support for
XM website: http://www.rockwellautomation.com/support/xm.
The Serial Configuration Utility, versions 7.0 and later, includes support for the
XM-124 standard dynamic measurement module.
The Serial Configuration Utility is a Microsoft Windows-based program that
enables configuring XM modules via the module’s serial port (usually the micro
connector on the top of the module). Besides configuring a module the tool also
enables reading and writing configuration files, displaying data being measured by
a module and updating a module’s firmware.
Application Help
At any time, you can press the F1 function key to access the online help function
for the application. When opened, the Help function presents information
relative to the tab currently being viewed.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
59
Chapter 2
Configure the XM-124 Standard Dynamic Measurement Module
Figure 35 - Application Help Dialog Box
For help on topics other than module configuration, consult the back cover of
this manual for contact information for Rockwell Automation Support and
Installation Assistance.
Module Selection and Connection
The XM Serial Configuration Utility welcome screen is shown below. The
software version used for the XM-124 module may vary from the figure, but the
release number must be at least 7.0.0.
Figure 36 - 1XM Serial Configuration Utility Main Dialog Box
If the computer is connected to an XM-124 module, this is indicated by a closed
‘connector’ icon, and the application allows only configuration of that specific
module. If no module is connected, as in the above figure, the tool may be used to
edit configuration files for any type of module.
60
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Configure the XM-124 Standard Dynamic Measurement Module
Chapter 2
Passwords and Access
The XM Serial Configuration Utility includes a function for creating and
managing passwords for Administrator and Maintenance-level access.
IMPORTANT
The password function is optional, but once a password is defined for either
the Administrator or Maintenance accounts, the utility requires that
password to configure an XM-124 module.
Upon initial login, the following dialog box appears.
An Administrator password may be verified with re-entry. Once established, the
Administrator account may be used to also manage the Maintenance account as
well as fully edit and load configurations to a module.
Configurations and Commands
Choosing the Configure option from the main dialog box begins either Online
Configuration or Offline Configuration, depending on the module’s connection
status.
Online Configuration
If the computer is connected to a module, as indicated by a “closed” connector
icon in the main dialog box, the Utility immediately uploads the current
configuration from the module and then open the editor appropriate for the type
of module connected.
Offline Configuration
If the computer is not connected to a module, as indicated by an ‘open’ connector
icon in the main dialog box, the Utility displays a dialog box showing all
supported XM modules. Select the desired module and then click OK to begin
configuration.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
61
Chapter 2
Configure the XM-124 Standard Dynamic Measurement Module
Figure 37 - 1 Offline Configuration Showing Supported XM Modules
Common Menu Functions - File, Edit, Device, and Help
The XM Serial Configuration Utility stores XM module configurations in files
having type extensions that match the model of the module. For example,
configuration files for the XM-124 module end with the type extension ‘.124’.
Use the functions in the File Menu to open, close, and save these files.
IMPORTANT
When logged into the Maintenance account, the Save and Save As
commands are not available.
The Edit menu provides functionality solely to copy configurations from one
channel to another.
The Device menu provides the functionality necessary to download a
configuration to a module and to upload a configuration from a module. When
Online (connected to a module), the current module configuration is
automatically uploaded when the editor is started.
IMPORTANT
When logged into the Maintenance account, the Download command is
not available.
The Help menu may be selected to access the Contents and Index command as
well as the About XM Serial Configuration utility command.
Configuring the XM-124
Standard Dynamic
Measurement Module
The editor for the XM-124 standard dynamic measurement module follows the
same style and design as the editors for other XM modules. Each tab presents a
dialog box containing related parameters.
Generally, a module is configured from the leftmost tab, working toward the
right. Begin the XM-124 module configuration with the Channel tabs.
62
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Configure the XM-124 Standard Dynamic Measurement Module
Chapter 2
Configure the Channel Properties
Use the Channel tab to define the characteristics of the transducer and the signal
processing performed on the input signals. The XM-124 module has two input
channels.
1. From the Module Properties dialog box, click the Channel tab.
2. Configure the parameters as necessary.
Transducer
In this field
Values are
Comments
Channel Name
Enter a descriptive name for the channel.
Maximum 18 characters.
Power
Choose the type of power supplied to the transducer:
• Off
• IEPE (externally supplied)
• -24V (externally supplied)
• +24V (externally supplied from the terminal base)
• Bias Current (externally supplied)
See Connect the Transducer on page 34 for wiring
requirements.
See table below.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
63
Chapter 2
Configure the XM-124 Standard Dynamic Measurement Module
In this field
Values are
Comments
Nominal Sensitivity
Choose the sensitivity of the transducer.
Your choice controls the list of possible full scale selections.
The default is 200.0 mV/mil (displacement).
Nominal Sensitivity
Acceleration
10.0 mV/g
25.0 mV/g
50.0 mV/g
100.0 mV/g
500.0 mV/g
1000.0 mV/g
10000.0 mV/g
Velocity
100.0 mV/ in/s
150.0 mV/ in/s
200.0 mV/ in/s
400.0 mV/ in/s
500.0 mV/ in/s
1000.0 mV/ in/s
4.0 mV/ mm/s
6.0 mV/ mm/s
8.0 mV/ mm/s
16.0 mV/ mm/s
20.0 mV/ mm/s
40.0 mV/ mm/s
Displacement
100.0 mV/ mil
150.0 mV/ mil
200.0 mV/ mil
285.0 mV/ mil
10.0 mV/ mil
3.94 mV/ μm
5.91 mV/ μm
7.87 mV/ μm
11.2 mV/ μm
0.394 mV/μm
Pressure
20.0 mV/ psi
50.0 mV/ psi
100.0 mV/ psi
0.29 mV/ mbar
0.73 mV/ mbar
1.45 mV/ mbar
Volts
1000.0 mV/V
Pressure 20.0 mV/ psi
50.0 mV/ psi
100.0 mV/ psi
0.29 mV/ mbar
0.73 mV/ mbar
1.45 mV/ mbar
Enter the sensitivity value of the transducer that is included with the
transducer’s calibration documentation. Due to manufacturing
variation, the actual sensitivity may be different than the nominal
sensitivity.
This value is ±15% of the Nominal Sensitivity value, see the
above table.
DC High Limit
Enter the maximum expected DC bias voltage from the transducer.
Enter a value between -24…24V.
DC Low Limit
Enter the minimum, or most negative, expected DC voltage from the
transducer.
Actual Sensitivity
64
Quantity of
Measure
Important: The nominal sensitivity is used if you leave this
field blank.
Important: A voltage reading outside this range constitutes
a transducer fault, which is indicated by the Channel status
indicator flashing red and the Ch0Fault or Ch1Fault input tag,
depending on the channel.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Configure the XM-124 Standard Dynamic Measurement Module
Chapter 2
Measurement Mode
Select the Measurement mode according to the type of measurements to be
performed.
Measurement
Mode
Standard
Alternating gSE
(1)
Continuous gSE(1)
Tracking Filter
Band Pass Filter
Thrust Position(2)
Eccentricity(2)
Measurements performed
DC Bias (Gap)
Overall
FFT/TWF
✓
✓
✓
✓
✓
✓
✓
✓
✓
✓
✓
✓
✓
✓
✓
gSE Overall
gSE FFT
✓
✓
✓
✓
Tracking
Band Pass
Mag. + Phase
✓
✓
Thrust
Position
✓
Eccentricity
✓
(1) Requires accelerometer transducer
(2) Requires displacement transducer
The Standard measurement mode performs the DC Bias (Gap), Overall, FFT,
and TWF measurements. The Standard measurement mode also performs the
following measurements, which are derived from the FFT data: four Band
measurements, 1X magnitude and phase, 2X magnitude and phase, 3X
magnitude, Not 1X, and Sum Harmonics. This is the same measurements that
are performed by the XM-120 Dynamic Measurement module. This is also the
same set of measurements performed by the XM-124 V6 firmware while the
Thrust Position measurement is not enabled.
The gSE measurement modes perform the g’s Spike Energy™ measurements. The
gSE measurements use a signal processing technique that provides an accurate
measure of the energy generated by transient or mechanical impacts. The gSE
measurements can provide early detection of surface flaws in rolling element
bearings, metal-to-metal contacts, insufficient bearing lubrication, and processrelated problems, such as dry running, cavitation, flow change, and internal recirculation.
Alternating gSE measurement mode alternates between the standard and gSE
measurement sets every several seconds. This is like the XM-122 gSE Vibration
module. In Alternating gSE mode, the four Band measurements can be derived
from either the standard or gSE FFT.
The Continuous gSE measurement mode performs the DC Bias, gSE Overall,
and gSE FFT measurements. The Continuous gSE mode also performs four
Band measurements, which are derived from the gSE FFT.
The Tracking Filter and Band Pass Filter measurement modes are designed
specifically for monitoring aeroderivative gas turbine engines, such as the General
Electric LM2500 engine.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
65
Chapter 2
Configure the XM-124 Standard Dynamic Measurement Module
The Tracking Filter measurement mode performs the DC Bias, Overall, FFT,
TWF, Tracking Filter magnitude and phase measurements. This is similar to the
XM-123 Aeroderivative module’s Tracking Filter measurement set except the
XM-123 does not perform the FFT and TWF measurements.
The Band Pass Filter measurement mode performs the DC Bias, Overall, FFT,
TWF, and Band Pass Filter measurements. This is similar to the XM-123
Aeroderivative module’s Band Pass Filter measurement set except the XM-123
does not perform the FFT and TWF measurements.
The Thrust Position measurement mode performs a Thrust Position
measurement in addition to the Standard measurement mode measurements.
This is the same set of measurements performed by the XM-124 V6 firmware
while the Thrust Position measurement is enabled. This is also like the position
measurement performed by the XM-320 Position module when it is configured
in its Normal mode.
The Eccentricity measurement mode performs the DC Bias and Eccentricity
measurements. Eccentricity is the measure of the amount of bow in a rotor. The
lower the eccentricity value, the more straight the shaft. Rotor bow can be a fixed
mechanical bow, or it can be a temporary bow caused by uneven thermal heating
or simply by the weight of the rotor (gravity bow). The Eccentricity
measurement mode is suitable for virtually all types of rotating and reciprocating
machinery where rotor bow must be measured prior to or during startup. This
eccentricity measurement is the same as the eccentricity measurement performed
by the XM-120E Eccentricity module.
Signal Processing
The Signal Processing group box options apply to the Standard, Alternating gSE,
Tracking Filter, and Band Pass Filter measurement modes. These settings affect
the standard Overall, FFT, and TWF measurements.
66
In this field
Values are
Comments
Full Scale
Choose the maximum signal level expected to be processed by the
channel. If the full scale value is peak or peak-to-peak, select the
measurement performed (true or calculated) to produce the overall
value.
The default value and the available values depend on the
Transducer Nominal Sensitivity selection.
If the Engineering Units of the selected Full Scale value
require integration, from the Engineering Units of the
selected Nominal Sensitivity, then an analog 2 kHz Low Pass
Filter will be applied prior to the measurement.
By assuring the absence of high-frequency content, gains can
be applied to maximize the accuracy of the measurements
below the LPF corner frequency.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Configure the XM-124 Standard Dynamic Measurement Module
Chapter 2
In this field
Values are
Comments
True
The actual or literal measure of the signal. It is the maximum peak in the
time waveform for peak measurements, or the difference between the
maximum and minimum peaks for peak-to-peak measurements.
Calculated
The RMS value of the time waveform multiplied by the square root of
two (1.414) if measuring the peak value, or two times the square root of
two (2.828) if measuring the peak-to-peak value.
IMPORTANT: When full scale is set to an RMS value, including
Calculated Peak or Calculated Peak-to-Peak, the XM module is
configured to accept input signals as high as 6X the specified full scale
without saturating the electronics. This is because a signal with
moderate RMS value may have very high spikes because RMS is an
averaging mechanism. If True Peak or True Peak-to-Peak is selected, the
module is configured to spread the full scale range over the entire
measurement range, without reserving this 6X headroom used for RMS.
This gives better resolution within the full scale range but causes the
signals to be clipped at levels just above the full scale.
The True and Calculated radio buttons are dimmed when full
scale is set to an RMS value.
For a pure sine wave, the true and calculated values are equal.
The true and calculated values diverge as additional signals
are added to the waveform, or as non-sinusoidal or nonrepetitive signals are included.
For protection applications where the objective is to preclude
contact between stationary and moving components, True is
the appropriate measurement because it is a better indication
of actual movement.
For conditioning monitoring applications where the objective
is to indicate the total energy in the system (that is, the
overall value), Calculated is the preferable measurement.
High Pass Filter Corner
Choose the high pass filter to apply to the measurement.
• 0.2 Hz
• 1 Hz
• 5 Hz
• 10 Hz
• 40 Hz
The high pass filter is useful in removing low frequency signal
components that can dominate the signal, particularly when
integrating. The high pass filter attenuates frequencies less
than the specified frequency. It passes frequencies greater
than the specified frequency.
Enable Low Pass (Overall) Filter
Check to apply a low pass filter to the Overall Measurement. Clear to
disable the low pass filter.
The filter is applied only to the Overall measurement. It does
not affect the time waveform, spectrum, or measurements
derived from the spectrum.
Low Pass Filter Corner
Enter a value between 100…20,000 Hz. Input signal frequencies
greater than this value are significantly attenuated.
This parameter is available only when Enable Low Pass Filter
is checked.
When integrating, this (digital) Overall Low Pass Filter Corner
may not be set greater than the 2 kHz analog LPF that is
applied to all integrating measurements.
Spectrum/Waveform Measurement Options
The Spectrum/Waveform Measurement options apply to the Standard,
Alternating gSE, Tracking Filter, Band Pass Filter, and Thrust Position
measurement modes. These settings affect the standard FFT and TWF
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
67
Chapter 2
Configure the XM-124 Standard Dynamic Measurement Module
measurements. Click Spectrum/Waveform to open the Spectrum/Waveform
options dialog box.
In this field
Values are
Comments
Sampling Mode
Choose the sampling mode:
• Asynchronous
• Synchronous with tach
The sampling mode determines whether the signal is
synchronized with the tachometer signal and has several
effects on the resulting measurements.
Synchronous sampling requires a tachometer signal.
Sampling Mode (continued)
Frequency Type
68
Asynchronous Sampling
Synchronous Sampling
The waveform measurement is
time-based
The waveform measurement is
position-based.
The spectrum measurement is
frequency-based.
The spectrum measurement is
order-based and the Number of
Lines must be evenly divisible
by Frequency Maximum.
The Frequency Maximum must
be specified in Hz.
Frequency Maximum must be
specified in orders.
The frequency units (Hz or CPM).
Enter the FMAX in these units.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Configure the XM-124 Standard Dynamic Measurement Module
Chapter 2
In this field
Values are
Comments
Frequency Maximum
The maximum frequency or order for the spectrum measurement.
The sampling mode determines whether the frequency
maximum is specified in Hz or orders. It also determines
whether you enter a value or choose a value from a list of
available values:
• If sampling mode is synchronous with tach, enter the
Frequency Maximum value. The frequency maximum
range for Synchronous sampling mode is 4…200 orders.
• If sampling mode is Asynchronous, choose the Frequency
Maximum value. Note you may enter a specific value if you
choose 10…5000 range. Supported maximum
asynchronous frequencies are dependent on sensitivity
units and full scale units you choose on the Channel tab.
See tables below.
When integrating, the Maximum Frequency may not be set
greater than the 2 kHz analog LPF that is applied to all
integrating measurements.
Full Scale Units (Channel tab)
mil
μm
mil
μm
in/s
Sensitivity
Units (Channel mm/s
tab)
g
V
Psi
mbar
Number of Spectrum Lines
Period
in/s
mm/s
g
V
Psi
mbar
Column A
Column A
Column A
Column B
Column A
Column A
Column A
Frequency
A
B
10…5000
X
X
6250
X
X
7500
X
X
8000
X
9375
X
10,000
X
12,500
X
15,000
X
18,750
X
20,000
X
X
Choose the number of lines (bins) in the spectrum measurement:
• 100
• 200
• 400
• 800
• 1600
This determines the frequency resolution of the spectrum
measurement.
Displays the total period of the waveform measurement in seconds.
The value is in seconds when sampling mode is set to
Asynchronous. The value is in cycles when sampling mode is
set to Synchronous.
Samples are accumulated into a time waveform of this duration before
an FFT is performed on the collected data. Period is provided to show the
effect various settings, such as Number of Spectrum Lines, have on the
update rate of measurements (Band and Vector) derived from the
spectrum.
Order of Sum Harmonics
X
Choose the starting order for the sum harmonics measurement:
• 1
• 2
• 3
• 4
• 5
Important: When sampling mode is Synchronous, the
Number of Spectrum Lines must be evenly divisible by the
Frequency Maximum value (no remainder).
The amplitudes of all harmonics from the specified harmonic
through the Frequency Maximum are included in the sum.
Important: The sum harmonics measurement requires the
tachometer to be enabled (Pulses Per Revolution is set to 1 or
more), and a tachometer signal must be present.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
69
Chapter 2
Configure the XM-124 Standard Dynamic Measurement Module
In this field
Values are
Comments
Data Format
Choose complex or magnitude data format.
Complex data includes phase information but takes longer to
upload and requires more conversions before plotting.
Magnitude data is half the size and requires fewer
conversions before plotting but does not include phase
information.
See the description of the Spectrum/Waveform object’s
Get_Spectrum_Chunk/Get_Waveform_Chunk service for
more information.
FFT Window Type
Choose the type of window to be applied to the waveform measurement
prior to computing the spectrum:
• Rectangular - Also known as Uniform (no window). Use this only for
transient signals that die out before the end of the time sample, or
for exactly periodic signals within the time sample. Gives poor peak
amplitude accuracy, good peak frequency accuracy.
• Hamming - A general purpose window that is similar to a Hanning
window. It provides better frequency resolution but decreased
amplitude accuracy when compared to the Hanning window. Use it
to separate close frequency components. Gives fair peak amplitude
accuracy, fair peak frequency accuracy.
• Hanning - A general purpose window that is similar to a Hamming
window. It is used on random type data when frequency resolution is
more important than amplitude accuracy. Most often used in
predictive maintenance. Gives fair peak amplitude accuracy, fair peak
frequency accuracy.
• Flat Top - Also called Sinusoidal window. Use this when amplitude
accuracy is more important than frequency resolution. In data with
closely spaced peaks, a Flat Top window may smear the peaks
together into one wide peak. Gives good peak amplitude accuracy,
poor peak frequency accuracy for data with discrete frequency
components.
• Kaiser Bessel - Gives fair peak amplitude accuracy, fair peak
frequency accuracy.
Number of Averages
Enter the number of individual data sets to be incorporated into the
average calculation. Averaging reduces the random errors and provides
a more reliable measurement.
In Asynchronous mode, the spectrum is averaged. In
Synchronous mode, the time waveforms are averaged.
Important: The averaged data is used only for captured time
waveform or FFTs. All data calculated from the FFT, such as
bands, is taken from each individual sample, not the
averaged sample.
Tachometer Rotations
Enter the number of teeth on the buried shaft gear.
Set the value between 1…65,535.
Rotor Rotations
Enter the number of teeth on the external shaft gear.
These parameters are dimmed in asynchronous sampling.
Gear Ratio
Displays the relationship between the Tachometer Rotations and the
Rotor Rotations parameters.
This parameter applies only to synchronous sampling.
The Tachometer Rotations and Rotor Rotations are used to convert the
speed measured by the speed sensor to a shaft speed that is related by
this gear ratio. This is useful when the shaft of interest does not have a
speed sensor of its own.
When a gear ratio is configured, the synchronous measurements are
synchronized with the rotation of the buried (internal) shaft. This
includes the Vector, Not 1X, Sum Harmonics, and order-based Band
measurements. Synchronous averaging is also synchronized with the
internal shaft. However, the Speed measurement is not affected by the
gear ratio. The Speed measurement always reflects the speed of the
shaft with the speed sensor (raw tachometer speed divided by number
of pulses per revolution).
70
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Configure the XM-124 Standard Dynamic Measurement Module
Chapter 2
Band Measurement Options
The Band measurement options apply to the Standard, Alternating gSE,
Continuous gSE, and Thrust Position measurement modes. These settings affect
the Band measurements that are derived from the FFT. There are four Band
measurements for each channel. Click Band to open the Band options dialog box.
TIP
The frequency ranges for each Band measurement may overlap. For
example, Band 1 Minimum Frequency is 500 Hz and Maximum Frequency is
1500 Hz, and Band 2 Minimum Frequency is 1000 Hz and Maximum
Frequency is 3000 Hz.
In this field
Values are
Comments
Spectrum Option
Choose whether the Band measurement is derived from the
conventional (standard) or gSE spectrum.
This option is only available in Alternating gSE measurement
mode.
Frequency Units
Choose Hz, CMP, or Orders.
Enter the band’s Frequency Minimum and Maximum limits in
the selected units.
Measurement
Choose the measurement (or calculation) performed to produce the
Band Value:
• Band Overall - The band value is the square root of the sum of the
squares (RSS) of the amplitude values for the bins that make up the
band.
• Maximum Peak - The band value is equal to the maximum bin
amplitude found within the band.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
71
Chapter 2
Configure the XM-124 Standard Dynamic Measurement Module
In this field
Values are
Comments
Frequency Maximum
Enter the upper limit of the range of spectrum bins to be included in the
band measurement, and the frequency units (Hz or Orders). Set the
value by using the table below.
This value must be greater than the Band Frequency
Minimum.
When integrating, the Maximum Frequency may not be set
greater than the 2 kHz analog LPF that is applied to all
integrating measurements.
Sampling
Mode
Spectrum
Frequency Max
Units
Band Units
Synchronous
Orders
Hz
0…5000
Orders
0.01…200
Hz
0…20,000
Orders
0.01…200
Asynchronous
Frequency Minimum
Hz
Enter the spectrum bin with the least frequency to be included in the
band measurement.
IMPORTANT
72
Band Frequency
Max
For bands specified in Hz on an orders-based spectrum (Sampling Mode set
to Synchronous with tach), the band measurement value is zero when the
Band Frequency Minimum and Frequency Maximum fall completely
beyond the frequencies represented in the spectrum. If any of the band falls
within the spectrum, only that portion contributes to the band value.
Example
Band Frequency Maximum = 250 Hz
Band Frequency Minimum = 150 Hz
Spectrum Frequency Maximum = 10 Orders
The following table shows the actual Band Frequency Maximum and
Minimum values given different operating speeds for this example. Note
that when the speed is 600 rpm, the Band Frequency Maximum and
Minimum values fall outside the range of the Spectrum Frequency
Maximum, so that the band value is zero. When the speed is 1200 rpm, the
band is calculated from 150…200 Hz.
Speed
(rpm)
Max Frequency Represented in
Spectrum (Hz)
Band Min
(Hz)
Band Max
(Hz)
2400
400
150
250
1800
300
150
250
1200
200
150
200
600
100
N/A
N/A
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Configure the XM-124 Standard Dynamic Measurement Module
Chapter 2
gSE Measurement Options
The gSE Measurement options apply to the Alternating gSE and Continuous gSE
measurement modes. These settings affect the gSE Overall or gSE FFT
measurements.
In this field
Values are
Comments
Full Scale
The maximum signal level expected to be processed by the channel for
gSE measurements. This value is used to determine the programmable
gain settings across each stage of the channel’s analog signal processing
circuit.
The default value is 20 gSE.
High Pass Filter
Choose the high pass filter to apply to the gSE measurement.
• 200 Hz
• 500 Hz
• 1000 Hz
• 2000 Hz
• 5000 Hz
The high pass filter is useful in removing low frequency signal
components that could otherwise dominate the signal. The
high pass filter attenuates frequencies less than the selected
frequency. It allows, or passes, frequencies greater than the
selecteded frequency.
Frequency maximum
Enter the maximum frequency for the gSE spectrum, 10 to 5000 Hz.
The gSE spectrum always uses asynchronous sampling mode
and the FMAX is always in Hz.
Number of lines
Choose the number of lines (bins) in the gSE spectrum measurement:
• 100
• 200
• 400
• 800
• 1600
This determines the frequency resolution of the gSE
spectrum.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
73
Chapter 2
Configure the XM-124 Standard Dynamic Measurement Module
Window type
Choose the type of window to be applied to the waveform measurement
prior to computing the spectrum:
• Rectangular - Also known as Uniform (no window). Use this only for
transient signals that die out before the end of the time sample, or
for exactly periodic signals within the time sample. Gives poor peak
amplitude accuracy, good peak frequency accuracy.
• Hamming - A general purpose window that is similar to a Hanning
window. It provides better frequency resolution but decreased
amplitude accuracy when compared to the Hanning window. Use it
to separate close frequency components. Gives fair peak amplitude
accuracy, fair peak frequency accuracy.
• Hanning - A general purpose window that is similar to a Hamming
window. It is used on random type data when frequency resolution is
more important than amplitude accuracy. Most often used in
predictive maintenance. Gives fair peak amplitude accuracy, fair peak
frequency accuracy.
• Flat Top - Also called Sinusoidal window. Use this when amplitude
accuracy is more important than frequency resolution. In data with
closely spaced peaks, a Flat Top window may smear the peaks
together into one wide peak. Gives good peak amplitude accuracy,
poor peak frequency accuracy for data with discrete frequency
components.
• Kaiser Bessel - Gives fair peak amplitude accuracy, fair peak
frequency accuracy.
Number of averages
Enter the number of individual data sets to be incorporated into the
averaged gSE spectrum.
Averaging reduces the random errors and provides a more
reliable measurement.
Tracking Filter Options
The Tracking Filter options apply to the Tracking Filter measurement mode and
affect the Tracking Filter measurement.
74
In this field
Values are
Comments
Tracked multiple
0.1 to 20 times the measured machine speed
Sets the multiple of the machine speed to be tracked.
Constant Bandwidth
Enter the filter bandwidth in the range of 0.1 to 25 Hz
Select Constant Bandwidth to configure the tracking filter to
maintain a constant bandwidth as the machine speed varies.
Constant Q
Enter the filter Q factor in the range of 1 to 200.
Select Constant Q to configure the tracking filter to maintain a
constant ratio between the bandwidth and the center
frequency (machine speed).
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Configure the XM-124 Standard Dynamic Measurement Module
Chapter 2
Band Pass Filter Options
The Band Pass Filter options apply to the Band Pass Filter measurement mode
and affect the Band Pass Filter measurement.
In this field
Values are
Comments
Min Frequency
25 to 1000 Hz
The high pass corner frequency or low cutoff frequency of the
band pass filter.
Max Frequency
100 to 5500 Hz
The low pass corner frequency or high cutoff frequency of the
band pass filter.
Thrust Position Measurement Options
The Thrust Position measurement options apply to the Thrust Position
measurement mode and affect the Thrust Position measurement.
Parameter Name
Values are
Comments
Output data unit
Select mil or μm.
The units of the Thrust Position measurement
value.
Target Angle
Sets the angle between the shaft and the target surface. The target
surface moves with the shaft. The transducer is mounted
perpendicular to the target surface.
degrees
Upscale
Sets the movement of the target relative to the transducer that is
considered positive displacement.
Options:
• Away
• Towards
Calibration Offset (XM Serial Configuration Utility
only)
Enter the position of the current Transducer DC Bias reading.
mils
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
75
Chapter 2
Configure the XM-124 Standard Dynamic Measurement Module
Parameter Name
Values are
Comments
Calibration Bias
Sets the zero or green position. The zero position is the normal
operating position. Setting the zero position compensates for the
static gap. This enables the module to display only the displacement
around the zero position.
Volts
Important: Check with the manufacturer about
operating thrust position and acceptable
tolerances before making any adjustments.
Use one of the formulas below to calculate the Calibration Bias. The
formula that you use depends on the Upscale setting and whether
DC High Limit and DC Low Limit are both less than or equal to zero
(0).
If DC High Limit is greater than zero, use one of these formulas:
Upscale set to ‘Towards’ Formula
Calibration bias = Transducer DC Bias + (Sensitivity x Calibration
Offset) x sin (Target Angle)
Upscale set to ‘Away’ Formula
Calibration Bias = Transducer DC Bias - (Sensitivity x Calibration
Offset) x sin (Target Angle)
If DC High Limit and DC Low Limit are both less than or equal to 0,
use one of these formulas:
Upscale set to ‘Towards’ Formula
Calibration bias = Transducer DC Bias - (Sensitivity x Calibration
Offset) x sin (Target Angle)
Upscale set to ‘Away’ Formula
Calibration Bias = Transducer DC Bias + (Sensitivity x Calibration
Offset) x sin (Target Angle)
Calculate Bias (XM Serial Configuration Utility
only)
Automatically calculates the Calibration Bias value.
IMPORTANT
The XM-124 module supports only Normal mode position measurements. If
Head-to-Head or Radial Cancel measurements are required, then the XM-320
module (catalog number 1440-TPS02-01RB) must be used.
Position measurements, including thrust, can be measured in one of three ways:
• Normal -The two sensors are used independently tot perform two separate
position measurements. See below for a description for a description of
Normal mode measurements.
• Head-to-head(1)- The two sensors are used together, facing each other on
either side of the target, to perform a single position measurement. This
mode can be used to extend the measurable range beyond that of a single
sensor.
• Radial Cancel(1)- The two sensors are used together to perform a single
position measurement. The second sensor is set up to measure the radial
movement of the target. The radial movement is then subtracted from the
position measurement performed by the first sensor.
In Normal mode the module behaves as a two channel differential unit with the
probes mounted on the casing and measuring the shaft position relative to the
(1) Head-to-Head and Radial Cancel modes are not available in the XM-124. See IMPORTANT note, above.
76
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Configure the XM-124 Standard Dynamic Measurement Module
Chapter 2
casing. Positioning of probes is critical to be sure that valid shaft movement
cannot at any time damage the probes. Selection of probe type and range is
obviously important. The static gaps of the probes are automatically subtracted
from the measurement so that the system can measure small movements relative
to the total gaps.
When using this mode, the module uses straight targets, angled targets, or mixed
target types, as shown in Figure 38.
Figure 38 - Normal Mode
The XM-124 provides monitoring facilities only for axial (thrust) measurements.
Eccentricity Measurement Options
The Eccentricity options apply to the Eccentricity measurement mode and affect
the Eccentricity measurement.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
77
Chapter 2
Configure the XM-124 Standard Dynamic Measurement Module
In this field
Values are
Comments
Output data unit
Select mil or μm.
The units of the Eccentricity measurement value.
Update rate
Enter a value from 1 to 255 seconds.
When the tachometer is enabled the Eccentricity
measurement value updates once per revolution. But when
the tachometer is disabled or faulted then the measurement
value updates at the specified period. Enter an update period
that is greater than the time it takes for one machine
revolution.
Configure the Tachometer Properties
The Tachometer tab defines the characteristics of the tachometer and the signal
processing that is performed on the tachometer signal.
1. From the Module Properties dialog box, click the Tachometer tab.
2. Configure the parameters, as necessary.
78
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Configure the XM-124 Standard Dynamic Measurement Module
Chapter 2
In this field
Values are
Comments
Enable Auto Trigger
Check to enable Auto Trigger mode. The minimum signal amplitude for
triggering is 2V peak-to-peak and the minimum frequency is 6 CPM (0.1
Hz).
Using Auto Trigger mode may cause the tachometer to trigger
on noise if the signal is very small. For example, you have 1V
of noise on a 2V signal. To prevent this, make sure the % noise
in the signal is less than the value entered in the Trigger
Hysteresis.
Clear to enable Manual Trigger mode. The value entered in Trigger
Threshold is used as the trigger point. The minimum signal amplitude
for triggering is 500 mV peak-to-peak and the minimum frequency is 1
CPM (0.016 Hz).
Trigger Hysteresis
Enter the amount of hysteresis around the trigger threshold.
Enter a value between 0…50.
In Auto Trigger mode, the value entered is a percentage of the
peak-to-peak input signal.
In Manual Trigger mode, the value entered is a voltage level.
The hysteresis voltage is added to or subtracted from the
threshold voltage to determine the hysteresis range.
Trigger Level
Enter the signal level to be used as the trigger value when in Manual
Trigger mode.
Trigger Slope
Choose the input signal slope to be used with the trigger value:
• Positive
• Negative
The trigger point of the tachometer defines 0° for phase measurement.
If the tachometer is a square wave, the phase angles measured varies by
180° depending on whether the Trigger Slope is set to positive or
negative.
DC High Limit
Enter the maximum expected DC bias voltage from the transducer.
DC Low Limit
Enter the minimum, or most negative, expected DC voltage from the
transducer.
Inhibit Zero Pulse Tachometer Fault
Check to enable Inhibit Zero Pulse Tachometer Fault.
This parameter is dimmed in Auto Trigger mode.
A voltage reading outside this range constitutes a transducer
fault, which is indicated with the tachometer status indicator
blinking red and the TachFault input tag.
Controls whether a tachometer fault occurs if no pulses are
detected on the tachometer signal.
Clear to disable Inhibit Zero Pulse Tachometer Fault.
Fault Delay
Enter the number of seconds that the module must wait after the last
valid pulse signal before it indicates a tachometer fault.
Enter a value between 1…64 seconds.
Pulses Per Revolution
Enter the number of tachometer signal pulses per revolution of the
shaft.
Enter 0 (zero) if you are not using a tachometer. This disables
the speed, acceleration, and most phase measurements.
If the speed sensor is a proximity probe over a keyway, there is one pulse
around the shaft. If the speed sensor is a proximity probe over a gear,
there is a pulse for each tooth on the gear. If the sensor detects reflective
tape or paint, there is a pulse for each reflective area around the shaft.
Response Time
Choose how quickly the measured speed value and acceleration value
responds to a change in the input signal:
• 2640 ms
• 220 ms
• 22 ms
Faster response times (22 ms) produce measurements that
are more accurate but are more susceptible to noise. Slower
response times (220 ms, 2640 ms) produce less accurate
measurements but are less susceptible to noise.
For example, setting this to 220 ms means that the speed is averaged
over a quarter second, and the reported value reaches 90% of the new
steady state value about 220 ms after the change in machine speed.
Fast response times are generally used when you need to
track rapid speed changes. Slow response times are generally
used for steady speed applications or applications where it is
not necessary to track speed during rapid changes.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
79
Chapter 2
Configure the XM-124 Standard Dynamic Measurement Module
Alarm, Relay, and 4…20 mA Output Parameters
Use this dialog box to configure alarms, relays, and the analog output signal. The
4…20 mA output has no dependencies, so these may be configured in any order.
However, the relay logic is dependent on alarms, so always configure alarms
before relays.
Table 7 - Alarm Parameters
80
Parameter Name
Description
Values/Comments
Number (1…16) (XM Serial Configuration Utility
only)
Sets the alarm to be configured in the XM Serial Configuration Utility.
There are 16 alarms in the XM-124 module. The alarms are not
restricted to a channel.
Select a number from 1…16.
Name (XM Serial Configuration Utility only)
A descriptive name to identify the alarm in the XM Serial
Configuration Utility.
Maximum 18 characters
Enable
Enable/disable the selected alarm.
Important: The Alarm Status is set to ‘Disarm’ when the alarm is
disabled.
XM Configuration
Utility
EDS File
Check to Enable
Enabled
Clear to Disable
Disabled
Measurement
The type of measurement and the channel that is associated with the
alarm.
Important: A maximum of eight alarms can be associated with any
one measurement.
Options: Ch1 / Ch2 Overall
• Ch1 / Ch2 Gap
• Ch1 / Ch2 Band 1–4
• Speed
• Mag
• Ch1 / Ch2 1X Mag
• Ch1 / Ch2 2X Mag
• Ch1 / Ch2 3X Mag
• Ch1 / Ch2 Not 1X
• Ch1 / Ch2 Sum Harmonics
• Ch1 / Ch2 1X Phase
• Ch1 / Ch2 2X Phase
• Phase
• Acceleration
• Ch1 / Ch2 Thrust Position
• Ch1 / Ch2 gSE Overall
• Ch1 / Ch2 Tracking Mag
• Ch1 / Ch2 Tracking Phase
• Ch1 / Ch2 Band Pass
• Ch1 / Ch2 Eccentricity
Condition
Controls when the alarm triggers:
• Greater than - Triggers the alarm when the measurement value
is greater than or equal to the Alert and Danger Threshold
values.
• The Danger Threshold value must be greater than or equal to the
Alert Threshold value for the trigger to occur.
• Less than - Triggers the alarm when the measurement value is
less than or equal to the Alert and Danger Threshold values.
• The Danger Threshold value must be less than or equal to the Alert
Threshold value for the trigger to occur.
• Inside range - Triggers the alarm when the measurement value
is equal to or inside the range of the Alert and Danger
Threshold values.
• The Danger Threshold (High) value must be less than or equal to
the Alert Threshold (High) value AND the Danger Threshold (Low)
value must be greater than or equal to the Alert Threshold (Low)
value for the trigger to occur.
• Outside range - Triggers the alarm when the measurement value
is equal to or outside the range of the Alert and Danger
Threshold values.
• The Danger Threshold (High) value must be greater than or equal
to the Alert Threshold (High) value, AND the Danger Threshold
(Low) value must be less than or equal to the Alert Threshold
(Low) value for the trigger to occur.
Options:
• Greater Than
• Less Than
• Inside Range
• Outside Range
Important: This parameter is not applicable for a
vector (phase) alarm type or phase measurement.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Configure the XM-124 Standard Dynamic Measurement Module
Chapter 2
Table 7 - Alarm Parameters
Parameter Name
Description
Values/Comments
Alert Threshold (High)
The threshold value for the alert (alarm) condition.
Important: This parameter is the greater threshold value when
Condition is set to ‘Inside Range’ or ‘Outside Range,’ the measurement
is a phase measurement (Configuration Utility), or the alarm type is a
vector alarm (EDS file).
Danger Threshold (High)
The threshold value for the danger (shutdown) condition.
Important: This parameter is the greater threshold value when
Condition is set to ‘Inside Range’ or ‘Outside Range,’ the
measurement is a phase measurement (Configuration Utility), or the
alarm type is a vector alarm (EDS file).
Alert Threshold (Low)
The lesser threshold value for the alert (alarm) condition.
Important: This parameter is not used when Condition is set to
‘Greater Than’ or ‘Less Than.’
Danger Threshold (Low)
The lesser threshold value for the danger (shutdown) condition.
Important: This parameter is not used when Condition is set to
‘Greater Than’ or ‘Less Than.’
Same measurement unit as Output Data Unit
selection for the specified channel except when
measurement/alarm type is phase (vector).
Phase Measurements/Vector Alarm Type
Requirements:
• The Alert Low, Danger Low, Alert High, and
Danger High must define contiguous sections
within the set of possible phase values
(0…360 degrees).
• If you were to plot the thresholds on a clock
face (illustration below) with phase increasing
in the clockwise direction, then set the
following:
– Alert Low must be clockwise from or equal
to Danger Low.
– Alert High must be clockwise from Alert
Low.
– Danger High must be clockwise from or
equal to Alert High.
Hysteresis
The amount that the measured value must fall (below the threshold)
before the alarm condition is cleared. For example, Alert Threshold =
120 and Hysteresis = 2. The alarm (alert) activates when the
measured value is 120 and does not clear until the measured value is
118.
Important: The Alert and Danger Thresholds use the same hysteresis
value.
Important: For the Outside Range condition, the hysteresis value must
be less than Alert Threshold (High) – Alert Threshold (Low).
Same measurement unit as Output Data Unit
selection for the specified channel.
Detection Delay
Enter the length of time for which the Alarm Condition must persist
before the alarm is signaled.
Applying delays may reduce nuisance alarms caused by external noise
and/or transient vibration events.
Enter a value between 0 and 65.5 seconds.
IMPORTANT: Delays may also be applied as part of the Relay
definition. Delays there are associated with the Relay’s Activation
Logic, and only begin once any Alarm condition is signaled.
Consequently, applying delays to both the Alarm and Relay results in
a total delay time, prior to relay actuation, that is the sum of the
alarm and relay delay times.
Start-up Period
The length of time that the Threshold Multiplier is applied to the
thresholds. The start-up period begins when the setpoint multiplier
switch is reopened (push button disengaged or toggle switch flipped
to off).
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Enter a value from 0…1092 minutes, adjustable
in increments of 0.1 minutes.
81
Chapter 2
Configure the XM-124 Standard Dynamic Measurement Module
Table 7 - Alarm Parameters
Parameter Name
Description
Values/Comments
Threshold Multiplier
The action to take when the setpoint multiplier switch is closed (push
button engaged or toggle switch flipped to on) and during the startup period once the switch is reopened. The module applies the
multiplier to the alarm thresholds during this time to avoid false
alarms at resonance frequencies.
Important: The multiplication may have the opposite of the intended
effect under certain circumstances. For example, if the Condition is set
to ‘Less Than’ and the thresholds are positive, then multiplication of
the threshold values increases the likelihood of the measured value
being within the alarm range. Therefore, you may want to set
Threshold Multiplier to zero to disable the alarm during the start-up
period.
Enter a floating point value in the range of 0…10.
Enter 0 (zero) to disabled the alarm during the
start-up period.
Speed Range Enable
Controls whether the selected alarm is enabled only when the
measured speed is within a machine speed range. Enter the machine
speed range in Speed Range High and Speed Range Low.
XM Configuration
Utility
EDS File
Check to Enable
Enabled
Clear to Disable
Disabled
Important: The tachometer must be enabled
(Pulses Per Revolution set to 1 or more) and a
tachometer signal must be provided at the
tachometer input when Speed Range Enable is
enabled.
Important: You cannot enable the Speed Range
parameter when alarm Measurement is set to
‘Speed.’ See page 71.
Speed Range Low
The lesser threshold of the machine speed range. This value must be
less than the Speed Range High value.
This parameter is not used when Speed Range Enabled is disabled.
rpm
Speed Range High
The greater threshold of the machine speed range. This value must be
greater than the Speed Range Low value.
This parameter is not used when Speed Range Enabled is disabled.
rpm
Relay Parameters
The Relay parameters control the operation of the on-board relay, as well as the
relays on the Expansion Relay (XM-441) module. Use these parameters to
82
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Configure the XM-124 Standard Dynamic Measurement Module
Chapter 2
configure which alarm the relay is associated with, as well as the behavior of the
relay.
IMPORTANT
A relay can be defined, regardless of whether or not it is physically present.
A non-physical relay is a virtual relay. When a relay (physical or virtual)
activates, the module sends a Change of State (COS) message to its master,
which acts on the condition as necessary. An XM-440 Master Relay Module
can activate its own relays in response to a relay (physical or virtual)
activation at any of its slaves.
Table 8 - Relay Parameters
Parameter Name
Description
Options/Comments
Number (XM Serial Configuration Utility only)
Sets the relay to be configured in the XM Serial Configuration Utility.
Relay Number 1 is the on-board relay. Numbers
2…5 are either relays on the Expansion Relay
module when it’s connected to the module or
virtual relays.
Virtual relays are non-physical relays. Use them
when you want the effect of the relay (monitor
alarms, delay, and change status) but do not need
an actual contact closure. For example, a PLC or
controller monitoring the relay status.
Important: The Relay Installed parameter
indicates whether a relay is a virtual relay or a
physical relay on a module.
Name (XM Serial Configuration Utility only)
A descriptive name to help identify the relay in the XM Serial
Configuration Utility.
Maximum 18 characters
Enable
Enable/disable the selected relay.
Important: The Relay Current Status is set to ‘Not Activated’ when
the relay is disabled. See page 96.
XM Configuration
Utility
EDS File
Check to Enable
Enabled
Clear to Disable
Disabled
XM Configuration
Utility
EDS File
Check means latching
(relay must be explicitly
reset)
Latching
Clear means non-latching
(relay is reset once the
alarm condition has
passed)
Nonlatching
XM Configuration
Utility
EDS File
Latching
Latching Option
Activation Delay
Controls whether the relay must be explicitly reset after the alarm
subsides.
Enter the length of time for which the Activation Logic must be true
before the relay is activated. This reduces nuisance alarms caused by
external noise and/or transient vibration events.
Important: True Peak and True Peak-to-Peak signal detection is
more sensitive to transients and noise. To avoid false relay trips, it is
strongly recommended that the Activation Delay value is greater
than the Overall Time Constant value when Signal Detection is
set to ‘True Peak’ or ‘True Peak-to-Peak.’
Important: The definition of each alarm may also include a
Detection Delay time. If so, the alarm must persist for the specified
Detection Delay time before the Relay Activation Logic can consider
the alarm condition. Consequently, if delays are applied to both the
alarm and the relay, the actual delay time of the relay is the sum of
the Alarm Detection Relay and the Relay Activation Delay.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Enter a value between 0…65.5 seconds. The
default is 1 second.
83
Chapter 2
Configure the XM-124 Standard Dynamic Measurement Module
Table 8 - Relay Parameters
Parameter Name
XM Configuration
Utility
EDS File
Activation Logic
Logic
XM Configuration
Utility
EDS File
Alarm A/B
Alarm Identifier
A/B
XM Configuration
Utility
EDS File
Alarm Status to Activate
On
Alarm Levels
Relay Installed
Description
Options/Comments
Sets the relay activation logic:
• A or B - Relay is activated when either Alarm A or Alarm B meets
or exceeds the selected Alarm Status condition.
• A and B - Relay is activated when both Alarm A and Alarm B
meet or exceed the selected Alarm Status condition.
• A Only - Relay is activated when Alarm A meets or exceeds the
selected Alarm Status condition.
Options:
• A only
• A or B
• A and B
Sets the alarm that the relay monitors. The alarm must be from the
same device as the relay. When the Activation Logic is set to ‘A and
B’ or ‘A or B’ you can select an alarm in both Alarm A and Alarm B.
The system monitors both alarms. When the Activation Logic is set
to ‘A Only,’ you can select an alarm only in Alarm A.
Alarm No. 1…16
Important: You can only select an alarm that is
enabled.
Sets the alarm conditions that cause the relay to activate. You can
select more than one:
• Normal - The current measurement is not within excess of any
alarm thresholds.
• Alert - The current measurement is in excess of the alert level
threshold but not in excess of the danger level threshold.
• Danger - The current measurement is in excess of the danger level
threshold.
• Disarm-The alarm is disabled or the device is in Program mode.
• Xdcr Fault - A transducer fault is detected on the associated
transducer.
• Module Fault - Hardware or firmware failure, or an error has
been detected and is preventing proper operation of the device.
• Tacho Fault - A required tachometer signal has not been
detected. Note that there is no transducer fault either.
Options:
• Normal
• Danger
• Xdcr Fault
• Tacho Fault
• Alert
• Disarm
• Module Fault
•
• Check to enable.
• Clear to disable.
Indicates whether the relay is a physical relay on a module or a virtual
relay. If the relay is a physical relay, then you can set the Failsafe
parameter.
If the relay is a virtual relay, the Failsafe parameter is not used or it is
disabled.
XM Configuration
Utility
EDS File
Failsafe Relay
Failsafe Option
Determines whether the relay is failsafe or non-failsafe.
Failsafe operation means that when in alarm, the relay contacts are in
their ‘normal’, de-energized, or ‘shelf-state’ positions. In other words,
normally closed relays are closed in alarm, and normally open relays
are open in alarm. With failsafe operation, a power failure equals an
alarm.
The following are true of a relay in failsafe operation:
• The relay is energized when power is applied to the module.
• The relay in a nonalarmed condition has power applied to the coil.
• In alarm condition, power is removed from the relay coil, causing
the relay to change state.
For non-failsafe operation, the following are true:
• Under nonalarm conditions, the relay closes the circuit between
the common and the N.C. (normally closed) terminals.
• Under alarm conditions, the relay changes state to close the circuit
between the common and the N.O. (normally open) terminals.
For failsafe operation, the following are true:
• Under nonalarm (with power applied to the unit) conditions, the
relay closes the circuit between the common and the N.O.
terminals.
• Under alarm or loss-of-power conditions, the relay changes state
to close the circuit between the common and the N.C. terminals.
84
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
XM Configuration
Utility
EDS File
Check = Physical Relay
Installed = Physical
Relay
Clear = Virtual Relay
Not Installed =
Virtual Relay
XM Configuration
Utility
EDS File
Check means failsafe
Failsafe
Clear means non-failsafe
Nonfailsafe
Configure the XM-124 Standard Dynamic Measurement Module
Chapter 2
4…20 mA Output Parameters
The 4…20 mA output parameters define the characteristics of the two 4…20 mA
output signals. The parameters are the same for each output.
Table 9 - 4…20 mA Parameters
Parameter Name
Description
Options/Comments
Enable
Enables/disables the 4…20 mA output.
XM Configuration
Utility
EDS File
Check to enable
Enabled
Clear to disable
Disabled
Measurement
Sets the type of measurement and the channel that the 4…20 mA
output signal tracks.
Options:
• Ch1 / Ch2 Overall
• Ch1 / Ch2 Gap
• Ch1 / Ch2 Band 1–4
• Speed
• Mag
• Ch1 / Ch2 1X Mag
• Ch1 / Ch2 2X Mag
• Ch1 / Ch2 3X Mag
• Ch1 / Ch2 Not 1X
• Ch1 / Ch2 Sum Harmonics
• Acceleration
• Ch1 / Ch2 Thrust Position
• Ch1 / Ch2 gSE Overall
• Ch1 / Ch2 Tracking Mag
• Ch1 / Ch2 Band Pass
• Ch1 / Ch2 Eccentricity
Min Range
The measured value associated with the 4 mA.
Max Range
The measured value associated with the 20 mA.
Same measurement unit as Output Data Unit
selection for the specified channel.
IMPORTANT
Measured values between Min Range and Max Range are scaled into the
range from 4…20 to produce the output value. The Min Range value does
not have to be less than the Max Range value. If the Min Range value is
greater than the Max Range value, then the output signal is effectively
inverted from the input signal.
IMPORTANT
The 4…20 mA outputs are either on or off. When they are on, the 4…20
mA outputs overshoot the 4 and 20 mA limits by 10% when the
measurement exceeds the minimum and maximum range. This means the
minimum current produced is 3.6 mA and the maximum current produced
is 22 mA.
When the 4…20 mA outputs are off, they produce a current approximately
2.9 mA. The 4…20 mA outputs are off under the following conditions:
The 4…20 mA outputs are set to ‘Disable’ (see Enable on the previous
page).
The module is in Program mode.
A transducer fault or tachometer fault occurs that affects the
corresponding measurement.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
85
Chapter 2
Configure the XM-124 Standard Dynamic Measurement Module
Triggered Trend Parameters
The XM-124 module can collect a triggered trend. A triggered trend is a timebased trend that is collected when a relay on the XM module is activated, or the
module receives a trigger event.
Once the triggered trend is configured, the XM module continuously monitors
the trended measurements. When a trigger occurs, the XM module collects
additional data as specified by the Post Trigger parameter. The XM-124 module
can also store the spectrum or waveform at the time of the trigger.
The XM module can only store one triggered trend. Unless the triggered trend is
latched, the trend data is overwritten with new data when the next trigger occurs.
The triggered trend parameters define the trend data that is collected by the
module. Use these parameters to select the measurements included in the trend
records, the interval between trend records, and which relay triggers (activates)
the collection of the trend data.
IMPORTANT
The Triggered Trend parameters are not included in the EDS file and cannot
be edited by using generic configuration tools such as RSNetWorx for
DeviceNet software.
Table 10 - Triggered Trend Parameters
86
Parameter Name
Description
Values/Comments
Enable Triggered Trend Measurements
Enables/disables the triggered trend measurements. Select to
configure the triggered trend measurements.
Check to enable.
Clear to disable.
Select Measurements
Sets the measurements to be collected and stored in the module.
1…16 measurements can be selected.
Number of Records
The maximum number of measurement sets that can be collected in
the trend buffer. The measurement sets make up the trend data.
The Number of Records is automatically calculated
based upon the number of Trended
Measurements selected.
Latch Enable
Determines whether the triggered trend is latched or unlatched.
Latched means that subsequent triggers are ignored after the initial
trigger. This prevents the trend data from being overwritten with new
data until the trigger is manually reset (click Reset Trigger).
Unlatched means that the trend data is overwritten with new data
every time a trigger occurs.
Check means latched
Clear means unlatched
Relay Number
Sets the relay that triggers the trend to be collected.
None means that the trend can only be triggered
manually or by a trigger event (for example, XM440).
Relay Number 1 is the on-board relay. Numbers
2…5 are either relays on the Expansion Relay
module when it’s connected to the module or
virtual relays.
Important: The relay must be enabled. Refer
to Relay Parameters on page 82.
Record Interval
The amount of time between consecutive trend records.
Important: If you enter a Record Interval, the Trend Span is
automatically updated.
1…3600 seconds
Trend Span
The total amount of time that can be covered by the trend data
(Number of Records x Record Interval).
Important: If you edit the Trend Span, the Record Interval is
automatically updated.
Seconds
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Configure the XM-124 Standard Dynamic Measurement Module
Chapter 2
Table 10 - Triggered Trend Parameters
Parameter Name
Description
Values/Comments
Post Trigger
The percentage of records to be collected once the trigger occurs. For
example, if you set Post Trigger to 20%, then 80% of the records in the
trend are before the trigger occurs, and 20% of the records in the
trend are after the trigger occurs.
This lets you to evaluate what happened after the trigger occurred.
0…100%
Status
Shows the status of the trend data.
Possible status values:
• Not collected - No trend data is currently
collected.
• Collecting - A trigger has occurred and data
(including post-trigger data) is being collected.
• Collected - A trend has been saved to the buffer
and is available to view and upload.
Store Spectrum
Stores the current spectrum data for both Channel 1 and Channel 2
when the trigger occurs.
Store Waveform
Stores the current waveform data for both Channel 1 and Channel 2
when the trigger occurs.
View Trend Data
Displays a plot of the collected trend data.
Reset Trigger
Resets the trigger if Latch enabled is selected. This enables the
module to overwrite the previous trend data when the next trigger
occurs.
Manual Trigger
Triggers the module to collect the trend data without relay activation.
View Collected Data
Displays a plot of the collected spectrum or waveform data.
SU/CD Trend Parameters
The XM-124 module can collect start-up or coast-down trend data when the
machine speed passes into a defined speed range. A tachometer input is required
to collect the start-up/coast-down trend.
The XM module collects a start-up trend when the machine speed rises through
the Minimum Speed + 8 rpm, and stops when the machine speed crosses either
the Minimum Speed or the Maximum Speed. The module collects data only
when machine speed is increasing. It does not collect data if the machine speed is
constant or decreasing.
The XM module collects a coast-down trend when the machine speed falls
through the Maximum Speed - 8 rpm, and stops when the machine speed crosses
either the Minimum Speed or the Maximum Speed. The module collects data
when the machine speed is decreasing or increasing during a coast-down trend
(for example, a coast-down restart).
The XM module can only store one start-up/coast-down trend. Unless the startup/coast-down trend is latched, the trend data is overwritten with new data when
the next trigger occurs.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
87
Chapter 2
Configure the XM-124 Standard Dynamic Measurement Module
The SU/CD trend parameters define the trend data that is collected by the
module during the start-up or coast-down of a machine. Use these parameters to
configure the measurements included in the start-up and coast-down trend
records, the interval between trend records, and the minimum and maximum
speed limits at which record collection starts and stops.
IMPORTANT
The SU/CD Trend parameters are not included in the EDS file and cannot be
edited by using generic configuration tools such as RSNetWorx for
DeviceNet software.
Table 11 - SU/CD Trend Parameters
88
Parameter Name
Description
Values/Comments
Enable SU/CD Trend
Enables/disables the SU/CD trend measurements. Select to configure
the SU/CD trend measurements.
Check to enable.
Clear to disable.
Select Measurements
Sets the measurements to be collected and stored in the module.
Important: The Speed measurement is always included in the startup/coast-down trend.
1…16 measurements can be selected.
Number of Records
The maximum number of measurement sets that can be collected in
the trend buffer. The measurement sets make up the trend data.
The Number of Records is automatically calculated
based upon the number of Trended
Measurements selected.
Latch Enable
Determines whether the start-up/coast-down trend is latched or
unlatched.
Latched means that subsequent start-up/coast-down trends are
ignored after the initial start-up/coast-down. This prevents the trend
data from being overwritten with new data until the trigger is
manually reset (click Reset Trigger).
Unlatched means that the start-up/coast-down trend data is
overwritten with new data every time the machine speed crosses into
the speed range.
Check means latched
Clear means unlatched
Record Interval
The change in speed between consecutive records.
Important: If you enter a Record Interval, the Maximum Trend
Span is automatically updated.
1…3600 rpm
Maximum Trend Span
The maximum change in speed that can be covered by the trend data
(Number of Records x Record Interval).
Important: If you edit the Trend Span, the Record Interval is
automatically updated.
rpm
Minimum Speed
The lesser limit of the speed range in which records are collected in
the start-up/coast-down trend. This value must be less than the
Maximum Speed value.
Maximum Speed
The greater limit of the speed range in which records are collected in
the start-up/coast-down trend. This value must be greater than the
Minimum Speed value.
rpm
Start-up/Coast-down Trend Considerations:
• The XM module collects a start-up trend when
the machine speed rises through the
Minimum Speed + 8 rpm, and stops when
the machine speed crosses either the
Minimum Speed or the Maximum Speed.
The module collects data only when the
machine speed is increasing. It does not collect
data if the machine speed is constant or
decreasing.
• The XM module collects a coast-down trend
when the machine speed falls through the
Maximum Speed - 8 rpm, and stops when the
machine speed crosses either the Minimum
Speed or the Maximum Speed. The module
collects data when the machine speed is
decreasing or increasing during a coast-down
trend (for example, a coast-down restart).
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Configure the XM-124 Standard Dynamic Measurement Module
Chapter 2
Table 11 - SU/CD Trend Parameters
Parameter Name
Description
Values/Comments
Status
Shows the status of the trend data.
Possible status values:
• Not collected - No trend data is currently
collected.
• Collecting - A trigger has occurred and data is
being collected.
• Collected - A trend has been saved to the buffer
and is available to view and upload.
View Trend Data
Displays a plot of the collected trend data.
Reset Trigger
Resets the trigger if Latch enabled is selected. This enables the
module to overwrite the previous trend data when the machine speed
crosses into the speed range.
I/O Data Tab
If the module’s poll output table is read by a controller, then consideration must
be given to the content and organization of the displayed table before configuring
the module. This is because the module configuration must support (produce)
the measurements defined in this table. Knowing what must be produced is
critical to properly configuring the module.
Figure 39 - 1 Main Editor View, I/O Data Tab
Change of State (COS)
The editor displays the structure of the COS table if the COS size or COS
output fields are clicked but the COS assembly is fixed and cannot be changed.
Poll Output
The output table defines the structure of the table output when polled by a
scanner. The size and contents of the poll output can be modified in either
Defined or Custom Assembly.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
89
Chapter 2
Configure the XM-124 Standard Dynamic Measurement Module
Defined Assembly
The Configuration Utility lets you define the Output Table contents either by
uniquely defining a Custom Assembly. or by using the predefined assembly
instance, 101.
Figure 40 - 1 Pre-defined Assembly Instances
The pre-defined assembly instance 101 appears as in the below figure.
Figure 41 - Assembly Instance 101
When using the predefined assembly, the parameters and the order in which they
appear is fixed. However, you may specify that only a subset of the assembly be
communicated by limiting the number of bytes that are to be transmitted by
using the Poll size parameter.
Figure 42 - 1 Assembly Instance 101 with Poll Size Set to 8
90
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Configure the XM-124 Standard Dynamic Measurement Module
Chapter 2
The importance of this is that it lets you do the following:
• Limit the amount of data transmitted to just that which is necessary for
the application. This minimizes the network loading on the DeviceNet
network.
• Minimize the amount of scanner space required. DeviceNet scanners
provide no more than about 500-bytes for their input table. By minimizing
the size of the output table from each module, you can optimize the space
available in their scanner table.
Custom Assembly
In some cases, the predefined assembly instance does not include the desired data
in the required order. In these cases, a custom assembly can be specified.
IMPORTANT
If a Custom Assembly is used, then the data in the controller table is not
individually identified. It is up to you to map the desired data from the
appropriate location in the table.
To define a Custom Assembly click Custom Assembly on the dialog box to open
the Custom Assembly Configuration editor.
Figure 43 - 1 Custom Assembly Configuration Dialog Box
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
91
Chapter 2
Configure the XM-124 Standard Dynamic Measurement Module
1. Click the left and right arrows between the panes to move the desired
parameters to the ‘Custom assembly’ pane (right side).
2. Click the up and down arrows to change the order of the parameters.
3. Click OK.
The custom assembly is then presented as the assembly on the I/O dialog
box (see below figure).
Figure 44 - 1 Custom Assembly on I/O Tab
Module
Use this dialog box to view the module identity specifics, including its DeviceNet
address and communication rate. Depending on the module’s DIP switch
settings, it may also be used to set the module’s address and communication rate,
as well as to update the module’s firmware.
Identity
The identify section presents information read from the module. If no module is
connected these values are blank. Note that these values may be asked for when
discussing issues with the Rockwell Automation Technical Support group.
92
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Configure the XM-124 Standard Dynamic Measurement Module
Chapter 2
DeviceNet Network
The DeviceNet section shows the current setting of a connected modules
DeviceNet address and communication rate. If no module is connected these
values display ‘Node address: 63’ and ‘Communication rate: AutoBaud’.
SW1 (leftmost switch): DIP switch enable/disable
SW2: Normal/Legacy mode selection
SW3 – SW4: Set the communication rate
Communication
Rate
SW 3
SW 4
125 Kbps
0
0
250 Kbps
0
1
500 Kbps
1
0
Autobaud
1
1
SW5 – SW10: Set the MAC ID (DeviceNet address). See Set The Module DIP
Switch on page 52 for details on how to set a node address using DIP switches.
Firmware Update
The firmware update section shows the current firmware revision of the
connected module. The field is blank if no module is connected. Click Update
Firmware to load a new firmware into the module.
IMPORTANT
Before updating the firmware, be sure that the module is not slaved to an
XM-440 Master Relay module or to a scanner.
View Data
The Data parameters are used to view the measured values of the input channels
and the 4…20 mA outputs, as well as to monitor the status of the channels,
alarms, and relays.
TIP
To view all the data parameters in the XM Serial Configuration Utility, click
the View Data tab.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
93
Chapter 2
Configure the XM-124 Standard Dynamic Measurement Module
Monitor Data Parameters
Table 12 - Monitor Data Parameters
Parameter Name
XM Configuration
Utility
EDS File
Transducer Fault
Transducer Status
XM Configuration
Utility
EDS File
DC Bias (Gap)
Measured DC Bias
Description
Values/Comments
States whether a transducer fault exists on the associated channel.
If a fault exists, the overall and gap values may not be accurate.
Possible status values:
• No Fault
• Fault
Shows the measured average DC offset of the transducer signal. This
value is compared with DC High Limit and DC Low Limit to determine
whether the transducer is working properly.
Overall
Shows the measured standard overall value.
gSE Overall
Shows the measured gSE Overall value.
Band Pass
Shows the measured Band Pass Filter value.
Tracked Mag
Shows the measured Tracking Filter Magnitude value.
Tracked Phase
Shows the measured Tracking Filter Phase value.
Eccentricity
Shows the measured Eccentricity value.
Thrust Position
Shows the measured Thrust Position value.
XM Configuration
Utility
EDS File
Sum Harmonics
Sum Harmonics
Value
Band Measurement Status (XM Serial
Configuration Utility only)
Shows the measured sum harmonics value.
The tachometer must be enabled (Pulses Per
Revolution set to 1 or more), and a tachometer
signal must be present.
States whether a fault condition exists on the associated channel. If a
fault exists, the band measurements may not be accurate.
Possible status values:
• No Fault
• Fault
Shows the measured band value.
94
XM Configuration
Utility
EDS File
Band Measurement
Band Measured
Value
Not 1X and Vector Status (XM Serial Configuration
Utility only)
States whether a fault condition exists on the associated channel. If a
fault exists, the not 1X and vector measurements may not be
accurate.
The following conditions can cause a fault:
• Atransducer fault on the associated channel
• No tachometer signal or a transducer fault exists on the
tachometer channel
• The machine speed changes too fast for the tracking algorithm to
keep up or if the frequency of FMAX goes outside the specified
criteria (see Sampling Mode on page 68)
Possible status values:
• No Fault
• Fault
Not 1X Value
Shows the magnitude of the vibration excluding the vibration at the
machine speed.
1X Magnitude
The magnitude of the vibration at the machine speed.
The tachometer must be enabled (Pulses Per
Revolution set to 1 or more), and a tachometer
signal must be present.
1X Phase
The phase of the vibration at the machine speed.
2X Magnitude
The magnitude of the vibration at two times the machine speed.
2X Phase
The phase of the vibration at two times the machine speed.
3X Magnitude
The magnitude of the vibration at three times the machine speed.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Configure the XM-124 Standard Dynamic Measurement Module
Chapter 2
Table 12 - Monitor Data Parameters
Parameter Name
Description
Values/Comments
Ch1/Ch2 Spectrum/Waveform Status (XM Serial
Configuration Utility only)
States whether a fault condition exists on the associated channel. If a
fault exists, the spectrum/waveform data may not be accurate.
The following conditions can cause a fault:
• A transducer fault on the associated channel
• Sampling Mode set to ‘Synchronous’ and there is no tachometer
signal or there is a fault on the tachometer channel
• The machine speed changes too fast for the tracking algorithm to
keep up or if the frequency of FMAX goes outside the specified
criteria (see Sampling Mode on page 68)
Get Waveform Data Only (XM Serial Configuration
Utility only)
Controls whether the spectrum is calculated by the Configuration
Utility or the Standard Dynamic Measurement Module.
Check to upload only waveform data from the
module. The Configuration Utility calculates and
displays the spectrum using the collected
waveform data.
Clear to upload both the waveform and spectrum
data from the module.
XM Configuration
Utility
EDS File
States whether a fault condition (no tachometer signal or transducer
fault) exists on the tachometer channel. If a fault exists, the speed
value may not be accurate.
Possible status values:
• No Fault
• Fault
Speed Status
Transducer 3 Status
XM Configuration
Utility
EDS File
Shows the measured average DC offset of the tachometer signal. This
value is compared with Fault High and Fault Low to determine
whether the tachometer is working properly.
The tachometer must be enabled (Pulses Per
Revolution set to 1 or more).
DC Bias (Gap)
Transducer 3
Measured DC Bias
Speed Value
Shows the measured speed value.
Peak Speed
Shows the greatest measured Speed Value (positive or negative)
since the most recent reset.
Acceleration Measured Value
Shows the measured acceleration value. The acceleration is the rate of
change of the Speed Value.
4…20 mA Output A and B (XM Serial
Configuration Utility only)
Shows the current output value in the range of 4…20 mA.
Status (XM Serial Configuration Utility only)
States whether a fault condition exists on either channel. If a fault
exists, the magnitude and phase values may not be accurate.
Possible status values:
• No Fault
• Fault
SMAX Magnitude
The greatest peak magnitude around the orbit.
SMAX Phase
The phase at which the greatest peak magnitude occurs around the
orbit.
SMAX Measurement Requirements:
• The transducers on channel 1 and 2 must be
similar.
• The transducers must be installed around the
machine shaft, in the same radial plane, 90°
apart (vertically and horizontally, for example).
• Both channels must be configured for the same
filtering and Full Scale settings.
• The Transducer Nominal Sensitivity parameter
must be set for displacement (mils or μm).
• We recommend that the tachometer is enabled
(Pulses Per Revolution set to 1 or more) and
a tachometer signal present.
• Both channels must be set to either Standard or
Thrust Position Measurement Mode.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
95
Chapter 2
Configure the XM-124 Standard Dynamic Measurement Module
Alarm and Relay Status Parameters
Table 13 - Alarm and Relay Status Parameters
96
Parameter Name
Description
Values/Comments
Alarm Status
States the current status of the alarm.
Possible status values:
• Normal - The alarm is enabled, the device is in
Run mode, there is no transducer fault, and the
current measurement is not within the Alert or
Danger Threshold value.
• Alert - The alarm is enabled, the device is in
Run mode, there is no transducer fault, and the
current measurement is in excess of the Alert
Threshold value but not in excess of the Danger
Threshold value.
• Danger - The alarm is enabled, the device is in
Run mode, there is no transducer fault, and the
current measurement is in excess of the
Danger Threshold value.
• Disarm-The alarm is disabled or the device is in
Program mode.
• Transducer Fault - The alarm is enabled, the
device is in Run mode, and a transducer fault is
detected on the associated transducer.
• Tachometer Fault - The alarm is enabled, the
device is in Run mode, a tachometer fault
exists, but there is no transducer fault.
• Module Fault - Hardware or firmware failure,
or an error has been detected and is preventing
proper operation of the device.
Relay Status
States the current status of the relay.
Possible status values:
• Activated
• Not Activated
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Chapter
3
Operate the Module
Topic
Page
Module Inputs
97
Module Outputs
97
Modes
98
Reset Switch
99
XM Services
100
Invalid Configuration Errors
101
XM-124 Module I/O Message Formats
101
Module Inputs
The XM-124 module accepts eddy current transducer signals, accelerometer
signals, and voltage signals from dynamic measurement sensors such as those
from velocity or pressure transducers. A tachometer input is also provided.
Module Outputs
The XM-124 module provides an active buffer for each of the vibration
transducer inputs, a resistive buffer for the tachometer input, and two isolated,
analog 4…20 mA outputs independently programmed to represent any measured
parameter for the two transducer inputs.
The two 4…20 mA outputs are independently programmed to represent any
measured parameter from either channel. Isolation is 250V between channels and
to other circuits.
IMPORTANT
The module has a 300 ohm maximum load.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
97
Chapter 3
Modes
Operate the Module
The XM-124 module operates in two modes.
Mode
Description
Run
The XM-124 standard dynamic measurement module collects measurement data and
monitors each measurement device.
The XM-440 establishes I/O connections with the XM measurement modules in its
scan list and monitors their alarms, and controls its own relay outputs accordingly.
Program
The XM-124 module is idle.
The XM-124 measurement modules stop the signal processing/measurement
process, and the status of the alarms is set to the disarm state to prevent a false alert
or danger status.
The XM-440 closes the I/O connections with the XM measurement modules in its scan
list and stops monitoring their alarms, relays are deactivated unless they are latched.
Configuration parameters can be read, updated and downloaded to the XM-124
module.
To change the operation mode of the module, use the parameter in the EDS file.
Note that the Stop and Start services can also be used to change the operation
mode.
IMPORTANT
The XM Serial software automatically puts the XM-124 module in Program
mode and Run mode without user interaction.
Transition to Program Mode
Parameter values can only be downloaded to the XM-124 module while the
module is in Program mode. Any attempt to download a parameter value while
the module is in Run mode results in a Device State Conflict error.
To transition from Run mode to Program mode on a DeviceNet network, set the
Device Mode parameter to Program mode and click Apply. Note that you cannot
change any other parameter until you have downloaded the Program mode
parameter.
TIP
The Module Status indicator flashes green when the module is in Program
mode.
Refer to your DeviceNet documentation for specific instructions on editing EDS
device parameters.
TIP
98
You can also use the Stop service to transition the module to Program
mode.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Operate the Module
Chapter 3
Transition to Run Mode
To collect data and monitor measurement devices, the module must be in Run
mode. To transition the XM-124 module from Program mode to Run mode on a
DeviceNet network, set the Device Mode parameter to Run mode and click
Apply.
TIP
The Module Status indicator is solid green when the module is in Run
mode.
Refer to your DeviceNet documentation for specific instructions on editing EDS
device parameters.
TIP
Reset Switch
You can also use the Start service to transition to Run mode.
The XM-124 module has an external reset switch on top of the module. The
Reset switch can be used to reset all latched relays in the Relay Expansion module
when it is attached to the XM-124 module.
Reset switch
IMPORTANT
The Reset switch resets the relays only if the input is no longer in alarm or
the condition that caused the alarm is no longer present.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
99
Chapter 3
Operate the Module
The table below defines services supported by the XM-124 module. The table
includes the service codes, classes, instances, and attributes by their appropriate
hexadecimal codes. Use the Class Instance Editor in RSNetWorx software to
execute these services, as illustrated in the example below.
XM Services
Table 14 - XM Services
Service Code
(Hex)
Class
(Hex)
Instance
Attribute
Data
Transition to Run Mode
Start
(06)
Object (320)
1
None
None
Transition to Program Mode
Stop
(07)
Object
(320)
1
None
None
Save configuration to nonvolatile memory
(EEPROM)
Save
(16)
Object
(320)
1
None
None
Delete saved configuration from nonvolatile
memory (EEPROM)
Delete
(09)
Object
(320)
1
None
None
Reset a specific latched relay
Reset
(05)
Relay Object
(323)
Relay number 1-C for
XM-440, 1-5 for XM12X, XM-320 and XM220, 1-8 for XM-36X
and XM-16X
None
None
Reset all latched relays
Reset
(05)
Relay Object
(323)
0
None
None
Reset the Peak Speed (XM-12X only)
Reset
(05)
Speed Measurement Object
(325)
1, 2 for XM-220
None
None
Close the virtual setpoint multiplier switch
to activate the alarm setpoint multipliers
Other
(33)
Discrete Input Point Object
(08)
1
None
None
Open the virtual setpoint multiplier switch
to start the setpoint multiplier timers and
eventually cancel alarm setpoint
multiplication
Other
(32)
Discrete Input Point Object
(08)
1
None
None
Action
Example
To save the configuration parameters to the nonvolatile memory (EEPROM), fill
in the Class Instance Editor as shown below.
Choose the Save
service code.
Clear Send the attribute ID
and then enter the Class
(320 hex) and Instance (1).
Click Execute to
initiate the action.
100
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Operate the Module
Invalid Configuration Errors
Chapter 3
A Start or Save service request to the XM-124 module may return an Invalid
Device Configuration error when there is a conflict amongst the configuration
settings.
The general error code for the Invalid Device Configuration error is D0hex. An
additional error code is returned with the general error code to specify which
configuration settings are invalid. The table below lists the additional error codes
associated with the Invalid Device Configuration error.
Table 15 - Additional Error Codes returned with the Invalid Device Configuration Error (0xD0)
XM-124 Module I/O Message
Formats
Error Code (Hex)
Description
01
No specific error information is available.
02
Mismatched transducer, channel, and/or measurement unit.
03
Inverted transducer fault high/low values.
04
Alarm thresholds conflict with the alarm condition.
05
Alarm speed range is invalid.
06
Band minimum frequency is greater than maximum frequency. Or, maximum frequency is
greater than FMAX.
07
Relay is associated with an alarm that is not enabled.
08
Tachometer must be enabled for alarm or channel settings.
09
A senseless speed range is enabled on a speed alarm.
0A
Too many alarms associated with a single measurement.
0B
Invalid node address in the alarm list.
0C
Too many alarms in the alarm list. Or, no alarms in the alarm list.
0D
Alarm levels cannot be zero for alarms that are enabled.
0E
Too many slaves in the scanner’s input data table.
0F
The FMAX and Number of Lines do not yield correct vector calculations.
10
Phase (vector) alarms prohibited with synchronous sampling and more than 1 tachometer pulse
per revolution.
11
Can’t have order based band on asynchronous channel.
12
Unsupported Sensor Type and Channel ID combination.
13
Invalid Alarm Type for the associated measurement ID.
14
Synchronous sampling is required for alarm on synchronous measurements.
15
Integration is not supported with the Bypass High Pass Filter option.
The XM-124 standard dynamic measurement module supports Poll, Change of
State (COS), and Bit-Strobe I/O messages. The Poll response message is used by
the module to produce measured values, and the COS message is used to produce
the Alarm and Relay Status. The Bit-Strobe message is used by a master device to
send a trigger event to all the XM slaves on the network.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
101
Chapter 3
Operate the Module
Poll Message Format
The XM-124 module Poll request message contains no data. The Poll response
message can contain up to 44 REAL values for a total of 176 bytes.
The XM-124 module provides one pre-defined (static) data format of the Poll
response, defined in Assembly instance 101. It also provides a dynamic Assembly
instance, instance 199, with which you can define a custom data format for the
Poll response. The dynamic Assembly instance can contain any of the
measurement parameters included in Assembly instance 101, as well as several of
the alarm and relay configuration parameters.
The default Assembly instance is 101 and the default size is 20 bytes. You can
change the Assembly instance and define the custom Assembly instance using the
configuration software. Refer to I/O Data Tab on page 89.
The Poll response data can also be requested explicitly through Assembly Object
(Class ID 0x4), Instance 101 (0x65), Data Attribute (3). When you explicitly
request the Data Attribute for Assembly instance 101, it returns the entire 176
bytes.
The following tables show the static data format of Assembly instance 101.
Table 16 - XM-124 Module Assembly Instance 101 Data Format
102
Byte
Definition
0…3
Channel 1 Overall measurement value
4…7
Channel 2 Overall measurement value
8…11
Channel 1 Gap measurement value
12…15
Channel 2 Gap measurement value
16…19
Current Speed measurement value
20…23
Peak Speed measurement value
24…27
Channel 1 Band 1 measurement value
28…31
Channel 2 Band 1 measurement value
32…35
Channel 1 Band 2 measurement value
36…39
Channel 2 Band 2 measurement value
40…43
Channel 1 Band 3 measurement value
44…47
Channel 2 Band 3 measurement value
48…51
Channel 1 Band 4 measurement value
52…55
Channel 2 Band 4 measurement value
56…59
Channel 1 1X Vector Magnitude measurement value
60…63
Channel 1 1X Vector Phase measurement value
64…67
Channel 2 1X Vector Magnitude measurement value
68…71
Channel 2 1X Vector Phase measurement value
72…75
Channel 1 2X Vector Magnitude measurement value
76…79
Channel 1 2X Vector Phase measurement value
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Operate the Module
Chapter 3
Table 16 - XM-124 Module Assembly Instance 101 Data Format
Byte
Definition
80…83
Channel 2 2X Vector Magnitude measurement value
84…87
Channel 2 2X Vector Phase measurement value
88…91
Channel 1 3X Vector Magnitude measurement value
92…95
Channel 2 3X Vector Magnitude measurement value
96…99
Channel 1 Not 1X measurement value
100…103
Channel 2 Not 1X measurement value
104…107
SMAX Magnitude measurement value
108…111
SMAX Phase measurement value
112…115
Channel 1 Sum Harmonics measurement value
116…119
Channel 2 Sum Harmonics measurement value
120…123
Channel 1 Position Measurement
124…127
Channel 2 Position Measurement
128…131
Acceleration measurement value
132
Channel 1 Measurement Mode
133
empty
134
Channel 2 Measurement Mode
135
empty
136…139
Channel 1 gSE Overall measurement value
140…143
Channel 2 gSE Overall measurement value
144…147
Channel 1 Eccentricity measurement value
148…151
Channel 2 Eccentricity measurement value
152…155
Channel 1 Band Pass measurement value
156…159
Channel 2 Band Pass measurement value
160…163
Channel 1 Tracked Magnitude measurement value
164…167
Channel 1 Tracked Phase measurement value
168…171
Channel 2 Tracked Magnitude measurement value
172…175
Channel 2 Tracked Phase measurement value
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
103
Chapter 3
Operate the Module
COS Message Format
The XM-124 module’s COS message contains 8 bytes of data as defined in the
table below. The COS data can also be requested explicitly through Assembly
Object (Class ID 0x4), Instance 100 (0x64), Data Attribute (3).
Table 17 - XM-124 COS Message Format
Byte
Bit 7
Bit 6
Bit 5
Bit 4
Bit 3
Bit 2
0
Relay 1 Status
Setpoint Multiplier
Status
Alarm 2 Status
Alarm 1 Status
1
Relay 2 Status
Channel 1 Transducer
Status
Alarm 4 Status
Alarm 3 Status
2
Relay 3 Status
Channel 2 Transducer
Status
Alarm 6 Status
Alarm 5 Status
3
Relay 4 Status
Tachometer
Transducer Status
Alarm 8 Status
Alarm 7 Status
4
Relay 5 Status
Reserved
Alarm 10 Status
Alarm 9 Status
5
Reserved
Reserved
Alarm 12 Status
Alarm 11 Status
6
Reserved
Reserved
Alarm 14 Status
Alarm 13 Status
7
Reserved
Reserved
Alarm 16 Status
Alarm 15 Status
Bit 1
Bit 0
XM Status Values
The following tables describe the XM Status values that are included in the COS
messages.
Table 18 - Alarm Status Descriptions
Alarm Status Value
Description
0
Normal
1
Alert
2
Danger
3
Disarm
4
Transducer Fault (Sensor OOR)
5
Module Fault
6
Tachometer Fault
7
Reserved
Table 19 - Setpoint Multiplier Status Descriptions
104
Setpoint Multiplier Status Value
Description
0
Not Activated
1
Activated
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Operate the Module
Chapter 3
Table 20 - Relay Status Descriptions
Relay Status Value
Description
0
Not Activated
1
Activated
Table 21 - Transducer Status Descriptions
Relay Status Value
Description
0
No Fault
1
Transducer Fault
Bit-Strobe Message Format
The Bit-Strobe command sends one bit of output data to each XM slave whose
node address appears in the master’s scanlist.
The Bit-Strobe command message contains a bit string of 64 bits (8 bytes) of
output data, one output bit per node address on the network. One bit is assigned
to each node address supported on the network (0…63) as shown in Figure 45.
Figure 45 - Bit-Strobe Command
The XM-124 module uses the bit received in a Bit-Strobe connection as a trigger
event. When the bit number corresponding to the module’s node address is set,
the module collects the triggered trend data and store the spectrum or waveform
data.
Note that the XM-124 module does not send data in the Bit-Strobe response.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
105
Chapter 3
Operate the Module
Notes:
106
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Chapter
4
Trends
Triggered
Topic
Page
Triggered
107
SU/CD
108
The XM-124 module can collect a triggered trend. A triggered trend is a timebased trend that is collected when a relay on the module is activated, or when the
module receives a trigger event.
Once the triggered trend is configured, the XM-124 module continuously
monitors the trended measurements. When a trigger occurs, the module collects
additional data as specified by the Post Trigger parameter. The XM-124 module
can also store the spectrum or waveform at the time of the trigger.
The XM-124 module can only store one triggered trend. Unless the triggered
trend is latched, the trend data is overwritten with new data when the next trigger
occurs.
The triggered trend parameters define the trend data that is collected by the
module. Use these parameters to select the measurements included in the trend
records, the interval between trend records, and which relay triggers (activates)
the collection of the trend data.
IMPORTANT
The Triggered Trend parameters are not included in the EDS file and cannot
be edited using generic configuration tools such as RSNetWorx for
DeviceNet software.
Table 22 - Triggered Trend Parameters
Parameter Name
Description
Values/Comments
Enable Triggered Trend Measurements
Enables/disables the triggered trend measurements. Select to
configure the triggered trend measurements.
Check to enable.
Clear to disable.
Select Measurements
Sets the measurements to be collected and stored in the module.
1 to 16 measurements can be selected.
Number of Records
The maximum number of measurement sets that can be collected in
the trend buffer. The measurement sets make up the trend data.
The Number of Records is automatically calculated
based upon the number of Trended
Measurements selected.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
107
Chapter 4
Trends
Table 22 - Triggered Trend Parameters
Parameter Name
Description
Values/Comments
Latch Enable
Determines whether the triggered trend is latched or unlatched.
Latched means that subsequent triggers are ignored after the initial
trigger. This prevents the trend data from being overwritten with new
data until the trigger is manually reset (click Reset Trigger).
Unlatched means that the trend data is overwritten with new data
every time a trigger occurs.
Check means latched
Clear means unlatched
Relay Number
Sets the relay that triggers the trend to be collected.
None means that the trend can only be triggered
manually or by a trigger event (for example, XM440).
Relay Number 1 is the on-board relay. Numbers 2
through 5 are either relays on the Expansion Relay
module when it’s connected to the module or
virtual relays.
Important: The relay must be enabled. Refer
to Relay Parameters on page 82.
Record Interval
The amount of time between consecutive trend records.
Important: If you enter a Record Interval, the Trend Span is
automatically updated.
1 to 3600 seconds
Trend Span
The total amount of time that can be covered by the trend data
(Number of Records x Record Interval).
Important: If you edit the Trend Span, the Record Interval is
automatically updated.
Seconds
Post Trigger
The percentage of records to be collected once the trigger occurs. For
example, if you set Post Trigger to 20%, then 80% of the records in the
trend are before the trigger occurs, and 20% of the records in the
trend are after the trigger occurs.
This lets you to evaluate what happened after the trigger occurred.
0…100%
Status
Shows the status of the trend data.
Possible status values:
• Not collected - No trend data is currently
collected.
• Collecting - A trigger has occurred and data
(including post-trigger data) is being collected.
• Collected - A trend has been saved to the buffer
and is available to view and upload.
Store Spectrum
Stores the current spectrum data for both Channel 1 and Channel 2
when the trigger occurs.
Store Waveform
Stores the current waveform data for both Channel 1 and Channel 2
when the trigger occurs.
View Trend Data
Displays a plot of the collected trend data.
Reset Trigger
Resets the trigger if Latch enabled is selected. This enables the
module to overwrite the previous trend data when the next trigger
occurs.
Manual Trigger
Triggers the module to collect the trend data without relay activation.
View Collected Data
Displays a plot of the collected spectrum or waveform data.
SU/CD
The XM-124 module can collect start-up or coast-down trend data when the
machine speed passes into a defined speed range. A tachometer input is required
to collect the start-up/coast-down trend.
The XM-124 module collects a start-up trend when the machine speed rises
through the Minimum Speed + 8 rpm, and stops when the machine speed
crosses either the Minimum Speed or the Maximum Speed. The module
108
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Trends
Chapter 4
collects data only when machine speed is increasing. It does not collect data if the
machine speed is constant or decreasing.
The XM-124 module collects a coast-down trend when the machine speed falls
through the Maximum Speed - 8 rpm, and stops when the machine speed crosses
either the Minimum Speed or the Maximum Speed. The module collects data
when the machine speed is decreasing or increasing during a coast-down trend
(for example, a coast-down restart).
The XM-124 module can only store one start-up/coast-down trend. Unless the
start-up/coast-down trend is latched, the trend data is overwritten with new data
when the next trigger occurs.
The SU/CD trend parameters define the trend data that is collected by the
module during the start-up or coast-down of a machine. Use these parameters to
configure the measurements included in the start-up and coast-down trend
records, the interval between trend records, and the minimum and maximum
speed limits at which record collection starts and stops.
IMPORTANT
The SU/CD Trend parameters are not included in the EDS file and cannot be
edited using generic configuration tools such as RSNetWorx for DeviceNet
software.
Table 23 - SU/CD Trend Parameters
Parameter Name
Description
Values/Comments
Enable SU/CD Trend
Enables/disables the SU/CD trend measurements. Select to configure
the SU/CD trend measurements.
Check to enable.
Clear to disable.
Select Measurements
Sets the measurements to be collected and stored in the module.
Important: The Speed measurement is always included in the startup/coast-down trend.
1…16 measurements can be selected.
Number of Records
The maximum number of measurement sets that can be collected in
the trend buffer. The measurement sets make up the trend data.
The Number of Records is automatically calculated
based upon the number of Trended
Measurements selected.
Latch Enable
Determines whether the start-up/coast-down trend is latched or
unlatched.
Latched means that subsequent start-up/coast-down trends are
ignored after the initial start-up/coast-down. This prevents the trend
data from being overwritten with new data until the trigger is
manually reset (click Reset Trigger).
Unlatched means that the start-up/coast-down trend data is
overwritten with new data every time the machine speed crosses into
the speed range.
Check means latched
Clear means unlatched
Record Interval
The change in speed between consecutive records.
Important: If you enter a Record Interval, the Maximum Trend
Span is automatically updated.
1…3600 rpm
Maximum Trend Span
The maximum change in speed that can be covered by the trend data
(Number of Records x Record Interval).
Important: If you edit the Trend Span, the Record Interval is
automatically updated.
rpm
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
109
Chapter 4
Trends
Table 23 - SU/CD Trend Parameters
110
Parameter Name
Description
Values/Comments
Minimum Speed
The lesser limit of the speed range in which records are collected in
the start-up/coast-down trend. This value must be less than the
Maximum Speed value.
Maximum Speed
The greater limit of the speed range in which records are collected in
the start-up/coast-down trend. This value must be greater than the
Minimum Speed value.
rpm
Start-up/Coast-down Trend Considerations:
• The module collects a start-up trend when the
machine speed rises through the Minimum
Speed + 8 rpm, and stops when the machine
speed crosses either the Minimum Speed or
the Maximum Speed. The module collects
data only when the machine speed is
increasing. It does not collect data if the
machine speed is constant or decreasing.
• The module collects a coast-down trend when
the machine speed falls through the
Maximum Speed - 8 rpm, and stops when the
machine speed crosses either the Minimum
Speed or the Maximum Speed. The module
collects data when the machine speed is
decreasing or increasing during a coast-down
trend (for example, a coast-down restart).
Status
Shows the status of the trend data.
View Trend Data
Displays a plot of the collected trend data.
Reset Trigger
Resets the trigger if Latch enabled is selected. This enables the
module to overwrite the previous trend data when the machine speed
crosses into the speed range.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Possible status values:
• Not collected - No trend data is currently
collected.
• Collecting - A trigger has occurred and data is
being collected.
• Collected - A trend has been saved to the buffer
and is available to view and upload.
Appendix
A
Status Indicators
This chapter details the visible status indicators of the XM-124 standard dynamic
measurement module.
Topic
Page
Status Indicators
111
Module Status (MS) Indicators
112
Relay Indicator
112
Network Status (NS) Indicator
112
Channel 1 and Channel 2 Status Indicators
112
Tachometer Status Indicators
113
Setpoint Multiplier Indicator
113
The module has seven status indicators, which are on the top of the module.
Status Indicators
Status Indicators
Status Indicators
The status indicators include the following:
• Module Status (MS)
• Network Status (NS)
• Channel 1
• Channel 2
• Tachometer
• Setpoint Multiplier (SPM)
• Relay
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
111
Appendix A
Status Indicators
Module Status (MS)
Indicators
Relay Indicator
Network Status (NS)
Indicator
Channel 1 and Channel 2
Status Indicators
112
The following table describes the Module Status indicators.
State
Probable Cause
Off
No power applied to the module.
Alternating Red/Green
Module performing power-up self-test.
Flashing Red
• Application firmware is invalid or not loaded. Download firmware to the
module.
• Firmware download is currently in progress.
• The Node Address or Communication Rate DIP switches have been
changed and do not reflect the settings currently in use.
Solid Red
An unrecoverable fault has occurred. The module may need to be repaired or
replaced.
Flashing Green
Module operating in Program Mode, not performing its monitoring
functions.
Solid Green
Module operating in Run Mode, performing its monitoring functions.
The following table describes the relay indicator.
State
Probable Cause
Off
The relay is not activated.
Solid Red
The relay is activated.
The following table describes the network status indicator.
State
Probable Cause
Off
Module is not online.
• Module is autobauding.
• No power applied to the module; look at Module Status indicator.
Flashing Red
One or more I/O connections are in the timed-out state.
Solid Red
Failed communication (duplicate MAC ID or bus-off).
Flashing Green
Module is online but no connections are currently established.
Solid Green
Module is online with connections currently established.
The following table describes the channel indicators.
State
Probable Cause
Off
• Normal operation within alarm limits on the channel.
• No power applied to the module. Look at Module Status indicator.
Solid Yellow
An alarm associated with this channel is in Alert.
Solid Red
An alarm associated with this channel is in Danger.
Flashing Red
A transducer fault exists on the channel. The DC bias is outside the DC Low
and High Limits.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Status Indicators
Tachometer Status Indicators
Setpoint Multiplier Indicator
Appendix A
The following table describes the tachometer indicator.
State
Probable Cause
Off
• Normal operation within alarm limits on the channel.
• No power applied to the module. Look at Module Status indicator.
Solid Yellow
An alarm on Speed or Acceleration is in Alert.
Solid Red
An alarm on Speed or Acceleration is in Danger.
Flashing Yellow
A tachometer fault other than a transducer fault (for example, no pulse
received).
Flashing Red
The tachometer signal DC bias is not within the DC Low and High Limits.
The following table describes the setpoint multiplier indicator.
State
Probable Cause
Off
The Alarm Limit Multiplier is not in effect.
Solid Yellow
The Alarm Limit Multiplier is in effect.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
113
Appendix A
Status Indicators
Notes:
114
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Appendix
B
CIP Objects
This appendix defines the specific CIP Objects, Instances, Attributes, and
Services supported by the Standard Dynamic Measurement Module.
Identity Object
(Class Code 01H)
Topic
Page
Identity Object (Class Code 01H)
115
DeviceNet Object (Class Code 03H)
117
Assembly Object (Class Code 04H)
118
Connection Object (Class ID 05H)
123
Discrete Input Point Object (Class ID 08H)
124
Analog Input Point (Class ID 0AH)
126
Parameter Object (Class ID 0FH)
127
Acknowledge Handler Object (Class ID 2BH)
133
Alarm Object (Class ID 31DH)
134
Band Measurement Object (Class ID 31EH)
136
Channel Object (Class ID 31FH)
138
Device Mode Object (Class ID 320H)
140
Overall Measurement Object (Class ID 322H)
141
Relay Object (Class ID 323H)
142
Spectrum Waveform Measurement Object (Class ID 324H)
145
Speed Measurement Object (Class ID 325H)
151
Tachometer Channel Object (Class ID 326H)
152
Transducer Object (Class ID 328H)
154
Vector Measurement Object (Class ID 329H)
155
4…20 mA Output Object (Class ID 32AH)
157
The Identity Object provides identification and general information about the
device.
Class Attributes
The Identity Object provides no class attributes.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
115
Appendix B
CIP Objects
Instance Attributes
Table 24 - Identity Object Instance Attributes
Attr ID
Access
Name
Data Type
Default Value
1
Get
Vendor ID
UINT
1 = Allen-Bradley
2
Get
Device Type
UINT
109 (Specialty I/O)
3
Get
Product Code
UINT
73
4
Get
Revision:
Major
Minor
STRUCT OF USINT
USINT
5
Get
Status
WORD
6
Get
Serial Number
UDINT
7
Get
Product Name
SHORT_
STRING
Value varies with each firmware version.
Value varies with each firmware version.
XM-124 standard dynamic measurement module
Status
The Status is a 16 bit value. The following bits are implemented.
Table 25 - Identity Object Status
Bit
Name
Description
0
Owned
TRUE indicates that the module has an owner. More specifically, the Predefined Master/Slave Connection Set has
been allocated to a master.
1
2
Reserved, set to 0
Configured
3
4 …7
This bit is set whenever a saved configuration is successfully loaded from nonvolatile memory. This bit is cleared
whenever the default configuration is restored or loaded.
Reserved, set to 0
Extended Device Status
Self-testing or unknown
0
Firmware update in progress
1
At least one faulted I/O connection
2
No I/O connections established
3
At least one I/O connection in Run mode
6
At least one I/O connection, all in Run mode
7
8
Minor Recoverable Fault
Set whenever there is a transducer or tachometer fault.
9
Minor Unrecoverable Fault
Not implemented
116
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
CIP Objects
Appendix B
Table 25 - Identity Object Status
Bit
Name
Description
10
Major Recoverable Fault
Set when there is a major recoverable fault.
Cause
Description
Resolution
The boot program The main application is missing or corrupt .
is running.
Update or reinstall the module
firmware.
The Relay
Expansion
module has been
removed.
Reinstall the missing Relay
Expansion module or disable the
expansion module relays in the
XM-124 configuration.
If an XM-441 Expansion Relay module is present at
power-up and if any of Relay instances 2 through 5 are
enabled, then a Major Recoverable Fault will be
indicated if the Relay Expansion module is removed.
The 24 Volt power The power supply voltage is less than approximately
monitor
19.2V or is greater than approximately 28.8V.
measures out-ofrange.
Adjust or replace the power
supply to insure its output is 24V
±10%.
In all cases the XM-124 will attempt to continue making measurements, monitoring alarms and managing its
relays regardless of the Major Fault Indication or its cause.
11
Major Unrecoverable Fault
Set when there is a Module Status fault (Module Status indicator is solid red).
12…15
Reserved, set to 0
Services
Table 26 - Identity Object Services
Service Code
Class/Instance Usage
Name
01h
Instance
Get_Attributes_All
05h
Instance
Reset
0Eh
Instance
Get_Attribute_Single
10h
Instance
Set_Attribute_Single
The DeviceNet Object is used to provide the configuration and status of a
physical attachment to DeviceNet.
DeviceNet Object
(Class Code 03H)
Class Attributes
Table 27 - DeviceNet Object Class Attributes
Attr ID
Access
Name
Data Type
Default Value
1
Get
Revision
UINT
2
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
117
Appendix B
CIP Objects
Instance Attribute
Table 28 - DeviceNet Object Instance Attributes
Attr ID
Access
Name
Data Type
Default Value
1
Get
MAC ID
USINT
On DIP switches under label
2
Get
Communication Rate
USINT
The communication rate is determined by automatic
communication rate detection (autobaud). The module
listens to network traffic to determine the
communication rate before it goes online.
3
Get
Bus-Off Interrupt
BOOL
0
4
Get/Set
Bus-Off Counter
USINT
0
5
Get
Allocation Information
STRUCT of BYTE
USINT
0…255
6
Get
MAC ID switch changed
BOOL
0 = No change
1 = Change since last reset or powerup
7
Get
Communication rate switch
changed
BOOL
0 = No change
1 = Change since last reset or powerup
8
Get
MAC ID switch value
USINT
0…99
9
Get
Communication rate switch
value
USINT
0…9
100
Get
Autobaud Disable
BOOL
0 (always autobaud)
Services
Table 29 - DeviceNet Object Services
Service Code
Class/Instance Usage
Name
0Eh
Class/Instance
Get_Attribute_Single
10h
Instance
Set_Attribute_Single
4Bh
Instance
Allocate_Master/Slave_Connection_Set
4Ch
Instance
Release_Group_2_Identifier_Set
The Assembly Object binds attributes of multiple objects to allow data to or from
each object to be sent or received in a single message.
Assembly Object
(Class Code 04H)
The XM-124 module provides both static and dynamic assemblies.
Class Attribute
Table 30 - Assembly Object Class Attributes
Access Rule
Attr ID
1
118
Get
Name
Data Type
Description
Semantics
Revision
UINT
Version of the implemented
object.
2
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
CIP Objects
Appendix B
Instances
Table 31 - Assembly Object Instances
Instance
Name
Type
Description
100
Default COS Message
Input
Alarm and Relay Status values
101
Default Poll Response Message
Input
Measurement values
199
Alternate Dynamic Poll Response
Message
Input
User configurable measurement values
and configuration parameters
Instance Attributes
Table 32 - Assembly Object Instance Attributes
Access Rule
Attr ID
Name
Data Type
Value
1
Get
Number of Members in list
UINT
Only supported for Dynamic Assembly instance
2
Set
Member List
Array of STRUCT:
Only supported for Dynamic Assembly instance
Member Data Description
UINT
Size of member data value in bits
Member Path Size
UINT
Member Path
3
Get
Packed EPATH
Data
Defined in tables on
the following pages.
Assembly Instance Attribute Data Format
Instance 100 - Alarm and Relay Status
This assembly is sent using COS messaging when any of the Alarm or Relay
Status values change.
Table 33 - Instance 100 Data Format (alarm and relay status values assembly)
Byte
Bit 7
Bit 6
Bit 5
Bit 4
Bit 3
0
Relay 1 Status
Set Point
Multiplier
Alarm 2 Status
Alarm 1 Status
1
Relay 2 Status
Channel 1
Transducer
Status
Alarm 4 Status
Alarm 3 Status
2
Relay 3 Status
Channel 2
Transducer
Status
Alarm 6 Status
Alarm 5 Status
3
Relay 4 Status
Tachometer
Transducer
Status
Alarm 8 Status
Alarm 7 Status
4
Relay 5 Status
0
Alarm 10 Status
Alarm 9 Status
5
0
0
Alarm 12 Status
Alarm 11 Status
6
0
0
Alarm 14 Status
Alarm 13 Status
7
0
0
Alarm 16 Status
Alarm 15 Status
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Bit 2
Bit 1
Bit 0
119
Appendix B
CIP Objects
Instance 101 - Measurement Values
This assembly instance can be selected to be sent in response to an I/O Poll
Request from a Master. This instance is the default Poll response selection for
firmware version 3 or later, and it is the only available Poll response for firmware
versions 1 and 2.
Table 34 - Instance 101 Data Format (measurement values assembly)
120
Byte
Bit 7
Bit 6
0…3
Channel 1 Overall value
Bit 5
Bit 4
4…7
Channel 2 Overall value
8…11
Channel 1 Gap value (Analog Input Point (AIP) Object Instance #1)
12…15
Channel 2 Gap value (AIP Object Instance #2)
16…19
Speed value
20…23
Maximum Speed value
24…27
Channel 1 Band 1 value
28…31
Channel 2 Band 1 value
32…35
Channel 1 Band 2 value
36…39
Channel 2 Band 2 value
40…43
Channel 1 Band 3 value
44…47
Channel 2 Band 3 value
48…51
Channel 1 Band 4 value
52…55
Channel 2 Band 4 value
56…59
Channel 1 Vector 1 Magnitude value
60…63
Channel 1 Vector 1 Phase value
64…67
Channel 2 Vector 1 Magnitude value
68…71
Channel 2 Vector 1 Phase value
72…75
Channel 1 Vector 2 Magnitude value
76…79
Channel 1 Vector 2 Phase value
80…83
Channel 2 Vector 2 Magnitude value
84…87
Channel 2 Vector 2 Phase value
88…91
Channel 1 Vector 3 Magnitude value
92…95
Channel 2 Vector 3 Magnitude value
96…99
Channel 1 Not 1X value (AIP Object Instance #3)
100…103
Channel 2 Not 1X value (AIP Object Instance #4)
104…107
SMAX Magnitude value (AIP Object Instance #5)
108…111
SMAX Phase value (AIP Object Instance #6)
112…115
Channel 1 Sum Harmonics value (AIP Object Instance #7)
116…119
Channel 2 Sum Harmonics (AIP Object Instance #8)
120…123
Channel 1 Position measurement
124…127
Channel 2 Position measurement
128…131
Acceleration measurement value
132
Channel 1 Measurement Mode
Bit 3
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Bit 2
Bit 1
Bit 0
CIP Objects
Appendix B
Table 34 - Instance 101 Data Format (measurement values assembly)
Byte
Bit 7
Bit 6
Bit 5
133
empty
134
Channel 2 Measurement Mode
135
empty
136…139
Channel 1 gSE Overall measurement value
140…143
Channel 2 gSE Overall measurement value
144…147
Channel 1 Eccentricity measurement value
148…151
Channel 2 Eccentricity measurement value
152…155
Channel 1 Band Pass measurement value
156…159
Channel 2 Band Pass measurement value
160…163
Channel 1 Tracked Magnitude measurement value
164…167
Channel 1 Tracked Phase measurement value
168…171
Channel 2 Tracked Magnitude measurement value
172…175
Channel 2 Tracked Phase measurement value
Bit 4
Bit 3
Bit 2
Bit 1
Bit 0
Instance 199 - Dynamic Assembly
This Assembly instance can be created and configured with the XM Serial or
RSMACC Enterprise Online. Using the configuration software, you determine
the format of the data. This assembly instance can be selected to be sent in
response to an I/O Poll request from a Master.
The dynamic Assembly can include all of the measurement values included in
Assembly instance 101. In addition, the dynamic Assembly can include the
following configuration parameters.
Table 35 - Instance 199 Component Mapping
EPATH (where ii = instance
number)
Class
Name
Class
Number
Instance
Number
Attribute
Name
Attribute
Number
Data
Type
21 1D 03 24 ii 30 04
Alarm
31Dh
1…16
Alarm Enable
4
BOOL
21 1D 03 24 ii 30 05
Alarm
31Dh
1…16
Type
5
USINT
21 1D 03 24 ii 30 07
Alarm
31Dh
1…16
Condition
7
USINT
21 1D 03 24 ii 30 08
Alarm
31Dh
1…16
Alert Threshold (High)
8
REAL
21 1D 03 24 ii 30 09
Alarm
31Dh
1…16
Danger Threshold (High)
9
REAL
21 1D 03 24 ii 30 0A
Alarm
31Dh
1…16
Alert Threshold Low
10
REAL
21 1D 03 24 ii 30 0B
Alarm
31Dh
1…16
Danger Threshold Low
11
REAL
21 1D 03 24 ii 30 0C
Alarm
31Dh
1…16
Hysteresis
12
REAL
21 1D 03 24 ii 30 0D
Alarm
31Dh
1…16
Threshold (Set Point)
Multiplier
13
REAL
21 1D 03 24 ii 30 0E
Alarm
31Dh
1…16
Start-up Period
14
UINT
21 1D 03 24 ii 30 0F
Alarm
31Dh
1…16
Speed Range Enable
15
BOOL
21 1D 03 24 ii 30 10
Alarm
31Dh
1…16
Speed Range High
16
REAL
21 1D 03 24 ii 30 11
Alarm
31Dh
1…16
Speed Range Low
17
REAL
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
121
Appendix B
CIP Objects
Table 35 - Instance 199 Component Mapping
EPATH (where ii = instance
number)
Class
Name
Class
Number
Instance
Number
Attribute
Name
Attribute
Number
Data
Type
21 0F 00 24 ii 30 01
Param
0Fh
10…25
Parameter Value
(Measurement Identifier)
1
USINT
21 1D 03 24 ii 30 15
Alarm
31Dh
1…16
Detection Delay
21
UINT
21 23 03 24 ii 30 04
Relay
323h
1…5
Relay Enable
4
BOOL
21 23 03 24 ii 30 05
Relay
323h
1…5
Latch Enable
5
BOOL
21 23 03 24 ii 30 06
Relay
323h
1…5
Failsafe Enable
6
BOOL
21 23 03 24 ii 30 07
Relay
323h
1…5
Delay
7
UINT
21 23 03 24 ii 30 09
Relay
323h
1…5
Alarm Level
9
BYTE
21 0F 00 24 ii 30 01
Param
0Fh
26…30
Parameter Value (Alarm
Identifier A)
1
USINT
21 0F 00 24 ii 30 01
Param
0Fh
31…35
Parameter Value (Alarm
Identifier B)
1
USINT
21 23 03 24 ii 30 0C
Relay
323h
1…5
Logic
12
USINT
21 23 03 24 ii 30 0E
Relay
323h
1…5
Relay Installed
14
BOOL
The dynamic Assembly instance must be instantiated with a call to the class level
Create service. Then the structure can be defined with the Set_Attribute_Single
service for the Member List attribute. Only one dynamic Attribute instance is
supported so subsequent calls to the Create service returns a Resource
Unavailable (0x02) error. The Delete service can be used to destroy the dynamic
Assembly instance so that it can be re-created.
Services
Table 36 - Assembly Object Services
Service Code
122
Class/Instance Usage
Name
0Eh
Class/Instance
Get_Attribute_Single
10h
Instance
Set_Attribute_Single
08h
Class
Create
09h
Instance
Delete
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
CIP Objects
Appendix B
The Connection Object allocates and manages the internal resources associated
with both I/O and Explicit Messaging Connections.
Connection Object
(Class ID 05H)
Class Attributes
The Connection Object provides no class attributes.
Instances
Table 37 - Connection Object Instances
Instance
Description
1
Explicit Message Connection for pre-defined connection set
2
I/O Poll Connection
3
I/O Strobe Connection
4
I/O COS (change of state) Connection
11…17
Explicit Message Connection
Instance Attributes
Table 38 - Connection Object Instance Attributes
Access Rule
Attr ID
Name
Data Type
Description
1
Get
State
USINT
State of the object.
2
Get
Instance Type
USINT
Indicates either I/O or Messaging Connection.
3
Get
Transport Class Trigger
BYTE
Defines behavior of the Connection.
4
Get
Produced Connection ID
UINT
Placed in CAN Identifier Field when the Connection
transmits.
5
Get
Consumed Connection ID
UINT
CAN Identifier Field value that denotes message to be
received.
6
Get
Initial Comm Characteristics
BYTE
Defines the Message Group across which productions and
consumptions associated with this Connection occur.
7
Get
Produced Connection Size
UINT
Maximum number of bytes transmitted across this
Connection.
8
Get
Consumed Connection Size
UINT
Maximum number of bytes received across this
Connection.
9
Get/Set
Expected Packet Rate
UINT
Defines timing associated with this Connection.
12
Get/Set
Watchdog Time-out Action
USINT
Defines how to handle Inactivity/Watchdog timeouts.
13
Get
Produced Connection Path
Length
UINT
Number of bytes in the production_connection_path
attribute.
14
Get
Produced Connection Path
Array of USINT
Specifies the Application Object whose data is to be
produced by this Connection Object. See DeviceNet
Specification Volume 1 Appendix I.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
123
Appendix B
CIP Objects
Table 38 - Connection Object Instance Attributes
Access Rule
Attr ID
Name
Data Type
Description
15
Get
Consumed Connection Path
Length
UINT
Number of bytes in the consumed_connection_path
attribute.
16
Get
Consumed Connection Path
Array of USINT
Specifies the Application Object that are to receive the
data consumed by this Connection Object. See DeviceNet
Specification Volume 1 Appendix I.
17
Get
Production Inhibit Time
UINT
Defines minimum time between new data production.
Services
Table 39 - Connection Object Services
Service Code
Class/Instance Usage
Name
05h
Instance
Reset
0Eh
Instance
Get_Attribute_Single
10h
Instance
Set_Attribute_Single
The Discrete Input Point Object stores information about the value of the
Setpoint Multiplier signal.
Discrete Input Point
Object (Class ID 08H)
Class Attributes
Table 40 - Discrete Input Object Class Attributes
Access Rule
Attr ID
1
124
Get
Name
Data Type
Description
Semantics
Revision
UINT
Version of the implemented
object.
2
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
CIP Objects
Appendix B
Instance Attributes
Table 41 - Discrete Input Object Instance Attributes
Access Rule
Attr ID
Name
Data Type
Description
Semantics
0 = Off
1 = On
3
Get
Value
BOOL
Alarm Limit Multiplier
199
Set
Backdoor Service
USINT
Setting this attribute is equivalent Set to one of the following
to requesting the specified service. values to perform the
specified service:
32h = Open
33h = Close
The virtual Setpoint
Multiplier switch can be
set with the
AlarmLimitMultiply output
tag in RSLogix 5000
software.
Services
Table 42 - Discrete Input Object Services
Service Code
Class/Instance Usage
Name
Description
0Eh
Class/Instance
Get_Attribute_Single
Returns the contents of the specified
attribute.
10h
Instance
Set_Attribute_Single
Sets the contents of the specified
attribute.
32h
Instance
Open
Opens the virtual Setpoint Multiplier
switch(1).
33h
Instance
Close
Closes the virtual Setpoint Multiplier
switch(1).
(1)
The AlarmLimitMultiply output tag in RSLogix 5000 software can also set the Setpoint Multiplier switch. It does not overwrite this
service.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
125
Appendix B
CIP Objects
The Analog Input Point Object models simple analog measurements performed
by the Standard Dynamic Measurement Module.
Analog Input Point
(Class ID 0AH)
Class Attributes
Table 43 - Analog Input Point Object Class Attributes
Access Rule
Attr ID
1
Get
Name
Data Type
Description
Semantics
Revision
UINT
Version of the implemented
object.
2
Instances
Table 44 - Analog Input Point Object Instances
Instance
Description
1
Gap measurement for Channel 1
2
Gap measurement for Channel 2
3
Not 1X measurement for Channel 1
4
Not 1X measurement for Channel 2
5
SMAX magnitude of synchronized channels
6
SMAX phase of synchronized channels
7
Sum Harmonics measurement for Channel 1
8
Sum Harmonics measurement for Channel 2
9
Thrust Position Measurement for Channel 1
10
Thrust Position Measurement for Channel 2
11
gSE Overall measurement for Channel 1
12
gSE Overall measurement for Channel 2
13
Eccentricity measurement for Channel 1
14
Eccentricity measurement for Channel 2
Instance Attributes
Table 45 - Analog Input Point Object Class Attributes
Access Rule
Attr ID
126
Name
Data Type
3
Get
Value
REAL
4
Get
Status
BOOL
Description
Semantics
Indicates if a fault or alarm has
occurred.
0 = Operating without alarms or faults
1 = Alarm or fault condition exists. The
Value attribute may not represent the
actual field value.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
CIP Objects
Appendix B
Table 45 - Analog Input Point Object Class Attributes
Access Rule
Attr ID
Name
Data Type
Description
Semantics
8
Get
Value Data Type
USINT
Determines the data type of the
Value.
1 = REAL
122
Get/Set
Calibration Bias
REAL
Offset added into the raw
measurement value.
Used to set the ‘zero point’ for the Thrust
Position measurements.
147
Get
Data Units
ENGUNIT
The units context of the Value
attribute.
See DeviceNet Specification Volume 1
Appendix K.
Services
Table 46 - Analog Input Point Object Services
Service Code
0Eh
Parameter Object
(Class ID 0FH)
Class/Instance Usage
Name
Description
Class/Instance
Get_Attribute_Single
Returns the contents of the specified
attribute.
The Parameter Object provides the interface to the Standard Dynamic
Measurement Module configuration data. There are 51 Parameter Object
instances implemented in the module.
Parameter Object instances 1…4 and 7…37 are implemented to provide an
alternate method of setting the configuration parameters with EPATH or
ENGUNIT data types. Parameter Object instances 38 and 39 provide an
alternate method of setting the Produced Connection Size and Produced
Connection Path attributes for the Poll Connection because these attributes can
be difficult to get/set directly through the Connection Object. Note that these
cannot be set if there is an active Poll Connection.
Parameter Object instances 5 and 6 are for setting the starting order for the Sum
Harmonics measurements. Instances 40 and 41 are for setting the Measurement
Mode for each Channel. Instances 42… 49 are for setting the Spectrum Option
for Band object instances 1… 8. Instances 50 and 51 are for setting the Update
Rate for the Eccentricity measurements.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
127
Appendix B
CIP Objects
Class Attributes
Table 47 - Parameter Object Class Attributes
Access Rule
Attr ID
Name
Data Type
Description
Semantics
2
Get
Max Instance
UINT
Maximum instance number of an
object in this class.
Total number of parameter object
instances.
8
Get
Parameter Class
Descriptor
WORD
Bits that describe the parameter.
Bit 0 Supports Parameter Instances
Bit 1 Supports Full Attrib.
Bit 2 Must do nonvolatile store
Bit 3 Params in nonvolatile
9
Get
Config. Assembly
Instance
UINT
Set to 0
Instances
There are 51 instances of this object
Table 48 - Parameter Object Instances
128
Instance
Read
Only
Name
Data Type
Valid Values
Default Value
1
No
Transducer 1 Sensitivity Units
USINT
0 = mil
1 = in/s
2=g
3 = psi
4 = volts
5 = mm/s
6 = μm
7 = Pa
8 = mbar
0
2
No
Transducer 2 Sensitivity Units
USINT
(same as above)
0
3
No
Channel 1 Measurement Units
USINT
0 = mil
1 = in/s
2=g
3 = psi
4 = volts
5 = mm/s
6 = μm
7 = Pa
8 = mbar
0
4
No
Channel 2 Measurement Units
USINT
(same as above)
0
5
No
Starting Order for Channel 1Sum
Harmonics meas.
USINT
0=1
1=2
2=3
3=4
4=5
3
6
No
Starting Order for Channel 2 Sum
Harmonics measurement.
USINT
1…5
2
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
CIP Objects
Appendix B
Table 48 - Parameter Object Instances
Instance
Read
Only
Name
Data Type
Valid Values
Default Value
7
No
4-20 mA Output 1 Measurement
Identifier
USINT
0 = CH 1 Overall
1 = CH 2 Overall
2 = CH 1 Gap
3 = CH 2 Gap
4 = CH 1 Band 1
5 = CH 2 Band 1
6 = CH 1 Band 2
7 = CH 2 Band 2
8 = CH 1 Band 3
9 = CH 2 Band 3
10 = CH 1 Band 4
11 = CH 2 Band 4
12 = Speed
13 = SMAX Mag.
14 = CH 1 1X Mag.
15 = CH 2 1X Mag.
16 = CH 1 2X Mag.
17 = CH 2 2X Mag.
18 = CH 1 3X Mag.
19 = CH 2 3X Mag.
20 = CH 1 Not 1X
21 = CH 2 Not 1X
22 = CH 1 Sum Harmonics
23 = CH 2 Sum Harmonics
29 = Acceleration
30 = CH1 Thrust Position
31 = CH2 Thrust Position
32 = CH1 gSE Overall
33 = CH2 gSE Overall
34 = CH1 Eccentricity
35 = CH2 Eccentricity
36 = CH1 gSE Band Pass
37 = CH2 gSE Band Pass
38 = CH1 gSE Tracking Mag.
39 = CH2 gSE Tracking Mag.
0
8
No
4-20 mA Output 2 Measurement
Identifier
USINT
(same as above)
1
9
No
Transducer 3 (Tachometer) Sensitivity
Units
USINT
0 = mil
1 = in/s
2=g
3 = psi
4 = volts
5 = mm/s
6 = μm
7 = Pa
8 = mbar
0
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
129
Appendix B
CIP Objects
Table 48 - Parameter Object Instances
Instance
Read
Only
Name
Data Type
Valid Values
Default Value
10
No
Alarm 1 Measurement ID
USINT
0 = CH 1 Overall
1 = CH 2 Overall
2 = CH 1 Gap
3 = CH 2 Gap
4 = CH 1 Band 1
5 = CH 2 Band 1
6 = CH 1 Band 2
7 = CH 2 Band 2
8 = CH 1 Band 3
9 = CH 2 Band 3
10 = CH 1 Band 4
11 = CH 2 Band 4
12 = Speed
13 = SMAX Mag.
14 = CH 1 1X Mag.
15 = CH 2 1X Mag.
16 = CH 1 2X Mag.
17 = CH 2 2X Mag.
18 = CH 1 3X Mag.
19 = CH 2 3X Mag.
20 = CH 1 Not 1X
21 = CH 2 Not 1X
22 = CH 1 Sum Harmonics
23 = CH 2 Sum Harmonics
24 = CH 1 1X Phase
25 = CH 2 1X Phase
26 = CH 1 2X Phase
27 = CH 2 2X Phase
28 = SMAX Phase
29 = Acceleration
30 = CH 1 Thrust Position
31 = CH 2 Thrust Position
32 = CH 1 gSE Overall
33 = CH 2 gSE Overall
34 = CH 1 Eccentricity
35 = CH 2 Eccentricity
36 = CH 1 Band Pass
37 = CH 2 Band Pass
38 = CH 1 Tracking Mag.
39 = CH 2 Tracking Mag.
40 = CH 1 Tracking Phase
41 = CH 2 Tracking Phase
0
11
No
Alarm 2 Measurement ID
USINT
(same as above)
1
12
No
Alarm 3 Measurement ID
USINT
(same as above)
0
13
No
Alarm 4 Measurement ID
USINT
(same as above)
1
14
No
Alarm 5 Measurement ID
USINT
(same as above)
0
15
No
Alarm 6 Measurement ID
16
17
18
19
130
USINT
(same as above)
1
No
Alarm 7 Measurement ID
(1)
USINT
(same as above)
0
No
Alarm 8 Measurement ID(1)
USINT
(same as above)
1
No
Alarm 9Measurement ID(1)
USINT
(same as above)
0
USINT
(same as above)
1
No
(1)
Alarm 10Measurement ID
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
CIP Objects
Appendix B
Table 48 - Parameter Object Instances
Instance
Read
Only
Name
Data Type
Valid Values
Default Value
20
No
Alarm 11 Measurement ID(1)
USINT
(same as above)
0
21
No
Alarm 12 Measurement ID(1)
USINT
(same as above)
1
22
No
Alarm 13 Measurement ID(1)
USINT
(same as above)
0
23
No
(1)
Alarm 14 Measurement ID
USINT
(same as above)
1
24
No
Alarm 15 Measurement ID(1)
USINT
(same as above)
0
25
No
Alarm 16 Measurement ID(1)
USINT
(same as above)
1
26
No
Relay 1 Alarm Identifier A
USINT
0 = Alarm 1
1 = Alarm 2
2 = Alarm 3
3 = Alarm 4
4 = Alarm 5
5 = Alarm 6
6 = Alarm 7
7 = Alarm 8
8 = Alarm 9
9 = Alarm 10
10 = Alarm 11
11 = Alarm 12
12 = Alarm 13
13 = Alarm 14
14 = Alarm 15
15 = Alarm 15
0
27
No
Relay 2 Alarm Identifier A
USINT
(same as above)
0
28
No
Relay 3 Alarm Identifier A
USINT
(same as above)
0
29
No
Relay 4 Alarm Identifier A
USINT
(same as above)
0
30
No
Relay 5 Alarm Identifier A
USINT
(same as above)
0
31
No
Relay 1 Alarm Identifier B
USINT
0 = Alarm 1
1 = Alarm 2
2 = Alarm 3
3 = Alarm 4
4 = Alarm 5
5 = Alarm 6
6 = Alarm 7
7 = Alarm 8
8 = Alarm 9
9 = Alarm 10
10 = Alarm 11
11 = Alarm 12
12 = Alarm 13
13 = Alarm 14
14 = Alarm 15
15 = Alarm 16
0
32
No
Relay 2 Alarm Identifier B
USINT
(same as above)
0
33
No
Relay 3 Alarm Identifier B
USINT
(same as above)
0
34
No
Relay 4 Alarm Identifier B
USINT
(same as above)
0
35
No
Relay 5 Alarm Identifier B
USINT
(same as above)
0
36
Yes
Channel 1 Vector Measurement Speed
Data Units
USINT
0 = CPM
1 = Orders
0
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
131
Appendix B
CIP Objects
Table 48 - Parameter Object Instances
Instance
Read
Only
Name
Data Type
Valid Values
Default Value
37
Yes
Channel 2 Vector Measurement Speed
Data Units
USINT
0 = CPM
1 = Orders
0
38
No
Poll Connection Produced Connection
Path(2)
USINT
101, 199 (Assembly Object Instance
number)
101
39
No
Poll Connection Produced Connection
Size(2)
UINT
4…132
20
40
No
Channel 1 Measurement Mode
USINT
0 = Standard
1 = Thrust Position
2 = Alternating gSE
3 = Continuous gSE
4 = Eccentricity
5 = Band-Pass
6 = Tracking
0
41
No
Channel 2 Measurement Mode
USINT
(same as above)
0
42
No
Band 1 Spectrum Option
USINT
0 = Standard Spectrum
1 = gSE Spectrum
0
43
No
Band 2 Spectrum Option
USINT
(same as above)
0
44
No
Band 3 Spectrum Option
USINT
(same as above)
0
45
No
Band 4 Spectrum Option
USINT
(same as above)
0
46
No
Band 5 Spectrum Option
USINT
(same as above)
0
47
No
Band 6 Spectrum Option
USINT
(same as above)
0
48
No
Band 7 Spectrum Option
USINT
(same as above)
0
49
No
Band 8 Spectrum Option
USINT
(same as above)
0
50
No
Eccentricity 1 Update Rate
USINT
1 – 255 seconds
60
51
No
Eccentricity 2 Update Rate
USINT
1 – 255 seconds
60
(1)
Alarms 6-15 are not available when the module is configured in the RSLogix 5000 software.
(2)
The Poll Connection Produced Connection Path and Size parameters cannot be set while the Poll connection is already established
with a master/scanner. Attempting to do so results in an Object State Conflict error (error code 0xC) These Parameter instances are a
little more flexible than the actual Connection Object attributes because they can be set while the connection is in the nonexistent state (before the master/scanner allocates the connection).
Instance Attributes
Table 49 - Parameter Object Instance Attributes
Access Rule
Attr ID
132
Name
1
Set
Parameter Value
2
Get
Link Path Size
Data Type
USINT
Description
Semantics
Actual value of parameter
See Table 48 for a list of valid values for
each instance.
Size of Link Path
0 (These Parameter instances do not link
directly to another object attribute.)
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
CIP Objects
Appendix B
Table 49 - Parameter Object Instance Attributes
Access Rule
Attr ID
3
Get
Name
Data Type
Description
Link Path
ARRAY of
DeviceNet path
DeviceNet path to the object for
the Parameter value.
Segment Type/Port
BYTE
See DeviceNet Specification
Volume 1 Appendix I for format.
Segment Address
Semantics
See DeviceNet Specification
Volume 1 Appendix I for format.
4
Get
Descriptor
WORD
Description of Parameter
Bit 0 = Settable Path support
Bit 1 = Enum Strings support
Bit 2 = Scaling support
Bit 3 = Scaling Links support
Bit 4 = Read Only
Bit 5 = Monitor
Bit 6 = Ext. Prec. scaling
5
Get
Data Type
EPATH
Data Type Code
See DeviceNet Specification Volume 1
Appendix J, Section J-6.
6
Get
Data Size
USINT
Number of Bytes in Parameter
value.
Services
Table 50 - Parameter Object Services
Service Code
Class/Instance Usage
Name
Description
0Eh
Class/Instance
Get_Attribute_Single
Returns the contents of the specified
attribute.
10h
Class
Set_Attribute_Single
Sets the contents of the specified
attribute.(1)
(1)
Acknowledge Handler
Object (Class ID 2BH)
Attributes can only be set while the device is in Program mode. See the description of the Device Mode Object for more information.
The Acknowledge Handler Object is used to manage the reception of message
acknowledgments. This object communicates with a message producing
Application Object within a device. The Acknowledge Handler Object notifies
the producing application of acknowledge reception, acknowledge timeouts, and
production retry limit errors.
Class Attributes
The Acknowledge Handler Object provides no class attributes.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
133
Appendix B
CIP Objects
Instances
A module provides only a single instance (instance 1) of the Acknowledge
Handler Object. This instance is associated with instance 4 of the Connection
Object, the slave COS connection to a higher level master.
Instance Attributes
Table 51 - Acknowledge Handler Object Instance Attributes
Access Rule
Attr ID
Name
Data Type
Default Value
1
Get/Set
Acknowledge Timer
UINT
16 ms
2
Get/Set
Retry Limit
USINT
1
3
Get
COS Producing Connection
Instance
UINT
4
Services
Table 52 - Acknowledge Handler Object Services
Service Code
Alarm Object (Class ID 31DH)
Class/Instance Usage
Name
0Eh
Instance
Get_Attribute_Single
10h
Instance
Set_Attribute_Single
The Alarm Object mode is a two-stage (alert and danger levels) alarm.
Class Attributes
Table 53 - Alarm Object Class Attributes
Access Rule
Attr ID
1
Get
Name
Data Type
Description
Semantics
Revision
USINT
Version of the implemented
object.
2 (indicates that Threshold Multiplier is
a REAL instead of USINT)
Instances
There are 16 instances of this object.
134
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
CIP Objects
Appendix B
Instance Attributes
Table 54 - Alarm Object Instance Attributes
Access Rule
Attr ID
Name
Data Type
Description
Semantics
3
Get
Alarm Status
3 BITS
The current status of the alarm.
0 = Normal
1 = Alert (alarm)
2 = Danger (shutdown)
3 = Disarm
4 = Xdcr Fault
5 = Module Fault
6 = Tachometer Fault
4
Get/Set
Alarm Enable
BOOL
Indicates whether this alarm
object is enabled.
0 = Disabled
1 = Enabled
5
Get
Type
USINT
Type of Alarm
0 = Magnitude
1 = Vector
6
Get
Threshold Units
USINT
Indicates whether the thresholds
and deadband value are specified
in units of measure. Not applicable
to vector alarms.
Set to 1
1 = Measurement units
7
Get/Set
AlarmCondition
USINT
Indicates on which side of the
threshold values the alarm and
danger conditions exist. Not
applicable to vector alarms.
0 = Greater than
1 = Less than
2 = Inside range
3 = Outside range
8
Get/Set
AlarmHAlertLimit
REAL
The threshold value for the alert
state of the alarm. (For range
conditions, this is the greater
threshold value.)
9
Get/Set
AlarmHDangerLimit
REAL
The threshold value for the Danger
state of the alarm. (For range
conditions, this is the greater
threshold value).
10
Get/Set
AlarmLAlertLimit
REAL
The lesser threshold value for the
Alert state of the alarm with a
range condition type.
11
Get/Set
AlarmLDangerLimit
REAL
The lesser threshold value for the
Danger state of the alarm with a
range condition type.
12
Get/Set
AlarmDeadband
REAL
The amount on the safe side of a
threshold by which the value must
recover to clear the alarm.
13
Get/Set
AlarmLimitMultiply (Setpoint
Multiplier)
REAL
Indicates how the threshold must
be adjusted when the setpoint
multiplication function is invoked.
0 = Disable alarm
> 0 = Multiply the thresholds by the value
14
Get/Set
AlarmLimitMultiplyPeriod
UINT
The amount of time that the
Threshold (Setpoint) Multiplier is
applied after the start-up signal is
received.
Seconds
15
Get/Set
AlarmSpeedRangeEn
BOOL
Indicates whether this alarm is
enabled only within a certain
machine speed range.
0 = No speed range (alarm is always
enabled)
1 = Speed range (alarm only enabled
within speed range)
16
Get/Set
AlarmSpeedHLimit
REAL
Indicates the greater threshold of
the machine speed range for
which the alarm is enabled
(disabled at greater speeds).
CPM
(must be greater than
AlarmSpeedLLimit)
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
135
Appendix B
CIP Objects
Table 54 - Alarm Object Instance Attributes
Access Rule
Attr ID
Name
Data Type
Description
Semantics
17
Get/Set
AlarmSpeedLLimit
REAL
Indicates the lesser threshold of
the machine speed range for
which the alarm is enabled
(disabled at lesser speeds).
CPM
(Must be less than AlarmSpeedHLimit)
18
Get/Set
Name
STRING2
A name to help identify this alarm.
19
Get/Set
Measurement Identifier
EPATH
Identifies the measurement object
to which this alarm is applied.
See Parameter Object instances 10…25.
See Table 48 on page 128.
21
Get/Set
Detection Delay
UINT
The period that the measurement
must violate the threshold before
the Alert or Danger status is
indicated.
0…65,530 ms
Services
Table 55 - Alarm Object Services
Service Code
Class/Instance Usage
Name
Description
0Eh
Instance
Get_Attribute_Single
Returns a single attribute.
10h
Instance
Set_Attribute_Single
Sets a single attribute.(1)
(1)
Band Measurement
Object (Class ID 31EH)
Attributes can only be set while the device is in Program mode. See the description of the Device Mode Object for more information.
The Band Measurement Object models the measurement of the amplitude of a
signal within a narrow frequency range.
Class Attributes
The Band Measurement Object provides no class attributes.
Instances
There are 10 instances of this object. Instances 1 through 8 are the Band
measurements that are derived from the spectrum data. Instances 9 and 10 are the
Band Pass measurements that are performed in Band Pass Filter measurement
mode.
Table 56 - Band Measurement Object Instances
136
Instance
Description
1
Channel 1 Band Measurement #1
2
Channel 2 Band Measurement #1
3
Channel 1 Band Measurement #2
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
CIP Objects
Appendix B
Table 56 - Band Measurement Object Instances
Instance
Description
4
Channel 2 Band Measurement #2
5
Channel 1 Band Measurement #3
6
Channel 2 Band Measurement #3
7
Channel 1 Band Measurement #4
8
Channel 2 Band Measurement #4
9
Channel 1 Band Pass Measurement
10
Channel 2 Band Pass Measurement
Instance Attributes
Table 57 - Band Measurement Object Instance Attributes
Attr ID
Access Rule
Name
Data Type
Description
Semantics
3
Get
Band Value
REAL
The measured band value.
See Data Units
4
Get
Status
BOOL
Indicates if a fault or alarm has
occurred.
0 = Operating without alarms or faults
1 = Alarm or fault condition exists, the
Band Value attribute may not represent
the actual field value.
5
Get
Data Units
ENGUNIT
The units context of the Band
Value attribute.
This attribute is read only. It is set
according to the Output Data Units
attribute of the associated Channel Object
instance. See page 138.
6
Get/Set
Measurement
USINT
The measurement (or calculation)
performed to produce the Band
Value.
0 = RSS
1 = Peak
7
Get/Set
Minimum Frequency
REAL
The minimum frequency that is
included in the band
measurement.
8
Get/Set
Maximum Frequency REAL
The maximum frequency that is
included in the band
measurement.
The Maximum Frequency must be greater
than or equal to Minimum Frequency.
9
Get/Set
Frequency Units
The units of Minimum and
Maximum Frequency.
0 = Hz
1 = Orders
USINT
Services
Table 58 - Band Measurement Object Services
Service Code
Class/Instance Usage
Name
Description
0Eh
Instance
Get_Attribute_Single
Returns a single attribute.
10h
Instance
Set_Attribute_Single
Sets a single attribute.(1)
(1)
Attributes can only be set while the device is in Program mode. See the description of the Device Mode Object for more information.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
137
Appendix B
CIP Objects
The Channel Object models front-end processing performed on an input signal
before specific measurements are performed. This processing typically includes
gain, filtering, and/or integration.
Channel Object
(Class ID 31FH)
Channel Attributes
The Channel Object provides no class attributes.
Instances
There are four instances of this object. Instances 1 and 2 correspond to standard
channels 1 and 2, respectively. Instances 3 and 4 correspond to gSE channels 1
and 2, respectively.
Instance Attributes
Table 59 - Channel Object Instance Attributes
Access Rule
Attr ID
3
Get/Set
Name
Data Type
Description
Semantics
Output Data Units
ENGUNIT
The data units of the signal
resulting from the signal
processing performed in the
channel.
See DeviceNet Specification Volume 1
Appendix K. Also see Parameter Object
Instances 3 and 4.
Valid values:
g = 1504h
in/sec = 2B07h
mil = 0800h
psi = 1300h
volt = 2D00h
mm/s = 0900h
μm = 2204h
Pa = 1309h
mbar = 1308h
This setting is directly related to the
Sensitivity Units of the associated
transducer and the Level of Integration
performed on the channel.
4
Get
Integration Level of
Integration
USINT
The level of integration to perform
on the signal.
0 = None
1 = Single
5
Get/Set
Low Cutoff Frequency
USINT
The effective high pass filter (low
frequency corner) selection.
0 = Very low (0.2 Hz)
1 = Low (1 Hz)
2 = Medium (5 Hz)
3 = High (10 Hz)
4 = Very high (40 Hz)
See attributes 100…104.
6
138
Get/Set
Synchronous
BOOL
Indicates whether this channel is
synchronized with the tachometer
signal.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
0 = Asynchronous
1 = Synchronous
CIP Objects
Appendix B
Table 59 - Channel Object Instance Attributes
Access Rule
Attr ID
Name
Data Type
Description
Semantics
7
Get/Set
Internal Gear Teeth
UINT
The number of gear teeth on the
shaft of interest.
8
Get/Set
External Gear Teeth
UINT
The number of gear teeth on the
shaft used as the tachometer
source.
The Internal/External Gear Teeth
values are used when synchronous
operation is selected but there is a known
speed difference between the shaft of
interest and the shaft used as the
tachometer source.
9
Get/Set
Name
STRING2
A name to help identify this
channel.
10
Get/Set
Full Scale
REAL
The maximum signal expected to
be processed by the channel.
It is set according to the
Output Data Units attribute on page 138.
Setting the Full Scale to a greater value
enables the channel to handle greater
input signals without saturating or
clipping. Setting the Full Scale to a lesser
value enables the signal to be measured
with greater resolution.
100
Get
Very Low HPF Corner
Frequency
REAL
The frequency, in Hz, of the ‘Very
low’ Low Cutoff Frequency
option for attribute 5.
Hz
101
Get
Low HPF Corner
Frequency
REAL
The frequency, in Hz, of the "Low"
Low Cutoff Frequency option
for attribute 5.
Hz
102
Get
Medium HPF Corner
Frequency
REAL
The frequency, in Hz, of the
"Medium" Low Cutoff
Frequency (low frequency
corner) option for attribute 5.
Hz
103
Get
High HPF Corner
Frequency
REAL
The frequency, in Hz, of the "High"
Low Cutoff Frequency option
for attribute 5.
Hz
104
Get
Very High HPF Corner
Frequency
REAL
The frequency, in Hz, of the "Very
high" Low Cutoff Frequency
option for attribute 5.
Hz
105
Get
Channel Alarm Status
USINT
Summary of the Alarms
configured for this channel.
0 = Normal
1 = Alert (alarm)
2 = Danger (shutdown)
3 = Disarm
Services
Table 60 - Channel Object Services
Service Code
Class/Instance Usage
Name
Description
0Eh
Instance
Get_Attribute_Single
Returns a single attribute.
10h
Instance
Set_Attribute_Single
Sets a single attribute.(1)
(1)
Attributes can only be set while the device is in Program mode. See the description of the Device Mode Object for more information.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
139
Appendix B
CIP Objects
The Device Mode object is used to control access to the configuration parameters
in the module. This object’s Device Mode attribute must be in Program mode to
allow the module’s configuration parameters to be Set (see Services). Attempts to
set the configuration parameters while the Device Mode is in Run mode returns
an error. Note that the module collects measurements while in Run mode but not
while it is in Program mode.
Device Mode Object
(Class ID 320H)
Class Attributes
The Device Mode object provides no class attributes.
Instance Attributes
Table 61 - Device Mode Object Instance Attributes
Access Rule
Attr ID
Name
Data Type
Description
Semantics
0 = Power Up
1 = RUN
2 = PROGRAM
3
Get/Set
Device Mode
UINT
The operating mode of the
module.
199
Set
Backdoor Service
USINT
Setting this attribute is equivalent Set to one of the following values to
to requesting the specified service. perform the specified service:
05h = Reset
09h = Delete
15h = Restore
16h = Save
Setting the Device Mode attribute to 1 (RUN) is equivalent to executing the
Start service. Setting the Device Mode attribute to 2 (PROGRAM) is
equivalent to executing the Stop service.
Services
Table 62 - Device Mode Object Services
Service Code
140
Class/Instance Usage
Name
Description
0Eh
Instance
Get_Attribute_Single
Return the value of a single attribute.
10h
Instance
Set_Attribute_Single
Set the value of a single attribute.
07h
Instance
Stop
Transitions from Run to the Program
state.
06h
Instance
Start
Validate the device configuration
settings and transition to the Run
state if OK.
05h
Instance
Reset
Transition to the Power Up state. Load
the nonvolatile configuration and
transition to the Run state if saved
configuration restored.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
CIP Objects
Appendix B
Table 62 - Device Mode Object Services
Service Code
Class/Instance Usage
Name
Description
16h
Instance
Save
Validate the device configuration
settings if necessary and save them
to nonvolatile memory.
09h
Instance
Delete
Delete the saved configuration from
nonvolatile memory.
15h
Instance
Restore
Load the saved configuration or the
factory default configuration from
nonvolatile memory.
Overall Measurement
Object (Class ID 322H)
The Overall Measurement Object models the measurement of the amplitude of a
signal including a wide frequency range.
Class Attributes
The Overall Measurement Object provides no class attributes.
Instances
There are two instances of this object.
Instance Attributes
Table 63 - Overall Measurement Object Instance Attributes
Attr ID
Access Rule
Name
Data Type
Description
Semantics
3
Get
Overall Value
REAL
Measured value
The output value of the measurement
performed by the Overall Measurement
Object on the input signal. The result of the
measurement process specified by
Measurement is converted to the units
specified by Data Units to produce the
Overall Value.
4
Get
Status
BOOL
Indicates if a fault or alarm has
occurred.
0 = Operating without alarms or faults.
1 = Alarm or fault condition exists. The
Overall Value attribute may not
represent the actual field value.
5
Get
Data Units
ENGUNIT
The units context of the Overall
Value attribute.
This setting is determined by the Channel
Object’s Output Data Units attribute (see
page 138).
6
Get/Set
Measurement
USINT
The measurement (or calculation)
performed to produce the Overall
Value.
0 = RMS
1 = RMS peak
2 = RMS pk-to-pk
3 = Peak
4 = Peak-to-peak
5…255 Reserved
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
141
Appendix B
CIP Objects
Table 63 - Overall Measurement Object Instance Attributes
Attr ID
Access Rule
Name
Data Type
Description
Semantics
7
Get
Time Constant
REAL
The detection time constant
associated with the output
smoothing filter (for the RMS and
DC meters) or the decay rate of the
peak meters.
This setting is based on the Low
Frequency Cutoff (Channel object) and
Measurement (attribute 6).
If Measurement is set to 3 or 4, the
Overall Time Constant is 1.5 seconds.
If Measurement is set to 0, 1, or 2, the
table below shows the Time Constant.
Low
Frequency
Cutoff
Overall
Time
Constant
0.2 Hz
0.8
1 Hz
0.16
5 Hz
0.045
10 Hz
0.045
40 Hz
0.045
8
Get
Damping Factor
REAL
The damping factor associated
with output smoothing filter for
the RMS and DC meters (not used
with peak meters).
1.0
9
Get/Set
Overall Filter
USINT
Overall filter type applied to the
input signal before the
measurement is performed.
0 = None
1 = Low Pass Filter
2…255 Reserved
10
Get/Set
Low Pass Corner
Frequency
UINT
The corner frequency of the low
pass filter.
100…20,000 Hz
Services
Table 64 - Overall Measurement Object Services
Service Code
Class/Instance Usage
Name
Description
0Eh
Instance
Get_Attribute_Single
Returns a single attribute.
10h
Instance
Set_Attribute_Single
Sets a single attribute.(1)
(1)
Relay Object (Class ID 323H)
142
Attributes can only be set while the device is in Program mode. See the description of the Device Mode Object for more information.
The Relay Object models a relay (actual or virtual). A relay can be activated or
deactivated based on the status of one or more alarms.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
CIP Objects
Appendix B
Class Attributes
Table 65 - Relay Object Class Attributes
Access Rule
Attr ID
Name
Data Type
Description
Semantics
3
Get
Number of Instances
UINT
Number of Instances in this class.
5
100
Set
Reset All
USINT
Setting this attribute is equivalent
to executing the Class Reset
service
Reset All is an attribute that provides a
way to perform a Class level Reset service
via the Set_Attribute_Single service.
Setting this attribute to any value is
equivalent to performing the Class level
Reset service. Reading the Reset All
attribute always returns zero.
Instances
There is one instance of the object. Instance 1 is a virtual relay which corresponds
with the Relay status indicator on the module.
IMPORTANT
Instances 2…5 are not available when the module is configured in the
RSLogix 5000 software.
Instance Attributes
Table 66 - Relay Object Instance Attributes
Access Rule
Attr ID
Name
Data Type
Description
Semantics
3
Get
Relay Status
BOOL
The current status of the relay.
0 = Off
1 = On
4
Get/Set
Relay Enable
BOOL
Indicates whether this relay object
is enabled.
0 = Disabled
1 = Enabled
5
Get/Set
Latch Enable
BOOL
Indicates whether this relay
latches (requires a reset command
to deactivate).
0 = Nonlatching
1 = Latching
6
Get/Set
Failsafe Enable
BOOL
Indicates whether this relay is
normally energized (activated
during power loss).
0 = Non-failsafe (not normally energized)
1 = Failsafe (normally energized)
7
Get/Set
Delay
UINT
The time period that the voting
logic must be true before the relay
is activated.
0…65,535 milliseconds
8
Get/Set
Name
STRING2
A name to help identify the relay.
18 characters maximum
9
Get/Set
Alarm Level
BYTE
Specifies what alarm status values
cause the relay to activate.
0 = Normal
1 = Alert
2 = Danger
3 = Disarm
4 = Xdcr Fault
5 = Module Fault
6 = Tachometer Fault
10
Get/Set
Alarm Identifier A
EPATH
Identifies the first alarm status the
relay monitors.
See Parameter Object instances 26…30.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
143
Appendix B
CIP Objects
Table 66 - Relay Object Instance Attributes
Access Rule
Attr ID
Name
Data Type
Description
Semantics
11
Get/Set
Alarm Identifier B
EPATH
Identifies the second alarm status
the relay monitors.
See Parameter Object instances 31…35.
See Table 48 on page 128.
12
Get/Set
Logic
USINT
Indicates the number of
associated alarms that must have
a status value specified by Alarm
Level to activate the relay.
0 = Ignore Alarm Identifier B and
activate the relay based on the status of
Alarm Identifier A.
1 = Activate the relay if the status of either
Alarm Identifier A or B matches any of
the statuses specified by Alarm Level.
2 = Activate the relay if the status of both
Alarm Identifier A and B match any of
the statuses specified by Alarm Level.
14
Get
Relay Installed
BOOL
Indicates whether an actual relay
is associated with this instance.
0 = Not installed
1 = Installed
15
Get/Set
Idle Hold
USINT
Hold relay state during
reconfiguration.
0 = Relay is deactivated while module is in
Program mode.
1 = Relay retains last state while in
Program mode.
Services
Table 67 - Relay Object Services
Service Code
Class/Instance Usage
Name
Description
05h
Class/Instance
Reset
Resets latched relay.
0Eh
Class/Instance
Get_Attribute_Single
Returns a single attribute.
10h
Class/Instance
Set_Attribute_Single
Sets a single attribute.(1)
(1)
144
Attributes can only be set while the device is in Program mode. See the description of the Device Mode Object for more information.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
CIP Objects
Spectrum Waveform
Measurement Object
(Class ID 324H)
Appendix B
The Spectrum/Waveform Measurement Object models a spectrum and
waveform measurement.
When requesting the first byte of waveform or spectra data the module copies the
most recently sampled live measurement to a hold buffer where it is held until the
entire measurement is uploaded to the host, or until a new first byte request is
made. If the measurement mode is Synchronous, and the channels have the same
number of orders and number of lines, then when the first byte of the channel 0
data is requested, the module copies the simultaneous measurements for both
channel 0 and channel 1 to the hold buffer.
Class Attributes
The Spectrum/Waveform Measurement Object provides no class attributes.
Instances
There are four instances of this object. Instances 1 and 2 are the standard
spectrum (and waveform) for channels 1 and 2, respectively. Instances 3 and 4 are
the gSE spectrum for channels 1 and 2, respectively. Instance 3 and 4 support the
gSE spectrum only and not a waveform. Also, instances 3 and 4 do not support
the Complex Data Format.
Instance Attributes
Table 68 - Spectrum Waveform Measurement Object Instance Attributes
Access Rule
Attr ID
Name
Data Type
Description
Semantics
3
Get
Status
BOOL
Indicates if a fault or alarm has
occurred.
0 = Operating without alarms or faults.
1 = Alarm or fault condition exists. The
Spectrum and Waveform data may not
represent the actual field value.
4
Get
Data Units
ENGUNIT
The units context of the Data
attributes.
This setting is determined by the Channel
Object’s Output Data Units attribute (see
page 138).
5
Get
Domain
USINT
The domain used for the spectrum
and waveform measurements.
0 = Frequency/Time
1 = Order/Position
6
Get/Set
FMAX
REAL
The maximum frequency or order
of the spectrum data.
0…20,000 Hz if Domain = 0. There are
several predetermined FMAX settings for
which spectrum data can be produced. If
you select an unsupported value, then the
next greater supported FMAX value is used
for the spectrum data.
4…40 Orders if Domain = 1.The
Number of Lines value must be evenly
divisible by the FMAX value or an Invalid
Device Configuration error is returned
during the Device Mode Object Start and
Save services.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
145
Appendix B
CIP Objects
Table 68 - Spectrum Waveform Measurement Object Instance Attributes
Access Rule
Attr ID
Name
Data Type
Description
Semantics
7
Get/Set
Number of Spectrum
Lines
UDINT
Number of lines or bins in the
spectrum data.
100, 200, 400, 800, or 1600
8
Get/Set
Window Type
USINT
The window function to be
applied to the waveform data
prior to computing the spectrum.
0 = Rectangular
1 = Hamming
2 = Hanning
3 = Flat Top
4 = Kaiser Bessel
9
Get/Set
Period
REAL
The period of the waveform.
Seconds if Domain = 0.
Cycles if Domain = 1.
10
Get
Number of Waveform UDINT
Points
Number of points in the waveform
data.
256, 512, 1024, 2048, or 4096
11
Get
Overlap
USINT
The percent overlap applied to the
waveform data sets used for
calculating the spectrum.
Only 0% supported.
12
Get/Set
Data Format
USINT
The format of the spectrum data.
0 = Complex data
1 = Magnitude data
13
Get
Average Type
USINT
The type of averaging performed.
0 = Asynchronous (spectrum)
1 = Synchronous (waveform)
Determined by the Synchronous
attribute of the Channel Object.
When set to Asynchronous, consecutive
spectrum measurements are averaged
together to produce the Spectrum data.
When set to synchronous, synchronized
waveforms are averaged together to
produce the Waveform data, and the
Spectrum data is produced from the
averaged waveform. A trigger source from
a tachometer, for example, is required to
obtain the synchronized waveforms.
146
14
Get/Set
Number of Averages
UINT
The number of individual data sets
to be incorporated into the
average calculation.
0 = Invalid
1 = No averaging
> 1 = Averaging
15
Get/Set
Storage Option
BYTE
Determines what must be stored
in response to a storage trigger
event.
1 = Store waveform
2 = Store spectrum
16
Get
Storage Timestamp
LTIME
Records the timestamp of the
stored data.
64-bit microsecond counter value.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
CIP Objects
Appendix B
Services
Table 69 - Spectrum Waveform Measurement Object Services
Service Code
Class/Instance Usage
Name
Description
0Eh
Instance
Get_Attribute_Single
Returns a single attribute.
10h
Instance
Set_Attribute_Single
Sets a single attribute.(1)
4Bh
Instance
Get_Spectrum_Chunk
Upload a portion of the current
Spectrum data.
4Ch
Instance
Get_Waveform_Chunk
Upload a portion of the current
Waveform data.
(1)
Attributes can only be set while the device is in Program mode. See the description of the Device Mode Object for more information.
Get_Spectrum_Chunk/Get_Waveform_Chunk
These services return a portion of the respective data structure. It is likely that the
spectrum and waveform data structures are too large to transfer over the network
in one message. These services let the data structures be transferred over the
network in smaller portions so that the explicit message buffer does not need to
be so large.
The Spectrum Data structure contains an array of values that, taken together, are
the output of the spectrum measurement performed by the Spectrum/Waveform
Measurement Object on the input signal. The size of the Spectrum Data
structure and format of the data array depends on the Data Format attribute. In
all cases, the spectrum data array values are normalized and must be converted to
floating point to obtain the true values.
Table 70 - Spectrum Data Structure
Byte (DWORD) offset
within structure
Structure Member
Data Type
Description
0 (0)
Number of Spectrum Lines
UDINT
Number of lines or bins in the spectrum data. This must be equal to the
Number of Spectrum Lines attribute setting. It is provided within this
structure to assist in determining the size of the structure.
4 (1)
FMAX
REAL
The maximum frequency or order of the spectrum data.
This is the actual FMAX of the spectrum data and may vary from the FMAX
attribute setting.
8 (2)
Amplitude Reference
REAL
Normalization factor
This factor is used to convert the normalized array data into floating point
values.
12 (3)
Normalized Value Array
Array of INT or UINT
The normalized spectrum data points
These must be converted to floating point values using the Amplitude
Reference value. The Data Format attribute determines whether these are
INT or UINT and exactly what conversion must be applied.
The total size of the Spectrum Data structure in DWORD is:
• For Magnitude Data Format: 3 + (Number of Spectrum Lines / 2)
• For Complex Data Format: 3 + (Number of Spectrum Lines)
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
147
Appendix B
CIP Objects
If the data format is Magnitude Data then the Normalized Value Array is an
array of UINT (16-bit unsigned integers ranging from 0 to 65535). The number
of UINTs in the spectrum data array is equal to the Number of Spectrum Lines.
To convert the normalized spectrum data into floating point values, use the
following equation:
Normalized Data n
Float Data n = Amplitude Reference -------------------------------------------65536
Where Float Datan is the value for the nth spectrum bin, and 0  n  Number of
Spectrum Line.
The Float Data value represents an amplitude value if Data Format is real data.
The Float Data represents a power value if Data Format is power data.
If the data format is Complex Data then the Normalized Value Array is an array
of INT (16-bit signed integers ranging from -32,768…32,767). There are two
INTs (real and imaginary values) in the array for each spectrum bin (the array size
is twice the Number of Spectrum Lines). To convert the normalized spectrum
data into real and imaginary values, use the following equations:
Normalized Data 2n
Real Data n = Amplitude Reference ----------------------------------------------32768
Normalized Data  2n + 1 
Imaginary Data n = Amplitude Reference -----------------------------------------------------------32768
Where Real Datan and Imaginary Datan are the real and imaginary values for
the nth spectrum bin, and 0 n Number of Spectrum Line.
The Real Data and Imaginary Data values are converted into magnitude and
phase values with the following equations:
Magnitude Data n =
2
2
Real Data n + Imaginary Data n
 Imaginary Data n
Phase Data n = arctan  ----------------------------------------
 Real Data n 
The Waveform Data structure contains an array of values that, taken together, are
the output of the sampling performed by the Spectrum/Waveform Measurement
148
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
CIP Objects
Appendix B
Object on the input signal. The Waveform Data array values are normalized and
must be converted to floating point to obtain the true values.
Table 71 - Waveform Data Structure
Byte (DWORD) offset
within structure
Structure Member
Data Type
Description
0 (0)
Number of Waveform
Points
UDINT
Number of points in the waveform data. This must be equal to the Number
of Waveform Points attribute setting. It is provided within this structure
to assist in determining the size of the structure.
4 (1)
Period
REAL
The period of the waveform.
This is the actual period of the waveform and may vary from the Period
attribute setting.
8 (2)
Amplitude Reference
REAL
Normalization factor
This factor is used to convert the normalized array data into floating point
values.
12 (3)
Normalized Value Array
Array of INT
The normalized waveform data points
These must be converted to floating point values using the Amplitude
Reference value.
The total size of the Waveform Data structure in DWORDs is 3 + (Number of
Waveform Points / 2).
The Waveform Data is an array of INT (16-bit signed integers ranging from 32768 to 32767). The number of INTs in the Waveform Data array is equal to
the Number of Waveform Points. To convert the normalized Waveform Data
into floating point values, use the following equations:
Normalized Data n
Float Data n = Amplitude Reference -------------------------------------------32768
Where Float Datan is the value for the nth waveform point, and 0 n Number
of Waveform Points.
The Get_Spectrum_Chunk and Get_Waveform_Chunk services use the same
request and response parameters.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
149
Appendix B
CIP Objects
Table 72 - Get_Spectrum_Chunk/Get_Waveform_Chunk Request Parameters
Description of Request Parameters
Name
Data Type
Initial DWORD Offset
UINT
The offset of the first 32-bit value within the
data structure to be returned.
Semantics of Values
0 <= offset < size of the data structure in DWORDs.
For example:
offset = 0 refers to bytes 0…3 (the number of lines or points
value)
offset = 1 refers to bytes 4…7 (the FMAX or period values)
offset = 2 refers to bytes 8…11 (the amplitude reference
value)
offset = 3 refers to bytes 12…15 (the first pair of normalized
values)
offset = 4 refers to bytes 16…19 (the second pair of
normalized values)
….
Number of DWORDs
USINT
The number of 32-bit values from the data
structure to be returned.
This must be small enough to fit in the explicit message buffer.
This is likely less than the total size of the data structure so
that several calls to the service are required to get the entire
data structure.
Table 73 - Get_Spectrum_Chunk/Get_Waveform_Chunk Response Parameters
Description of Response Parameters
150
Name
Data Type
Semantics of Values
Number of DWORDs
USINT
The number of 32-bit values actually returned
in the Data Chunk array of the response. (Can
be less than the number of DWORDs
requested.)
Data Chunk
Array of DWORD
The requested portion of the data structure.
If less DWORDs are returned than were requested, the end of
the data structure has been reached (the request went beyond
the end of the array).
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
CIP Objects
Appendix B
The Speed Measurement Object models a speed measurement of a tachometer
signal.
Speed Measurement
Object (Class ID 325H)
Class Attributes
The Speed Measurement Object provides no class attributes.
Instance Attributes
Table 74 - Speed Measurement Object Instance Attributes
Access Rule
Attr ID
Name
Data Type
Description
Semantics
3
Get
Speed Value
REAL
The measured speed value.
CPM
4
Get
Status
BOOL
Indicates if a fault or alarm has
occurred.
0 = Operating without alarms or faults.
1 = Alarm or fault condition exists. The
Speed Value attribute may not represent
the actual field value.
5
Get
Maximum Speed
REAL
The maximum (peak) measured
speed value since the most recent
reset.
CPM
12
Get/Set
Time Constant
UINT
The time constant value used for
exponential averaging of the
Speed Value (a low pass filter/
output smoothing filter).
Milliseconds
13
Get
Acceleration
REAL
The rate of change of the Speed
Value.
CPM/min
14
Get/Set
Measurement
Response
USINT
Determines how quickly the Speed
measurement responds to change.
For example, setting this attribute
to 1 indicates a settling time of
220 ms. This means that the speed
is averaged over a quarter second,
and the reported value reaches
90% of the new steady state value
about 220 ms after the change in
machine speed.
See table below.
Meas.
Response
Settling
Time
Time
Constant
0
2640 ms
1200 ms
1
220 ms
100 ms
2
22 ms
10 ms
Services
Table 75 - Speed Measurement Object Services
Service Code
Class/Instance Usage
Name
Description
05h
Instance
Reset
Clears Maximum (Peak) speed to 0.
0Eh
Instance
Get_Attribute_Single
Returns a single attribute.
10h
Instance
Set_Attribute_Single
Sets a single attribute.(1)
(1)
Attributes can only be set while the device is in Program mode. See the description of the Device Mode Object for more information.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
151
Appendix B
CIP Objects
Measurement Parameters
Table 76 - Thrust Position Measurement Parameters
Parameter Name
Description
Values/Comments
Target Angle
Sets the angle between the shaft and the
target surface. The target surface moves with
the shaft. The transducer is mounted
perpendicular to the target surface.
degrees
Upscale
Sets the movement of the target relative to
the transducer that is considered positive
displacement.
Options:
• Away
• Towards
Calibration Offset
(XM Serial only)
Enter the position of the current Transducer
DC Bias reading.
mils
Calibration Bias
Sets the zero or green position. The zero
position is the normal operating position.
Setting the zero position compensates for the
static gap. This enables the module to display
only the displacement around the zero
position.
Volts
Important: Check with the manufacturer
about operating thrust position and
acceptable tolerances before making any
adjustments.
Use one of the formulas below to calculate the
Calibration Bias. The formula that you use
depends on the Upscale setting and whether
Fault High and Fault Low are both less than
or equal to zero (0).
Upscale set to ‘Towards’ Formula
Calibration bias = Transducer DC Bias +
(Sensitivity x Calibration Offset) x sin (Target
Angle)
Upscale set to “Away” Formula
Calibration Bias = Transducer DC Bias (Sensitivity x Calibration Offset) x sin (Target
Angle)
If Fault High and Fault Low are both less
than or equal to 0, use one of these formulas:
Upscale set to “Towards” Formula
Calibration bias = Transducer DC Bias (Sensitivity x Calibration Offset) x sin (Target
Angle)
Upscale set to “Away” Formula
Calibration Bias = Transducer DC Bias +
(Sensitivity x Calibration Offset) x sin (Target
Angle)
Calculate Bias (XM
Serial only)
Tachometer Channel
Object (Class ID 326H)
152
Automatically calculates the Calibration
Bias value.
The Tachometer Channel Object models front end processing performed on a
tachometer signal before specific measurements are performed.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
CIP Objects
Appendix B
Class Attributes
The Tachometer Channel Object provides no class attributes.
Instance Attributes
Table 77 - Tachometer Channel Object Instance Attributes
Access Rule
Attr ID
Name
Data Type
Description
Semantics
3
Get/Set
Number of Pulses per
Revolution
UINT
The number of signal pulses per
revolution of the shaft (for
example number of gear teeth).
0 = Tachometer disabled
> 0 = Tachometer enabled
4
Get/Set
Auto Trigger
BOOL
Indicates whether the trigger level
is determined automatically from
the signal.
0 = Use specified Trigger Level, Trigger
Slope, and Hysteresis
1 = Automatically determine trigger level
and trigger slope, and use the specified
Hysteresis
5
Get/Set
Trigger Level
REAL
The signal level to be used as the
trigger.
Volts
6
Get/Set
Trigger Slope
USINT
The slope of the signal at the
threshold crossing to be used as
the trigger.
0 = Positive
1 = Negative
7
Get/Set
Trigger Hysteresis
REAL
The amount of hysteresis around
the trigger level.
In Auto Trigger mode, this value is a
percentage of the peak-to-peak input
signal and can range from 0 to 50%. In
Manual Trigger mode, this value is a
voltage level (the hysteresis voltage is
added or subtracted to the threshold
voltage to determine the hysteresis
range).
8
Get/Set
Name
STRING2
A name to help identify this
channel.
18 characters maximum
10
Get/Set
Fault Time-out
USINT
Number of seconds with no pulses
before a Tach Fault is indicated
unless Zero Pulse Fault Inhibit
is set to 1.
1…64 seconds
11
Get/Set
Zero Pulse Fault
Inhibit
BOOL
Lack of Tach Pulses does not cause
a Tach Fault.
0 = A lack of tach pulses constitutes a Tach
Fault
1 = A lack of tach pulses does not
constitute a Tach Fault
Services
Table 78 - Tachometer Channel Object Services
Service Code
Class/Instance Usage
Name
Description
0Eh
Instance
Get_Attribute_Single
Returns a single attribute.
10h
Instance
Set_Attribute_Single
Sets a single attribute.(1)
(1)
Attributes can only be set while the device is in Program mode. See the description of the Device Mode Object for more information.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
153
Appendix B
CIP Objects
The Transducer Object models a transducer.
Transducer Object
(Class ID 328H)
Class Attributes
The Transducer Object provides no class attributes.
Instances
There are three instances of this object.
Table 79 - Band Measurement Object Instances
Instance
Descriptions
1
Vibration Channel 0
2
Vibration Channel 1
3
Tachometer Channel
Instance Attributes
Table 80 - Transducer Object Instance Attributes
Access Rule
Attr ID
Name
Data Type
Description
Semantics
3
Get
DC Bias
REAL
The measured average DC bias of
the transducer signal in volts.
Volts
4
Get
Status
BOOL
Indicates whether a transducer
fault exists (the measured DC Bias
is outside the range specified by
Fault High and Low).
0 = No fault
1 = A transducer fault exists
5
Get/Set
Sensitivity Value
REAL
Value of the sensitivity of the
transducer in millivolts per
Sensitivity Units.
See Valid Full Scale Selections for valid
Sensitivity and Full Scale value pairs.
6
Get/Set
Sensitivity Units
ENGUNIT
Units of the denominator of the
Sensitivity Value.
See DeviceNet Specification Volume 1
Appendix K. Also see Parameter Object
instances 1 and 2 (page 128).
Valid values:
g = 1504h
in/sec = 2B07h
mil = 0800h
psi = 1300h
volt = 2D00h
mm/s = 0900h
μm = 2204h
mbar = 1308h
Pa = 1309h
7
154
Get/Set
Fault High
REAL
The maximum expected DC Bias
voltage from the transducer in
volts.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Volts
A reading above this value causes a
transducer fault, which is indicated by the
Channel status indicator flashing red.
CIP Objects
Appendix B
Table 80 - Transducer Object Instance Attributes
Access Rule
Attr ID
Name
Data Type
Description
Semantics
8
Get/Set
Fault Low
REAL
The minimum expected DC Bias
voltage from the transducer in
volts.
Volts
9
Get/Set
Power Type
USINT
Indicates the type of power
supplied to the transducer.
0 = Off
1 = IEPE (externally supplied)
2 = +24V (externally applied)
3 = -24V (externally applied from terminal
base)
4 = Bias Current (externally supplied)
13
Get
DC Bias Time
Constant
REAL
The time constant value used for
exponential averaging of the DC
Bias value (a low pass filter/
output smoothing filter).
1.769 seconds
Services
Table 81 - Transducer Object Services
Service Code
Class/Instance Usage
Name
Description
0Eh
Instance
Get_Attribute_Single
Returns a single attribute.
10h
Instance
Set_Attribute_Single
Sets a single attribute.(1)
(1)
Vector Measurement
Object (Class ID 329H)
Attributes can only be set while the device is in Program mode. See the description of the Device Mode Object for more information.
The Vector Measurement Object models the measurement of the amplitude and
phase of the input signal at a specific multiple of the machine speed.
Class Attributes
The Vector Measurement Object provides no class attributes.
Instances
There are eight instances of this object.
Table 82 - Vector Measurement Object Instances
Instance
Description
1
Channel 1 1X Vector Measurement
2
Channel 2 v1X Vector Measurement
3
Channel 1 2X Vector Measurement
4
Channel 2 2X Vector Measurement
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
155
Appendix B
CIP Objects
Table 82 - Vector Measurement Object Instances
Instance
Description
5
Channel 1 3X Vector Measurement
6
Channel 2 3X Vector Measurement
7
Channel 1 Tracking Measurement
8
Channel 2 Tracking Measurement
Instance Attributes
Table 83 - Vector Measurement Object Instance Attributes
Access Rule
Attr ID
Name
Data Type
Description
3
Get
Magnitude Value
REAL
The measured magnitude value.
4
Get
Phase Value
REAL
The measured phase value.
Semantics
Degrees
Important: Not valid for instances 5 and
6.
5
Get
Status
BOOL
Indicates if a fault or alarm has
occurred.
0 = Operating without alarms of faults.
1 = Alarm or fault condition exists. The
Value attributes may not represent the
actual field value.
6
Get
Magnitude Data
Units
ENGUNIT
The units context of the
Magnitude Value attribute.
This setting is determined by the Channel
Object’s Output Data Units setting (see
page 138).
7
Get
Speed Value
REAL
The speed at which the magnitude
and phase are measured.
Instances 1 and 2 use 1X machine speed.
Instances 3 and 4 use 2X machine speed.
Instances 5 and 6 use 3X machine speed.
The value is valid only when synchronous
sampling mode is selected for the
corresponding channel.
8
Get
Speed Data Units
ENGUNIT
The units context of the Speed
Value attribute.
See DeviceNet Specification Volume 1
Appendix K.
This is set to Orders.
Services
Table 84 - Vector Measurement Object Services
Service Code
0Eh
156
Class/Instance Usage
Name
Description
Instance
Get_Attribute_Single
Returns a single attribute.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
CIP Objects
Appendix B
The 4…20 mA Output Object models the configuration of a 4…20 mA output
signal.
4…20 mA Output
Object (Class ID 32AH)
Class Attributes
The 4…20 mA Output Object provides no class attributes.
Instances
There are two instances of this object.
Instance Attributes
Table 85 - 4…20 mA Output Object Instance Attributes
Access Rule
Attr ID
Name
Data Type
Description
Semantics
3
Get/Set
Value
REAL
The current output value.
mA
4
Get/Set
Enable
BOOL
Indicates whether this 4…20 mA
output is enabled.
0 = Disabled
1 = Enabled
5
Get/Set
Max Range
REAL
The measured value associated
with 20 mA.
6
Get/Set
Min Range
REAL
The measured value associated
with 4 mA.
7
Get/Set
Measurement
Identifier Path
EPATH
Identifies the class, instance, and
attribute of a measurement value
that this 4…20 mA output is
tracking.
See Parameter Object Instances 7 and 8.
See DeviceNet Specification Volume 1
Appendix I.
Services
Table 86 - 4…20 mA Output Object Services
Service Code
Class/Instance Usage
Name
Description
0Eh
Instance
Get_Attribute_Single
Returns a single attribute.
10h
Instance
Set_Attribute_Single
Sets a single attribute.1
1
Attributes can only be set while the device is in Program mode. See the description of the Device Mode Object for more information.
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
157
Appendix B
CIP Objects
Notes:
158
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Appendix
C
History of Changes
Topic
Page
1440-UM001B-EN-P, December 2013
159
This appendix summarizes the revisions to this manual. Reference this appendix
if you need information to determine what changes have been made across
multiple revisions. This may be especially useful if you are deciding to upgrade
your hardware or software based on information added with previous revisions of
this manual.
1440-UM001B-EN-P,
December 2013
•
•
•
•
•
•
•
•
•
•
•
Added Measurement Mode
Added Signal Processing
Added Spectrum/Waveform Measurement Options
Added Band Measurement Options
Added gSE Measurement Options
Added Tracking Filter Options
Added Band Pass Filter Options
Added Thrust Position Measurement Options
Added Eccentricity Measurement Options
Updated Monitor Data Parameters
Updated Parameter Object Instances
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
159
Appendix C
History of Changes
Notes:
160
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Index
Numerics
1440-DYN02-01RJ
install on terminal base 51
1440-TBS-J
install 23
24V common grounding requirements 22
4-20mA Output Object 157
4-20mA output parameters 85
Enable 85
Max Range 85
Measurement 85
Min Range 85
4-20mA outputs, wiring 47
A
acknowledge handler object 133
alarm object 134
alarm parameters
Alarm Number 80
Alert Threshold (High) 81
Alert Threshold (Low) 81
Condition 80
Danger Threshold (High) 81
Danger Threshold (Low) 81
Enable 80
Hysteresis 81
Measurement 80
Name 80
Speed Range Enable 82
Speed Range High 82
Speed Range Low 82
Startup Period 81
Threshold Multiplier 82
analog input point object 126
assembly object 118
Automatic Device Replacement (ADR) 56
B
band measurement object 136
Band measurement options 71
Band Pass Filter options 75
bit-strobe message format 105
buffered outputs, wiring 33
CIP objects 115
acknowledge handler 133
alarm 134
analog input point 126
assembly 118
band measurement 136
channel 138
connection 123
device mode 140
DeviceNet 117
discrete input point 124
identity 115
overall measurement 141
parameter 127
relay 142
spectrum waveform measurement 145
speed measurement 151
tachometer channel 152
transducer 154
vector measurement 155
Class 2 power supply 22
Class Instance Editor 100
components
XM-120 module 16
XM-121 module 16
XM-441 module 16
XM-940 terminal base 16
configuration parameters
4-20mA output parameters 85
channel parameters 63
data parameters 93
relay parameters 82
SU/CD trend parameters 88, 109
tachometer parameters 78
triggered trend parameters 86, 107
connecting wiring 27
4-20mA outputs 47
buffered outputs 33
DeviceNet 49
power supply 30
remote relay reset signal 46
serial port 48
setpoint multiplication switch 47
tachometer 32
terminal base XM-940 27
transducers 34
connection object 123
COS message format 104
C
channel object 138
channel parameters 63
Calibration Bias 76, 152
Sensitivity 75
Target Angle 75, 152
Upscale 75, 152
Channel Status indicator 112
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
161
Index
D
data parameters 93
1X Magnitude Value 94
1X Phase Value 94
2X Magnitude Value 94
2X Phase Value 94
3X Magnitude Value 94
4-20 mA Output A 95
4-20 mA Output B 95
Acceleration Measured Value 95
Alarm Status 96
Band Measured Value 94
Band Measurement 94
Band Measurement Status 94
DC Gap Voltage 94
Get Waveform Data Only 95
Measured DC Bias 94
Not 1X and Vector Status 94
Not 1X Value 94
Overall Value 94
Peak Speed 95
Relay Status 96
SMAX Magnitude 95
SMAX Phase 95
SMAX Status 95
Spectrum/Waveform Status 95
Speed Status 95
Speed Value 95
Sum Harmonics Value 94
Transducer 3 Measured DC Bias 95
Transducer 3 Status 95
Transducer Fault 94
Transducer Status 94
Xdcr DC Bias 95
description
configuration parameters 107
XM-120 module 16
XM-121 module 16
XM-441 module 16
XM-940 terminal base 16
device mode object 140
Device Mode parameter 98
Device Mode parameters
Device Mode 98
DeviceNet connection
wiring 49
DeviceNet information
automatic device replacement (ADR) 56
EDS files 56
I/O message formats 101
invalid device configuration errors 101
setting the Device Mode parameter 98
XM services 100
DeviceNet object 117
DeviceNet objects
4-20mA Output 157
DIN Rail Grounding Block 19
DIN rail grounding requirements 19
discrete input point object 124
Dynamic Measurement module
CIP objects 115
grounding requirements 19
indicators 111
install module 51
install terminal base 23
self-test 57
wiring requirements 17
E
Eccentricity measurement options 77
Electronic Data Sheet (EDS) files 55
G
grounding requirements
24V common 22
DIN rail 19
panel/wall mount 20
gSE measurement options 73
I
I/O message formats
bit-strobe messages 105
change of state (COS) messages 104
poll messages 102
XM status values 104
identity object 115
indicators 111
Channel Status 112
Network Status 112
Relay 112
Setpoint Multiplier 113
Tachometer Status 113
install
instructions 13
module on terminal base 51
terminal base unit on DIN rail 23
terminal base unit on panel/walll 26
installation requirements
grounding 19
power 17
wiring requirements 17
instructions
install 13
interconnecting terminal base units 25
invalid device configuration errors 101
M
measurement mode 65
modes
measurement 65
normal 76
N
Network Status (NS) indicator 112
normal mode 76
162
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Index
Not1X measurements 94
O
operating mode
program mode 98, 112
run mode 98, 112
overall measurement object 141
P
panel/wall mount grounding requirements 20
parameter object 127
poll message format 102
Assembly instance 101 102
power requirements 17
power supply, wiring 30
program mode 98, 112
R
Relay indicator 112
relay object 142
relay parameters 82
Activation Delay 83
Activation Logic 84
Alarm A 84
Alarm B 84
Alarm Identifier A 84
Alarm Identifier B 84
Alarm Levels 84
Alarm Status to Activate On (Alarm Levels) 84
Enable 83
Failsafe 84
Latching 83
Name 83
Number 83
Relay Installed 84
relays
resetting 46, 99
remote relay reset signal, wiring 46
reset switch 99
run mode 98, 112
S
self-test, status 57
serial port connection
mini-connector 49
terminal base unit 48
setpoint multiplication switch, wiring 47
Setpoint Multiplier indicator 113
signal processing 66
SMAX measurements 95
spectrum waveform measurement object 145
Spectrum/Waveform measurement options
67
speed measurement object 151
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
SU/CD trend parameters 88, 109
Enable SU/CD Trend 88, 109
Latch Enable 88, 109
Maximum Speed 88, 110
Maximum Trend Span 88, 109
Minimum Speed 88, 110
Number of Records 88, 109
Record Interval 88, 109
Reset Trigger 89, 110
Select Measurements 88, 109
Status 89, 110
View Trend Data 89, 110
T
tachometer channel object 152
tachometer parameters 78
Tachometer Status indicator 113
tachometer, wiring 32
terminal base
install on DIN rail 23
interconnecting units 25
mounting on panel/wall 26
terminal block assignment 27
thrust position measurement mode 75
Thrust Position measurement options 75
Tracking Filter options 74
transducer object 154
transducer wiring 34
IEPE accelerometer 34
non-contact sensor 36
other configurations 42, 43, 44
passive transducer 37
powered sensor 39
process DC voltage signal 40
transition to program mode, DeviceNet 98
transition to run mode, DeviceNet 99
triggered trend parameters 86, 107
Enable Triggered Trend Measurements 86,
107
Latch Enable 86, 108
Manual Trigger 87, 108
Number of Records 86, 107
Post Trigger 87, 108
Record Interval 86, 108
Relay Number 86, 108
Reset Trigger 87, 108
Select Measurements 86, 107
Status 87, 108
Store Spectrum 87, 108
Store Waveform 87, 108
Trend Span 86, 108
View Collected Data 87, 108
View Trend Data 87, 108
troubleshooting 111
V
vector measurement object 155
vector measurements 94
163
Index
W
wiring
to separate power connections 18
to terminal base 27
wiring connections
4-20mA outputs 47
buffered outputs 33
DeviceNet 49
power supply 30
remote relay reset signal 46
serial port 48
setpoint multiplication switch 47
tachometer 32
transducers 34
wiring requirements 17
X
XM Services 100
XM status values 104
XM-120 Vibration Module
reset switch 99
XM-120/121 Dynamic Measurement module
components 16
description 16
power requirements 17
XM-120/121 I/O message formats 101
XM-441 Expansion Relay Module 16, 82
XM-441 Relay Expansion Module 99
XM-940 terminal base
description 16
wiring 27
164
Rockwell Automation Publication 1440-UM001C-EN-P - May 2014
Rockwell Automation Support
Rockwell Automation provides technical information on the Web to assist you in using its products.
At http://www.rockwellautomation.com/support you can find technical and application notes, sample code, and links to
software service packs. You can also visit our Support Center at https://rockwellautomation.custhelp.com/ for software
updates, support chats and forums, technical information, FAQs, and to sign up for product notification updates.
In addition, we offer multiple support programs for installation, configuration, and troubleshooting. For more
information, contact your local distributor or Rockwell Automation representative, or visit
http://www.rockwellautomation.com/services/online-phone.
Installation Assistance
If you experience a problem within the first 24 hours of installation, review the information that is contained in this
manual. You can contact Customer Support for initial help in getting your product up and running.
United States or Canada
1.440.646.3434
Outside United States or Canada
Use the Worldwide Locator at http://www.rockwellautomation.com/rockwellautomation/support/overview.page, or contact your local
Rockwell Automation representative.
New Product Satisfaction Return
Rockwell Automation tests all of its products to help ensure that they are fully operational when shipped from the
manufacturing facility. However, if your product is not functioning and needs to be returned, follow these procedures.
United States
Contact your distributor. You must provide a Customer Support case number (call the phone number above to obtain one) to your
distributor to complete the return process.
Outside United States
Please contact your local Rockwell Automation representative for the return procedure.
Documentation Feedback
Your comments will help us serve your documentation needs better. If you have any suggestions on how to improve this
document, complete this form, publication RA-DU002, available at http://www.rockwellautomation.com/literature/.
Rockwell Automation maintains current product environmental information on its website at
http://www.rockwellautomation.com/rockwellautomation/about-us/sustainability-ethics/product-environmental-compliance.page.
Rockwell Otomasyon Ticaret A.Ş., Kar Plaza İş Merkezi E Blok Kat:6 34752 İçerenköy, İstanbul, Tel: +90 (216) 5698400
Publication 1440-UM001C-EN-P - May 2014
Supersedes Publication 1440-UM001B-EN-P - October 2013
Copyright © 2014 Rockwell Automation, Inc. All rights reserved. Printed in the U.S.A.
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement