Modulos Analogos
Modulos Analogos
Modules
Catalog Numbers 5069-IF4IH, 5069-IF8, 5069-IY4, 5069-IY4K,
5069-OF4, 5069-OF4K, 5069-OF4IH, 5069-OF8
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.
These 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).
Identifies information that is useful and can help to make a process easier to do or easier to understand.
Chapter 1
Analog Module Operation in a Controller and Software Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Control System Types of Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Module Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Local I/O Modules or Remote I/O Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Local I/O Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Remote I/O Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Limit Access to the System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Ownership . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Construct a System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Local I/O Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Remote I/O Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Use a 5069-ARM Address Reserve Module to Reserve a Node Address . . . . . . . . . 18
Power the Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Establish a New or Isolated SA Power Bus. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Configure the Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Connection Over EtherNet/IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Input Module Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Output Module Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Listen Only Connections. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Connection Over EtherNet/IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Additional Considerations With Listen Only Connections. . . . . . . . . . . . . . . . . . . . . 27
Protected Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
HART Communication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
HART I/O Modules and Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Chapter 2
Common Analog I/O Module Software Configurable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Features Module Data Quality Reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Fault and Status Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Inhibit a Module. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Electronic Keying . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Module Firmware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Producer/Consumer Communication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Rolling Time Stamp of Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Floating Point Data Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Calibration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Uncertain Data Quality Indication on Input Module Groups . . . . . . . . . . . . . . . . . . . 36
Alarm Latching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Enable Latching. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Unlatch Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Scaling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Data Offset. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Module Accuracy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Absolute Accuracy at 25 °C (77 °F) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Module Accuracy Drift with Temperature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Use CIP Sync Time with HART I/O Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Chapter 3
Current/Voltage Analog Input Analog Device Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Module Features - 5069-IF8 Multiple Input Ranges. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Notch Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Relationship between Notch Filter Settings and RPI Setting . . . . . . . . . . . . . . . . . . 43
Noise Rejection with Different Notch Filter Frequencies. . . . . . . . . . . . . . . . . . . . . 44
Digital Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Underrange/Overrange Detection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Process Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Enable Process Alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Configure Alarm Trigger Points. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Latch Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Unlatch Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Alarm Deadband . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Rate Alarm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Sensor Offset. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Open Wire Detection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Over Temperature Detection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Fault and Status Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Chapter 4
Current/Voltage/RTD/ Analog Device Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Temperature Analog Input Multiple Input Ranges. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Multiple Temperature Units . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Module Features -
Notch Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
5069-IY4, 5069-IY4K Relationship between Notch Filter Settings and RPI Setting . . . . . . . . . . . . . . . . . . 55
Noise Rejection with Different Notch Filter Frequencies. . . . . . . . . . . . . . . . . . . . . 56
Digital Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Underrange/Overrange Detection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Process Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Enable Process Alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Configure Alarm Trigger Points. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Latch Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Unlatch Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Alarm Deadband . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Rate Alarm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Sensor Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Sensor Type Temperature Limits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Sensor Offset. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
4 Rockwell Automation Publication 5069-UM005E-EN-P - May 2024
Table of Contents
Chapter 5
Current/Voltage Analog Output Multiple Output Ranges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Module Features - 5069-OF4, Channel Offset. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Hold for Initialization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
5069-OF4K, 5069-OF8
Connection Fault Handling. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Output Clamping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Clamp Alarming. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Output Ramping/Rate Limiting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Data Echo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
No Load Detection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Short Circuit Protection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Over Temperature Detection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Fault and Status Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Chapter 6
Current/Voltage/HART Analog Analog Device Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Input Module Features - Multiple Input Ranges. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Notch Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
5069-IF4IH
Relationship between Notch Filter Settings and RPI Setting . . . . . . . . . . . . . . . . . . 75
Digital Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Underrange/Overrange Detection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Process Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Enable Process Alarms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Configure Alarm Trigger Points. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Latch Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Unlatch Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Alarm Deadband . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Rate Alarm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Clamp Alarming. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Sensor Offset. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Channel Offset. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Open Wire Detection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Over Temperature Detection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Field Power Loss Detection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Fault and Status Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Chapter 7
Current/Voltage/HART Analog Multiple Output Ranges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Output Module Features - Channel Offset. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Hold for Initialization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
5069-OF4IH
Configure Channel Output State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Connection Fault Handling. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Output Clamping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Clamp Alarming. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Output Ramping/Rate Limiting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Data Echo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
No Load Detection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Short Circuit Protection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Over Temperature Detection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Field Power Loss Detection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Fault and Status Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Chapter 8
HART Device Features Information and Identity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Inhibit Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Electronic Keying . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Configuration Change Notification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Rolling Timestamp of Dynamic or Device Variable Data . . . . . . . . . . . . . . . . . . . . . . . . . 91
Producer/Consumer Communication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Execute HART Commands Through Producer/Consumer Data . . . . . . . . . . . . . . . . . . . . 92
Execute HART Commands Through Explicit Messaging . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Fault and Status Reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Chapter 9
Configure the Module Before You Begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Create a New Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Go Online and Discover Local I/O Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Remain Offline and Add New Local I/O Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Go Online and Discover Remote I/O Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Remain Offline and Add New Remote I/O Modules . . . . . . . . . . . . . . . . . . . . . . . . . 100
Reserve an I/O Module Slot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Add the 5069-ARM Module to the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Delete the 5069-ARM Module From the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Configure the Module Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Common Module Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Module-specific Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Chapter 10
Configure HART Devices Before You Begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Create a New Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Go Online and Discover Local HART Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Remain Offline and Add New Local HART Devices. . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Go Online and Discover Remote HART Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Remain Offline and Add New Remote HART Devices. . . . . . . . . . . . . . . . . . . . . . . . 113
Update or Add a HART EDD File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Update an EDD File for a Specific HART Device. . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Add an EDD File for a Generic HART Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
Configure the Device Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
General Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Variables Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Commands Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Chapter 11
Calibrate the Module Before You Begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
Controller State During Calibration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
Calibration Impacts Data Quality on Entire Input Module Group . . . . . . . . . . . . . . 119
Calibration Differences and Accuracy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Calibrate the Input Modules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Calibrate the 5069-IF8 Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Calibrate the 5069-IY4 and 5069-IY4K Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Calibrate the Output Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Calibrate the Output Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Appendix A
Troubleshoot the Module Troubleshoot with the Status Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Module Status Indicator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
I/O Status Indicators - Analog Input Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
I/O Status Indicators - Analog Output Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Troubleshoot with the Studio 5000 Logix Designer Application . . . . . . . . . . . . . . . . . . 134
Warning Signal in the I/O Configuration Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
Status and Fault Information in the Module Properties . . . . . . . . . . . . . . . . . . . . . 135
Studio 5000 Logix Designer Tag Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
Troubleshoot a HART Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
Warning Symbol in the I/O Configuration Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
Status and Fault Information in the Module Properties . . . . . . . . . . . . . . . . . . . . . 137
Studio 5000 Logix Designer Tag Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Appendix B
Module and Device Tags Conventions for Tag Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
View the Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Input Module Tags. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
Output Module Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
HART Device Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
These tables describe the tags that are associated with HART devices.. . . . . . . 151
Appendix C
HART I/O Module Diagnostic Create User-defined Diagnostic Assembly Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Assembly HART Input Module Diagnostics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
HART Output Module Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Configure the Message Type User Tags. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Appendix D
CIP Object Model of HART . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Devices
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
About This Publication This manual describes how to use Compact 5000® analog I/O modules in Logix 5000®
control systems.
Rockwell Automation recognizes that some of the terms that are currently used in our industry
and in this presentation are not in alignment with the movement toward inclusive language in
technology.
While we proactively collaborate with industry peers to find alternatives to such terms and
change our products and content, please excuse the use of such terms in our content.
Download Firmware, AOP, Download firmware, associated files (such as AOP, EDS, and DTM), and access product release
notes from the Product Compatibility and Download Center at rok.auto/pcdc.
EDS, and Other Files
Summary of Changes This publication contains the following new or updated information. This list includes
substantive updates only and is not intended to reflect all changes.
Topic Page
Added HART I/O module information Throughout
Terminology This table defines some of the terms that are used in this manual.
Additional Resources These documents contain additional information concerning related products from Rockwell
Automation. You can view or download publications at rok.auto/literature.
Resource Description
Compact 5000 Installation Instructions Describes how to install and wire these Compact 5000 I/O and Specialty Modules.
Publication 5069-IN001 5069-FPD
Publication 5069-IN002 5069-ARM
Publication 5069-IN003 5069-AENTR
Publication 5069-IN004 5069-IB16, 5069-IB16F, 5069-IB16K
Publication 5069-IN006 5069-IB6F-3W
Publication 5069-IN007 5069-OB16, 5069-OB16F, 069-OB16K
Publication 5069-IN008 5069-OW4I
Publication 5069-IN009 5069-OX4I
Publication 5069-IN010 5069-IF8
Publication 5069-IN011 5069-IY4, 5069-IY4K
Publication 5069-IN012 5069-OF4, 5069-OF4K, 5069-OF8
Publication 5069-IN015 5069-IA16
Publication 5069-IN016 5069-OA16
Publication 5069-IN017 5069-OB8
Publication 5069-IN018 5069-OW16
Publication 5069-IN020 5069-IB8S, 5069-IB8SK
Publication 5069-IN021 5069-OBV8S, 5069-OBV8SK
Publication 5069-IN025 5069-IF4IH
Publication 5069-IN026 5069-OF4IH
Provides specifications, wiring diagrams, and module block diagrams for
Compact 5000 I/O and Specialty Modules Technical Data, publication 5069-TD001 Compact 5000 I/O modules.
CompactLogix 5380 and Compact GuardLogix 5380 Controllers User Manual, Describes how to configure, operate, and troubleshoot CompactLogix™ 5380 and
publication 5069-UM001 Compact GuardLogix® 5380 controllers.
Describes how to configure, operate, and troubleshoot CompactLogix 5480
CompactLogix 5480 Controllers User Manual, publication 5069-UM002 controllers.
Compact 5000 Digital I/O Modules User Manual, publication 5069-UM004 Describes how to use Compact 5000 I/O digital modules.
Compact 5000 High-speed Counter Module User Manual, publication 5069-UM006 Describes how to use Compact 5000 I/O high-speed counter modules.
Describes requirements for achieving and maintaining Safety Integrity Level (SIL) 2
GuardLogix and Compact GuardLogix 5380 Controller Systems Safety Reference and Performance Level (PL) d requirements with the GuardLogix 5580 controller
Manual, publication 1756-RM012 system, with the Studio 5000 Logix Designer® application.
ControlLogix 5580 and GuardLogix 5580 Controllers User Manual, publication Describes how to configure, operate, and troubleshoot ControlLogix® 5580 and
1756-UM543 GuardLogix 5580 controllers.
Electronic Keying in Logix 5000 Control Systems Application Technique, publication
LOGIX-AT001 Describes how to use electronic keying in Logix 5000 control system applications.
Integrated Architecture and CIP Sync Configuration Application Technique, Provides information about CIP Sync technology and how to synchronize clocks
publication IA-AT003 within the Rockwell Automation® Integrated Architecture® system.
Provides guidance on how to conduct security assessments, implement Rockwell
System Security Design Guidelines Reference Manual, publication SECURE-RM001 Automation products in a secure system, harden the control system, manage user
access, and dispose of equipment.
Industrial Automation Wiring and Grounding Guidelines, publication 1770-4.1 Provides general guidelines for installing a Rockwell Automation industrial system.
Product Certifications website, rok.auto/certifications Provides declarations of conformity, certificates, and other certification details.
Topic Page
Controller and Software Compatibility 12
Types of Modules 13
Module Overview 13
Local I/O Modules or Remote I/O Modules 14
Limit Access to the System 16
Ownership 16
Construct a System 17
Power the Modules 19
Configure the Modules 21
Input Module Data 24
Output Module Data 25
Listen Only Connections 26
Protected Operations 28
HART Communication 29
HART I/O Modules and Devices 30
Logix 5000® controllers use the Compact 5000® analog I/O modules to control devices in a
control system.
Analog I/O modules convert analog signals to digital values for inputs and convert digital
values to analog signals for outputs. Controllers use these signals for control purposes.
Compact 5000 analog I/O modules use removable terminal blocks (RTBs) to connect field-side
wiring. Use the Studio 5000 Logix Designer® application to configure the modules.
Compact 5000 analog I/O modules use the Producer/Consumer network communication
model. This communication is an intelligent data exchange between modules and other
system devices in which each module produces data without first being polled.
Controller and Software Controller and programming software compatibility requirements apply when you use
Compact 5000 analog I/O modules.
Compatibility
• Compatibility between Logix 5000 controllers and Compact 5000 analog I/O modules
varies based on whether the module is local or remote.
• Standard I/O modules are supported in the Studio 5000 Logix Designer application,
version 28 or greater. However, the Logix 5000 controllers that are compatible with the
I/O modules support different minimum versions of the Studio 5000 Logix Designer
application.
• HART I/O modules are supported in the Studio 5000 Logix Designer application,
version 33 or greater.
This table describes the module compatibility requirements when you use Compact 5000
analog I/O modules with Logix 5000 controllers. Consider the different device requirements
when you design your system.
Compact 5000 I/O Analog Modules Controller and Software Compatibility Requirements
Module Controllers Studio 5000 Logix Designer Application
Type System Controller Cat. Nos. Standard I/O Modules HART I/O Modules
5069-L320ER, 5069-L320ERMK, 5069-L330ERMK, 5069-L340ERM, 5069-L350ERMK Version 28.00.00 or later
5069-L306ER, 5069-L306ERM, 5069-L310ER, 5069-L310ERM, 5069-L310ERMK, 5069-L310ER-NSE,
CompactLogix® 5380 5069-L310ERS2, 5069-L320ERM, 5069-L320ERMK, 5069-L320ERP, 5069-L330ER, 5069-L330ERM, Version 29.00.00 or later
5069-L330ERMK, 5069-L340ER, 5069-L340ERP
5069-L350ERM, 5069-L350ERMK, 5069-L380ERM, 5069-L3100ERM Version 30.00.00 or later
Local I/O
modules CompactLogix 5480 5069-L46ERMW Version 32.00.00 or later
5069-L306ERS2, 5069-L306ERMS2, 5069-L310ERS2, 5069-L310ERMS2, 5069-L320ERS2,
5069-L320ERS2K, 5069-L320ERMS2, 5069-L320ERMS2K, 5069-L330ERS2, 5069-L330ERS2K,
Compact GuardLogix® 5380 5069-L330ERMS2, 5069-L330ERMS2K, 5069-L340ERS2, 5069-L340ERMS2, 5069-L350ERS2, Version 31.00.00 or later
5069-L350ERS2K, 5069-L350ERMS2, 5069-L350ERMS2K, 5069-L380ERS2, 5069-L380ERMS2,
5069-L3100ERS2, 5069-L3100ERMS2
5069-L320ER, 5069-L340ERM Version 28.00.00 or later
5069-L306ER, 5069-L306ERM, 5069-L310ER, 5069-L310ERM, 5069-L310ERMK, 5069-L310ER-NSE, Version 33.00.00 or later
CompactLogix 5380 5069-L310ERS2, 5069-L320ERM, 5069-L320ERP, 5069-L330ER, 5069-L330ERM, 5069-L340ER, Version 29.00.00 or later
5069-L340ERP
5069-L350ERM, 5069-L380ERM, 5069-L3100ERM Version 30.00.00 or later
CompactLogix 5480 5069-L46ERMW Version 32.00.00 or later
Remote I/O 5069-L306ERS2, 5069-L306ERMS2, 5069-L310ERS2, 5069-L310ERMS2, 5069-L320ERS2,
modules 5069-L320ERS2K, 5069-L320ERMS2, 5069-L320ERMS2K, 5069-L330ERS2, 5069-L330ERS2K,
Compact GuardLogix 5380 5069-L330ERMS2, 5069-L330ERMS2K, 5069-L340ERS2, 5069-L340ERMS2, 5069-L350ERS2, Version 31.00.00 or later
5069-L350ERS2K, 5069-L350ERMS2, 5069-L350ERMS2K, 5069-L380ERS2, 5069-L380ERMS2,
5069-L3100ERS2, 5069-L3100ERMS2
1756-L83E, 1756-L85E Version 28.00.00 or later
ControlLogix® 5580
1756-L81E, 1756-L82E, 1756-L84E Version 29.00.00 or later
GuardLogix 5580 1756-L81ES, 1756-L82ES, 1756-L83ES, 1756-L84ES Version 31.00.00 or later
Types of Modules This table describes the types of Compact 5000 analog I/O modules. Catalog numbers that end
in ‘K’ are conformally coated.
Catalog Number Description
5069-IF4IH 4-channel current/voltage/HART input module
5069-IF8 8-channel current/voltage input module
5069-IY4. 5069-IY4K 4-channel current/voltage/RTD/Thermocouple input module
5069-OF4, 5069-OF4K 4-channel current/voltage output module
5069-OF4IH 4-channel current/voltage/HART output module
5069-OF8 8-channel current/voltage output module
Module Overview This figure shows the parts of an example Compact 5000 analog I/O module.
5
3
Local I/O Modules or You can use Compact 5000 analog I/O modules as local or remoteI/O modules, with some
restrictions that are based on the module and controller type. Compatibility requirements
Remote I/O Modules apply and are described in Controller and Software Compatibility.
Local I/O modules are installed to the right of the controller and exchange data with the
controller over the system backplane.
CompactLogix 5380 Controller Local Compact 5000 I/O Modules CompactLogix 5480 Controller Local Compact 5000 I/O Modules
The modules are installed to the right of the adapter and exchange data across the remote
system backplane. The data is then exchanged with the controller over the EtherNet/IP
network.
This figure shows remote Compact 5000 analog I/O modules in an example CompactLogix
5380 control system.
SD CARD
Limit Access to the System To limit access to a Logix 5000 controller, Compact 5000 EtherNet/IP adapter, or I/O module,
consider these options.
• Follow the guidelines provided in the System Security Design Guidelines Reference
Manual, publication SECURE-RM001.
• Password protect the source and execution of the control program.
• Use EtherNet/IP devices in accordance with recommended architectures and concepts.
See the Converged Plantwide Ethernet (CPwE) Design and Implementation Guide,
publication ENET-TD001.
• Implement physical barriers, such as locked cabinets.
For access to information about security matters that affect Rockwell Automation products,
visit the Rockwell Automation Security Advisories website and sign up for alerts.
Ownership A controller must own every I/O module in a Logix 5000 control system, also known as the
owner-controller. When you use the Compact 5000 analog I/O modules in a Logix 5000 control
system, the owner-controller supports these actions.
• Stores configuration data for every module that it owns.
• Can reside in a location that differs from the Compact 5000 I/O system.
• Sends the I/O module configuration data to define module behavior and begin operation
in the control system.
Each Compact 5000 analog I/O module must continuously maintain communication with its
owner-controller during normal operation.
The Compact 5000 analog I/O modules are limited to one owner-controller that performs the
functions that are listed previously. Other controllers can establish Listen-Only connections to
the Compact 5000 analog I/O modules.
Construct a System Before you use your Compact 5000 analog I/O modules, you must complete tasks that are
based on the way that you use the modules. That is, if the modules are used locally, remotely
or both locally and remotely.
For information on how to install compatible controllers, adapters, and Compact 5000 I/O
modules, see the publications that are listed in Additional Resources.
If a module is not available during initial system installation and operation, you can use a
5069-ARM address reserve module to reserve the node address. The address reserve module
remains installed until the functional I/O module is available.
When you install the address reserve module, you also make sure that the modules that are
installed afterward have the correct node address.
You use the corresponding entry in the Studio 5000 Logix Designer project to reserve the node
address. When you add modules to the I/O Configuration tree in the project, you add an
address reserve module at the node address that matches the physical module location.
When the I/O module becomes available, complete the following tasks.
1. Remove the 5069-ARM module from the system.
2. Install the I/O module in the slot that previously contained the 5069-ARM module.
3. Replace the 5069-ARM module entry in the I/O Configuration section of the Studio 5000
Logix Designer project with the new I/O module.
For more information on how to use a 5069-ARM module in a Studio 5000 Logix
Designer project, see Reserve an I/O Module Slot.
Power the Modules Compact 5000 analog I/O modules receive these power types from a controller or adapter.
Power Type Location Description
• Powers the system and lets modules transfer data and execute logic.
MOD power System-side • Provided through the Module (MOD) power connector and passed to modules
as they are added to the system.
IMPORTANT: A system has only one MOD power bus.
• Powers field-side devices that are connected to some Compact 5000 I/O
analog modules.
• Provided through the sensor actuator (SA) power connector and passed to
SA power Field-side modules as they are added to the system.
IMPORTANT: A system can have multiple SA power buses. Use a 5069-FPD field
potential distributor to establish new, isolated SA power buses in the same
system. For more information, see Establish a New or Isolated SA Power Bus.
Power begins at the leftmost device in the system and passes across the I/O module internal
circuitry via power buses. The MOD power bus and SA power bus are isolated from each other.
The leftmost device is either a controller or an EtherNet/IP adapter.
For more information on how to power local Compact 5000 I/O modules, see these resources.
- CompactLogix 5380 and Compact GuardLogix 5380 Controllers User Manual,
publication 5069-UM001
- CompactLogix 5480 Controller User Manual, publication 5069-UM002
For more information on how to power remote Compact 5000 I/O modules, see the Compact
5000 EtherNet/IP Adapters User Manual, publication 5069-UM007.
IMPORTANT Compact 5000 analog I/O modules are DC-type modules. You must install them
on an SA power bus that uses DC-type power. You cannot install Compact 5000
analog I/O modules on an SA power bus that uses AC-type power.
If you install modules in a system that uses both DC SA power and AC SA power,
you must isolate SA power buses by type with a 5069-FPD field potential
distributor. To create separate SA power buses, complete these steps.
1. To create the first SA power bus, install the modules that use one type of SA
power, for example DC, to the right of the adapter or controller.
2. To create a second SA power bus, install the 5069-FPD field potential
distributor to the right of these modules.
3. Install the modules that use the other type of SA power, for example AC, to
the right of the 5069-FPD module.
Configure the Modules You must create a Studio 5000 Logix Designer project for the Logix 5000 controller that owns
the Compact 5000 analog I/O module. The project includes module configuration data for the
Compact 5000 analog I/O modules.
The Studio 5000 Logix Designer application transfers the project to the owner-controller
during the program download. Data is then transferred to the I/O modules either across the
backplane or over an EtherNet/IP network.
The I/O modules can operate immediately after receiving the configuration data.
IMPORTANT This section shows some of the configurable parameters, but it is not a
complete description of how to configure a module.
For more information on how to configure the Compact 5000 analog I/O
modules, see Configure the Module.
Connections
During module configuration, you must choose a connection type in the Module Definition
parameters. A connection is a real-time data transfer link between the owner-controller and
the module that occupies the slot that the configuration references.
During the configuration of a HART I/O module, you must define the input and output tags for
all connected HART devices.
When you download module configuration to a controller, the controller attempts to establish a
connection to each module in the configuration.
Because part of the module configuration includes a slot number in the local or remote
system, the owner-controller verifies the presence of a module, or a connected HART device,
in that slot. If a module or device is detected, the owner-controller sends the configuration
and one of these actions occurs.
• If the configuration is appropriate to the detected module or device, a connection is
made and operation begins.
• If the configuration is not appropriate to the detected module or device, the data is
rejected and the Studio 5000 Logix Designer application indicates an error.
The configuration can be inappropriate for many reasons. For example, a mismatch in
electronic keying that prevents normal operation.
The owner-controller monitors the connection with a module. Any break in the connection, for
example, the loss of power to the system, causes a fault. The Studio 5000 Logix Designer
application monitors the fault status tags to indicate when a fault occurs on a module.
The Connection choice determines what data is exchanged between the owner-controller and
the module.
This table describes the Connection choices that are available in the Module Definition
parameters for local and remote Compact 5000 analog I/O modules.
Description
Connection Type Module Type Compact 5000 I/O Analog Compact 5000 I/O Analog
Input Modules Output Modules
The modules return this data to the owner-controller:
Data with Standard I/O modules • General fault data • General fault data
Calibration • Input data • Output data
• Calibration data • Calibration data
The modules return this data to the owner-controller:
Standard I/O modules • General fault data • General fault data
• Input data • Output data
Data The modules return this data to the owner-controller:
HART I/O modules • General fault data • General fault data
• Input data • Output data
• Calibration data • Calibration data
• When a Listen Only connection is used, another controller owns the
module.
• The listen-only controller establishes communication with the
module but it does not send any configuration or output data to the
module.
• A full input data connection is established between the listen-only
Standard and HART controller, but the controller only listens to the data exchanged
Listen Only remote I/O modules between the owner-controller and the module.
• All other connections to the module, like the connection to the
owner-controller, must also use the Multicast option.
These input and output data types are available to select in the Module Definition parameters.
Module Type Available Data Types
• Analog
HART input modules • Analog and Discrete
• Discrete
HART output modules • Analog
Standard input modules • Analog
• Analog
Standard output modules
• None - only available when you select Listen Only for the Connection type
The Requested Packet Interval (RPI) is a configurable parameter that defines a specific rate at
which data is exchanged between the owner-controller and the module.
Set the RPI value during initial module configuration, you can adjust it as necessary after
module operation has begun. These are the valid RPI values for modules and devices.
• All Compact 5000 analog I/O modules: 0.2…750 ms
• HART devices: 500…9999.9 ms
IMPORTANT If you change the RPI while the project is online, the connection to the module
closes and reopens in one of these ways.
• You inhibit the connection to the module, change the RPI value, and
uninhibit the connection.
• You change the RPI value. In this case, the connection is closed and
reopened immediately after you apply the change to the module
configuration.
For more information on guidelines for specifying RPI rates, see the Logix 5000 Controllers
Design Considerations Reference Manual, publication 1756-RM094.
The Compact 5000 analog I/O modules use one of these methods to transmit data.
Parameter Description
Data is sent to all network devices.
Multicast If you are using the I/O modules in a redundancy system, you must use Multicast.
Unicast (default) Data is sent to one or more controllers depending on module configuration.
Input Module Data Logix 5000 controllers do not poll the Compact 5000 analog input modules for input data.
At the RPI, the module sends input data, like channel and status data, to the controller and the
controller sends data to the module inputs. For example, the controller sends data to that
unlatches or enables alarms.
The data exchange occurs over the system backplane for local modules, and over an
EtherNet/IP network for remote modules.
Data Transmission Type Events that Occur at RPI
1. The input module scans its channels for input data.
Local Input Module to Controller 2. The module sends the data to the system backplane.
3. The controller receives the data immediately.
1. The controller broadcasts the data to the system backplane.
Controller to Local Input Module 2. The module receives the data from the backplane and behaves as dictated
by its configuration.
1. The input module scans its channels for input data.
2. The module sends the data to the remote system backplane.
3. The Compact 5000 I/O EtherNet/IP adapter sends the data over the
EtherNet/IP network.
Remote Input Module to Controller 4. One of these events.
– If the controller is connected directly to the EtherNet/IP network, it
receives the input data immediately.
– If the controller is connected to the EtherNet/IP network through an
adapter, the module sends the data to its backplane and the controller
receives it.
1. One of these events.
– If the controller is connected directly to the EtherNet/IP network, it
broadcasts the data to the network. Skip to step 3.
– If the controller is connected to the EtherNet/IP network via an
EtherNet/IP communication module, the controller transmits the data to
its backplane. Continue to step 2.
Controller to Remote Input Module 2. The EtherNet/IP communication module transmits the data to the
EtherNet/IP network.
3. The Compact 5000 I/O EtherNet/IP adapter receives the data from the
network and transmits it to the remote system backplane.
4. The Compact 5000 analog input module receives the data from the
backplane and behaves as dictated by its configuration.
Output Module Data Logix 5000 controllers send data to Compact 5000 analog output modules at the RPI or after
an Immediate Output (IOT) instruction is executed.
• The RPI defines when the controller sends data to an output module and when the
module sends data to the controller. For example, when the output module sends the
channel data quality.
• The IOT instruction sends new data to an output module whenever it is produced.
IMPORTANT Only CompactLogix 5380 and CompactLogix 5480 controllers can send data to
Compact 5000 analog output modules when an IOT instruction is executed.
Compact GuardLogix 5380 controllers cannot send data when an IOT
instruction is executed.
Compact 5000 analog output modules receive output data from a controller and send data to
the controller. Data is handled differently depending on the type of transmission.
Output Module to Controller Controller to Output Module
• The controller broadcasts data to its local backplane at one
• When a local Compact 5000 analog output of the following:
module receives new data and the requested – RPI
data value is present on the RTB, the output – An IOT instruction is executed.
module sends, or echoes, a data value back to IMPORTANT: An IOT instruction sends data to the output
the controller and to the rest of the control module immediately, and resets the RPI timer.
system. The data value corresponds to the
signal present at its terminals. This feature is • Based on the RPI rate and the length of the controller
called Data Echo. program scan, the output module can receive and send data
multiple times during one program scan.
• The output module also sends other data to the
controller at the RPI. For example, the module • When the RPI is less than the program scan length, the
alerts the controller if a short circuit condition output channels can change values multiple times during a
exists on the module. program scan. The program scan does not need to be
complete before the owner-controller sends data.
The data exchange occurs over the system backplane for local modules, and over an EtherNet/
IP network for remote modules.
Data Transmission Type Events that Occur when Data is Sent
1. The module sends the data to the system backplane.
Local Output Module to Controller
2. The controller receives the data immediately.
1. The controller sends data to the system backplane at the RPI or when an IOT instruction is executed.
Controller to Local Output Module
2. The module receives the data from the system backplane and behaves as dictated by its configuration.
1. The module sends the data to the remote system backplane.
2. The Compact 5000 I/O EtherNet/IP adapter sends the data over the EtherNet/IP network.
Remote Output Module to Controller 3. One of these events.
– If the controller is connected directly to the EtherNet/IP network, it receives the input data immediately.
– If the controller is connected to the EtherNet/IP network through an adapter, the module sends the data to its backplane and
the controller receives it.
1. One of these events.
– If the controller is connected directly to the EtherNet/IP network, it broadcasts the data to the network. Skip to step 3.
– If the controller is connected to the EtherNet/IP network via an EtherNet/IP communication module, the controller transmits
Controller to Remote Output Module the data to its backplane. Continue to step 2.
2. The EtherNet/IP communication module transmits the data to the EtherNet/IP network.
3. The Compact 5000 EtherNet/IP adapter receives the data from the network and transmits it to the remote system backplane.
4. The module receives the data from the backplane and behaves as dictated by its configuration.
Listen Only Connections The owner-controller, as described in Ownership, exchanges data with I/O modules. The
owner-controller owns the module configuration in its Studio 5000 Logix Designer project.
Other controllers, which do not own the module or exchange data with it, can listen to input
data or echoed output data. While the listen-only controller does not own the module
configuration, the module is included in the listen-only controller’s Studio 5000 Logix Designer
project.
In the project for the listen-only controller, select a Listen Only connection type. The
Connection dropdown menu is available on the Module Definition dialog box.
For more information, see Connection Types Available with Compact 5000 I/O Analog Modules.
To establish a Listen Only connection from a listen-only controller, the Connection over
EtherNet/IP must be Multicast in the Studio 5000 Logix Designer project for both the owner-
controller and the listen-only controller.
Module faults and connection request errors occur if the Connection Over EtherNet/IP
connection is not Multicast in both Studio 5000 Logix Designer projects.
Owner-controller Project
Protected Operations Operations that can disrupt the operation of a Compact 5000 analog I/O module are restricted
based on the current module operating mode. This list describes how requests and changes
are handled in each of these circumstances.
• Connection is not established - all requests and changes are accepted
• Connection is established - behavior depends on the request or change
See the following Protected Operation Behavior tables.
• Firmware update is in progress - all requests and changes are rejected
• Calibration is in progress - all requests and changes are accepted
When the request or change is made, the calibration process is automatically aborted.
We recommend that you wait for module calibration to finish before you attempt a
request or change.
A Compact 5000 analog I/O module enters Protection Mode when you establish connection
with the module. The module exits Protection Mode as soon the established connection stops.
Protected Operation Behavior in Protection Mode - Compact 5000 Analog I/O Modules
Request or Change Protection Mode/Connection Established Behavior
Firmware Update request Rejected - The Studio 5000 Logix Designer application attempts the request or
Module Reset request change but it does not take effect, and you receive an alert that it is rejected.
Module Calibration request Accepted if the module is connected and the owner-controller is in Program mode.
from Module Properties
Connection request Accepted if it is a Listen Only connection request.
Accepted when you complete one of these actions.
Configuration change • Change the Module Properties parameters and click Apply.
• Change the Configuration tags and send a Reconfigure Module MSG to the module.
Not allowed - The Studio 5000 Logix Designer application does not attempt the not
Connection or Data Format allowed activities, and you receive an alert that it is not allowed.
change If you are online, the Connection or Data Format fields are disabled in the Module
Definition parameters.
Accepted - The change occurs after the connection is closed and reopened. You can
Electronic Keying change close and reopen the connection in these ways.
• Change the project while it is offline and download the updated project before you
go online again.
• Change the project while it is online and click Apply or OK in the Module Properties
RPI change parameters. In this case, before the change is made, a warning alerts you of the
ramifications before the change is made.
HART Communication The HART protocol supports two-way digital communication, complements traditional
4…20 mA analog signals, and includes these features.
• Predefined commands
- Universal command
- Common practice
- Device specific
• Large installed base
• Worldwide support
HART Protocol(1)
The HART I/O modules support the HART protocol and perform these operations.
• Conversion of 4…20 mA analog signals to digital numeric values in engineering units
(such as kg, m, or percent) that are used in the Logix 5000 controller.
• Conversion of digital numeric values in engineering units to 4…20 mA analog signals to
control process devices.
• Producer/Consumer network communication model directly to each HART device.
• Automatic collection of dynamic process data from the connected HART device. For
example, temperature, pressure, flow, or valve position.
• Automatic collection of device-specific variables from the connected HART device.
• Execution of commands through Studio 5000 Logix Designer application using input
and output tags.
• Facilitation of configuration and troubleshooting of the HART field device from your
control room with FDT/DTM-supported software.
(1) This figure is from the FTD Group at www.fdtgroup.org. All Rights Reserved.
Letter Description
A Primary device
B Handheld communicator as secondary device
C Field device
An example application is a HART enabled mass flowmeter. The standard mA signal from the
flowmeter provides one primary measurement: flow. With the HART protocol, more process
information is provided. You can set the HART configuration of the flowmeter to communicate
the primary variable (PV), secondary variable (SV), tertiary variable (TV), and quaternary
variable (QV). These values can represent mass flow, static pressure, temperature, total flow,
and other conditions.
HART I/O Modules and The HART I/O modules have built-in HART modems, so there is no need to install external HART
multiplexers or clip-on HART modems. The modules have separate HART modems for each
Devices channel.
HART I/O modules provide a connection between the controller and each HART device. A HART
device that is connected to a HART I/O module supports configurable connections and
configurable message instructions.
HART Device Limits
5069-IF4IH,
Number of… 5069-OF4IH
Device variables 8
Dynamic variables 4
HART commands 4
Unconnected message instructions per device 2
Connected message instructions per device 2
Topic Page
Software Configurable 32
Module Data Quality Reporting 32
Fault and Status Reports 33
Inhibit a Module 33
Electronic Keying 34
Module Firmware 34
Producer/Consumer Communication 35
Rolling Time Stamp of Data 35
Floating Point Data Format 35
Calibration 36
Alarm Latching 36
Scaling 37
Data Offset 38
Module Accuracy 38
Use CIP Sync Time with HART I/O Modules 39
Compact 5000® analog I/O modules convert analog signals and digital values. The HART I/O
modules also decode HART information from signals embedded within the channel.
Module Type Converts Supports
• Volts
• Millivolts
Standard analog input modules
• Milliamps
Analog signals to digital values • Ohms
• Volts
HART input modules
• Milliamps
HART input modules that are configured to • Digital input device
support digital input signals for channel-to- – • IEC 61131-2 Type 3-d
channel isolation digital input device
• Volts
All analog output modules Digital values to analog signals
• Milliamps
Software Configurable The Studio 5000 Logix Designer® application provides an interface to configure each module.
All module features are enabled or disabled through the I/O configuration within the software.
All module features are enabled or disabled through the I/O configuration in the Studio 5000
Logix Designer application. You can use the Studio 5000 Logix Designer application to retrieve
the following information from any module in the system:
• Serial number
• Firmware revision information
• Product code
• Vendor
• Error and fault information
• Diagnostic information
By minimizing the need for tasks, such as setting hardware switches and jumpers, the
software makes module configuration easier and more predictable.
Module Data The Compact 5000 analog I/O modules indicate the quality of channel data that is returned to
the owner-controller. Data quality represents accuracy. Levels of data quality are reported via
Quality Reporting module input tags.
Fault and Status Reports The Compact 5000 analog I/O modules report fault and status data along with channel data.
Fault and status data is reported in these ways.
• Studio 5000 Logix Designer application
• Module status indicators
• I/O status indicators
For more information on fault and status reports, see these sections.
• 5069-IF8 module - Fault and Status Reports
• 5069-IY4 and 5069-IY4K modules - Fault and Status Reports
• 5069-OF4, 5069-OF4K, and 5069-OF8 modules - Fault and Status Reports
• HART I/O modules - Fault and Status Reports
• Troubleshoot the Module
Inhibit a Module When you inhibit a module you indefinitely suspend a connection, including Listen Only
connections, between an owner-controller and an analog module without removing the module
from the configuration. This process lets you temporarily disable a module, such as to perform
maintenance.
IMPORTANT Once a HART I/O module is inhibited, the connections to the module and
attached HART devices are also closed and the CIP™ messaging to the HART
devices is disabled.
IMPORTANT When you inhibit an output module that has ProgMode enabled, it enters
Program mode, and all outputs change to the state configured for Program
mode.
For example, if an output module is configured so that the state of the
outputs transition to zero during Program mode, whenever that module is
inhibited, the outputs transition to zero.
Electronic Keying Electronic Keying reduces the possibility that you use the wrong device in a control system. It
compares the device that is defined in your project to the installed device. If keying fails, a
fault occurs. These attributes are compared.
Attribute Description
Vendor The device manufacturer.
Device Type The general type of the product, for example, digital I/O module.
Product Code The specific type of the product. The Product Code maps to a catalog number.
Major Revision A number that represents the functional capabilities of a device.
Minor Revision A number that represents behavior changes in the device.
Carefully consider the implications of each keying option when selecting one.
IMPORTANT If you change the Electronic Keying parameters while the project is online,
you interrupt connections to the device and any devices that are
connected through the device. Connections from other controllers can also
be broken.
If an I/O connection to a device is interrupted, the result can be a loss of
data.
For more detailed information on Electronic Keying, see the Logix 5000® Control Systems
Application Technique, publication LOGIX-AT001.
Module Firmware The Compact 5000 analog I/O modules are manufactured with module firmware installed. If
updated module firmware revisions are available in the future, you can update the firmware.
Updated firmware revisions are made available for various reasons, for example, to correct an
anomaly that existed in previous module firmware revisions.
Download updated firmware files from the Rockwell Automation® Product Compatibility and
Download Center (PCDC) at rok.auto/pcdc.
Producer/Consumer Compact 5000 analog I/O modules use the Producer/Consumer communication model to
produce data before a controller polls them. The modules produce the data and the controllers
Communication consume the data. That is, the owner-controller and controllers with a Listen Only connection
to the module can consume it.
When an input module produces data, the controllers can consume the data simultaneously.
Simultaneous data consumption removes the need for one controller to send the data to other
controllers.
IMPORTANT Keep in mind, only one controller can own the I/O module. The Compact
5000 analog I/O modules do not support multiple owners of the same
module.
Other controllers must use a Listen Only connection to the module.
Rolling Time Stamp of Data The rolling time stamp is a 15-bit timer that runs continuously and counts in milliseconds from
0…32,767 ms.
The rolling time stamp value is reported in the I.Chxx.RollingTimestamp tag for the Compact
5000 analog I/O modules.
Module Type Description
Typically, the analog input modules scan their inputs at the RPI. The module also updates the
rolling time stamp data at the RPI. The controller program uses the last two rolling time
stamp values to calculate the amount of time between the samples.
Analog input A system time change can cause a slight change in input sample timing. The rolling time
stamp accurately reflects the change.
There can be jitter in the timing between samples before and after the system time change.
For the analog output modules, the rolling time stamp value is updated only when new values
Analog output are applied to the Digital to Analog Converter (DAC).
Floating Point Data Format The Compact 5000 analog I/O modules return channel data to the controller in the IEEE 32-bit
floating point data format. In your Studio 5000 Logix Designer application, the data type is
REAL.
The floating point data format lets you change the data representation of the selected
channel. Although the full range of the module does not change, you can scale your module to
represent I/O data in specific terms for your application.
Calibration The Compact 5000 analog I/O modules use precise analog components that maintain their
specifications over time. The modules are calibrated via the following methods:
• Factory calibration when the modules are built.
• User-executed calibration.
Grouped inputs share an Analog-to-Digital converter. As a result, during the calibration of any
input channel, the I.Chxx.Uncertain tag is set to 1 for the other input channels in that group.
This change happens because the data sample rate slows for all input channels in the group.
The Notch Filter settings remain the same for the other input channels in the group.
Alarm Latching When enabled, Alarm Latching lets you latch a module alarm in the set position once the alarm
is triggered. The alarm remains set even if the condition that caused it to occur disappears,
until the alarm is unlatched.
Alarm latching is available on a per channel basis. You can latch the following alarms:
• Input modules - Process and Rate alarms
• Output modules - Clamp and Rate alarms
Enable Latching
To enable alarm latching, see these sections.
• Module Properties:
- Input modules - Alarms
- Output modules - Limits
• Module and Device Tags - The alarm type determines which tag to change.
Unlatch Alarms
IMPORTANT Before you unlatch an alarm, make sure the condition that triggered the
alarm no longer exists.
Once an alarm is latched, you must manually unlatch it. You can use the module tags to
unlatch an alarm. The alarm type determines which module tag to change.
For example, to unlatch a Low Low alarm on a Compact 5000 analog input module, you set the
Chxx.LLAlarmUnlatch output tag to 1.
Scaling When you scale a channel, you select two points that represent signal units, that is, a Low
Signal and a High Signal. You also select two points that represent engineering units, that is,
Low Engineering and High Engineering.
The Low Signal point equates to the Low Engineering point and the High Signal point matches
the High Engineering point.
IMPORTANT When you choose the two points for the low and high value of your
application, you do not limit the range of the module. The module range
remains constant regardless of how you scale it.
Scaling lets you configure the module to return data to the controller in signal units or in
engineering units. It is listed as Percent of Full Scale in the Studio 5000 Logix Designer
application.
For example, if you use the 5069-IF8 module in Current mode with an input range of 4…20 mA,
use one of these configurations.
To receive values in
Parameter
Signal Units Percent of Full Scale
Low Signal 4 mA 4 mA
High Signal 20 mA 20 mA
Low Engineering 4 EU 0%
High Engineering 20 EU 100%
The following table shows the values that can occur when you use Percent of Full Scale.
Engineering Units Value Value in I.Chxx.Data Tag
Current
Standard I/O Modules HART I/O Modules Standard I/O Modules HART I/O Modules
3.0 mA -6.00% -6.25% -6.00 -6.25
4.0 mA 0.0% 0.00
12.0 mA 50.0% 50.0
20.0 mA 100.0% 100.0
23.0 mA 118.75% 118.75
Data Offset The Compact 5000 analog I/O modules support offset features that compensate for any
inaccuracy inherent to the input or output device that is connected to the channel. The offset
value adjusts the input or output data value.
Module Accuracy Module accuracy represents the module accuracy when its ambient temperature is the same
as the temperature at which the module was calibrated.
The level of module accuracy remains 0.10% whether it is operating in Current, Voltage, RTD,
or Thermocouple mode. Only the 5069-IY4 and 5069-IY4K modules support the RTD or
Thermocouple modes.
The module accuracy drift with temperature varies by module and the mode being used. The
following table lists module accuracy drift values.
Module Accuracy Drift with Temperature
Cat. No.
Voltage Current RTD Thermocouple
5069-IF8 0.2% 0.3% –
5069-IY4, 5069-IY4K 0.2% 0.3% 0.2% 0.2%
5069-OF4, 5069-OF4K, 5069-OF8 0.3% 0.5% –
5069-IF4IH, 5069-OF4IH 0.1% –
Use CIP Sync Time with CIP Sync is a CIP™ implementation of the IEEE 1588 PTP (Precision Time Protocol). CIP Sync
provides accurate Real-World Time (real-time) or Universal Coordinated Time (UTC)
HART I/O Modules synchronization of controllers and devices that are connected over CIP networks. This
technology supports highly distributed applications that require time stamps, a sequence of
recorded events, distributed motion control, and increased control coordination.
The HART I/O modules are CIP Sync follower-only devices. There must be another module on
the network that functions as a leader clock. For more information on how to use CIP Sync
technology, see the Integrated Architecture® System and CIP Sync Configuration Application
Technique, publication IA-AT003.
Notes:
Topic Page
Analog Device Support 42
Multiple Input Ranges 42
Notch Filter 43
Digital Filter 45
Underrange/Overrange Detection 46
Process Alarms 47
Rate Alarm 49
Sensor Offset 49
Open Wire Detection 49
Over Temperature Detection 49
Fault and Status Reports 50
The 5069-IF8 input module has eight non-isolated channels that are either differential
(Series A) or single-ended (Series B). Each channel supports connection to the following
input types:
• Current
• Voltage
Differential inputs have a greater resistance to the effects of electromagnetic noise and
provide improved cable length flexibility when you wire the module. Single-ended inputs
provide improved flexibility in wiring configuration.
Analog Device Support The 5069-IF8 module does not support connection to all analog devices. This table lists the
analog devices that the 5069-IF8 module supports.
IMPORTANT Verify that the channel configuration in your Studio 5000 Logix Designer project matches the input device type that is
connected to the channel. Choose the input type on the Channels page in the Module Properties.
For example, if a current input device is connected to channel 0 on the module, the channel configuration must be
Input Type = Current.
Current
For more information on how to wire devices to the 5069-IF8 modules, see the Compact 5000
I/O Modules and EtherNet/IP™ Adapters Specification Technical Data, publication 5069-TD001.
Multiple Input Ranges The 5069-IF8 module supports multiple input ranges. The input type that you choose during
module configuration determines the available input ranges. An input type is chosen on a
channel-by-channel basis.
Input Type Available Input Range
• 0…20 mA
Current (mA)
• 4…20 mA
• -10…10V
Voltage (V) • 0…5V
• 0…10V
Notch Filter The Notch Filter is a built-in feature of the Analog-to-Digital converter (ADC) that removes line
noise in your application. The removal of line noise is also known as noise immunity. The
Notch Filter attenuates the input signal at the specified frequency.
Select a Notch Filter based on what noise frequencies are present in the operating
environment and what sample requirements are needed for control. For example, if the Notch
Filter setting is 60 Hz, the 60 Hz AC line noise and the associated overtones are removed.
Available Notch Filter Settings
• 5 Hz • 100 Hz • 10,000 Hz
• 10 Hz • 200 Hz • 15,625 Hz
• 15 Hz • 500 Hz • 25,000 Hz
• 20 Hz • 1000 Hz • 31,250 Hz
• 50 Hz • 2500 Hz • 62,500 Hz
• 60 Hz • 5000 Hz
If you filter lower frequency noise, you get a slower input sample rate.
In this table, each Notch Filter setting has two recommended minimum module RPI values that
allow the required time to collect samples from each channel. One setting provides faster
sample speed and the other provides slightly better resolution at slower sample speeds.
Recommended Minimum Module RPI Value
Application with All Channels Enabled and the
Notch Filter Application with Only One Channel Enabled Same Notch Filter Setting on All Channels
Faster Sample Speed Better Noise Rejection Faster Sample Speed Better Noise Rejection
5 Hz 215 ms 635 ms 750 ms(1) —
10 Hz 110 ms 320 ms 440 ms —
15 Hz 65 ms 195 ms 260 ms —
20 Hz 60 ms 165 ms 240 ms 660 ms
50 Hz 25 ms 70 ms 100 ms 280 ms
60 Hz (default) 20 ms 60 ms 80 ms 240 ms
100 Hz 15 ms 35 ms 60 ms 140 ms
200 Hz 10 ms 20 ms 40 ms 80 ms
500 Hz 5 ms 10 ms 20 ms 40 ms
1000 Hz 2 ms 5 ms 8 ms 20 ms
2500 Hz 1.5 ms 2.5 ms 6 ms 10 ms
5000 Hz 1 ms 2 ms 4 ms 8 ms
10,000 Hz 0.8 ms 1 ms 3.2 ms 4 ms
15,625 Hz 0.8 ms 0.9 ms 3.2 ms 3.5 ms
25,000 Hz 0.8 ms 0.8 ms 3.2 ms 3.2 ms
31,250 Hz 0.8 ms 0.8 ms 3.2 ms 3.2 ms
62,500 Hz — 0.7 ms — 2.8 ms
(1) If you use the 5 Hz Notch Filter setting with four or more channels, the input data cannot be refreshed at every RPI, even if
the maximum RPI allowed is used. Instead, fresh data is delivered approximately every other RPI.
The eight input channels on the 5069-IF8 module are grouped into two groups; channels
00…03 are grouped, and channels 04…07 are grouped. When you determine the recommended
minimum module RPI value, remember these items.
• The channel groups determine the recommended minimum module RPI value.
• If any channel in the other group is enabled, 0.2 ms is added to the recommended
minimum RPI rate for all enabled channels in each group.
• The recommended minimum RPI rates for all enabled channels are combined to
produce the recommended minimum module RPI for the group.
• If the groups have different recommended minimum RPI values, use the higher RPI
value when you configure the module.
Digital Filter The Digital Filter is a first-order lag filter. It smooths input data noise transients on each input
channel. This value specifies the time constant for a digital, first-order lag filter on the input.
The input is 63% of the step change after the first time constant elapses.
120
100
80
Amplitude %
60
40
Unfiltered Input
TA = 100 ms
20
TA = 500 ms
TA = 990 ms
0
0 100 200 300 400 500 600 700 800 900 1000 1100 1200
Time in Milliseconds
The filter value is specified in units of milliseconds. A value of 0 (zero) disables the filter. The
digital filter equation is as shown.
Δt * (Xn - Yn-1)
Yn = Yn-1 +
Δ t + TA
Underrange/Overrange Underrange/Overrange Detection detects when the 5069-IF8 module is operating beyond
limits set by the input range.
Detection
The module can read input signal levels outside the low and high signal values for each input
range. The signal limits to which the module can read are thresholds. Only when the signal is
beyond a threshold is an underrange or overrange condition that is detected and indicated.
For example, if you configure a 5069-IF8 module channel to use the + 10V input range, an
overrange condition does not exist until the input signal exceeds 12V.
This table lists the input ranges of the 5069-IF8 module and the thresholds in each range
before the module detects an underrange/overrange condition.
Input Type Range Underrange Threshold Overrange Threshold Deadband
0…20 mA ≤ -0.07 mA
Current ≥ 23.00 mA 0.07 mA
4…20 mA ≤ 3 mA
±10.00V ≤ -12.00V ≥12.00V 0.04V
Voltage 0…5V ≤ -0.02V ≥ 6.00V 0.02V
0…10V ≤ -0.04V ≥ 12.00V 0.04
• The Deadband Value is the amount of change past the threshold that is required for the alarm condition to
clear. For example, if a module uses a Current input type in the 4…20 mA range and the signal value goes below
3 mA, the underrange condition is triggered. Due to the 0.07 mA deadband, the condition is not cleared until the
signal value reaches 3.07 mA. For more information, see Alarm Deadband.
• When the underrange is set at < 3 mA, the I:Chxx.Data tag reports values as low as 0.0 mA. The condition is
clamped when the signal reaches 3 mA.
IMPORTANT The Disable All Alarms feature does not disable the Underrange/Overrange
Detection feature because underrange/overrange detection is not an
alarm.
To disable the Underrange/Overrange detection feature, you must disable
the channel.
Process Alarms Process alarms alert you when the module has exceeded configured high or low limits for
each channel. This list is the user-configurable alarm trigger points.
• High high
• High
• Low
• Low low
To use the Process Alarms, you must complete the following tasks:
• Enable the alarms
• Configure the trigger points
For example, consider a channel that uses the Current input type, the 4 mA…20 mA input
range, and scales the High and Low Engineering values of 100 and 0, respectively. The
available Process Alarm values range from 0…100.
In this case, if the High Limit alarm is set to 50 EU, when the input signal reaches 12 mA, the
High Limit alarm is set. The alarm is set because Scaling was configured for Percentage of Full
Scale and a signal value of 12 mA is 50% of the full scale of engineering units.
Latch Alarms
Select the Latch Process Alarms checkbox on the Alarms tab to latch the process alarms. To
latch Process Alarms, see Alarms.
Unlatch Alarms
IMPORTANT Before you unlatch an alarm, make sure the condition that triggered the
alarm no longer exists.
Once an alarm is latched, you must manually unlatch it. To unlatch an alarm, toggle the output
tag for that alarm from 0 to 1. Use these tags to unlatch alarms.
• O.Chxx.LLAlarmUnlatch
• O.Chxx.LAlarmUnlatch
• O.Chxx.HAlarmUnlatch
• O.Chxx.HHAlarmUnlatch
• O.Chxx.RateAlarmUnlatch
IMPORTANT You must toggle the tag from 0 to 1 to unlatch the alarm each time it is
triggered.
You must also toggle the tag back to 0 after the alarm is unlatched.
If you do not change the tag back to 0 and the alarm is latched again in the
future, the alarm remains latched despite the tag value being 1.
Alarm Deadband
You can set an alarm deadband when you configure the process alarms. If the alarm condition
is removed, the alarm status bit remains set as long as the input data stays within the
deadband of the alarm.
This graphic shows input data that sets each of the alarms during module operation. In this
example, a deadband is set and alarm latching is disabled, so each alarm turns Off when the
condition that caused it to turn On is removed and the input data exits the deadband.
Alarm Deadband Example
High high
High
= Deadband
Input data = Alarm turns on
= Related alarm turns off
Low
Low low
Also, the High alarm remains On during the High high alarm, and the Low alarm remains On
during the Low low alarm.
To to set the alarm deadband, see Alarms.
Rate Alarm The Rate Alarm defines the maximum rate of change between input samples in engineering
units per second. If the Rate Alarm Limit is exceeded, the I.Chxx.RateAlarm tag is set to 1.
You can enable or disable Rate Alarm Latching on each channel. To enable the Rate Alarm,
see Alarms.
We suggest that you unlatch the Rate Alarm only after the rate of change between input
samples has returned to below the Rate Alarm Limit value.
Sensor Offset The Sensor Offset compensates for any known error on the sensor or channel to which the
sensor is connected. The value is set in signal units and is added to the data value.
For example, consider an application that uses the Current input type with the 4…20 mA range
and scaling at 0…100%. If a sensor has an error and the channel consistently reports current
signal values by 0.2 mA lower than the actual value, you must set Sensor Offset to 1.25%.
You must use the O.Chxx.SensorOffset tag to set the Sensor Offset. In the example above, the
O.Chxx.SensorOffset tag = 1.25.
Open Wire Detection Open Wire Detection indicates when a wire is disconnected from the channel.
IMPORTANT The Disable All Alarms feature does not disable the Open Wire Detection
feature because Open Wire Detection is not an alarm.
To disable the Open Wire Detection feature, you must clear the Open Wire
Detection checkbox in the module configuration.
Over Temperature The Over Temperature Detection feature indicates if the temperature of the environment
within which the module is operating is higher than the module operating limits.
Detection
IMPORTANT Each module detects an ambient temperature that varies and is dependent on
how it is loaded and mounted, and the configuration conditions.
IMPORTANT The Disable All Alarms feature does not disable the Over Temperature
Detection feature because Over Temperature Detection is not an alarm.
Fault and Status Reports The 5069-IF8 module sends fault and status data with channel data to the owner-controller
and listen-only controllers. The data is returned via module tags that you can monitor in your
Studio 5000 Logix Designer application.
With some exceptions, the 5069-IF8 module provides the fault and data status in a channel-
specific format. In this table, the tag names that include Chxx represent channel-specific data,
where xx is the channel number.
Fault Tags - 5069-IF8
Tag Name Triggering Event That Sets Tag
ConnectionFaulted The owner-controller loses its connection to the module. This tag provides module-wide data and affects all channels simultaneously.
Chxx.Fault The channel data quality is bad.
One of these conditions.
Chxx.OpenWire • The channel uses a Voltage input type in any input range and the input signal value reaches full-scale.
• The channel uses a Current input type in any input range and the input signal goes below 100 µA.
The input signal at the channel is below 100 µA.
Chxx.Underrange The channel data is beneath the absolute minimum for this channel.
Chxx.Overrange The channel data is above the absolute maximum for this channel.
Chxx.OverTemperature The module is at a higher temperature than its rated operating limits.
Topic Page
Analog Device Support 52
Multiple Input Ranges 54
Multiple Temperature Units 54
Notch Filter 55
Digital Filter 57
Underrange/Overrange Detection 58
Process Alarms 59
Rate Alarm 61
Sensor Types 62
Sensor Offset 64
10 Ohm Copper Offset 64
Open Wire Detection 64
Over Temperature Detection 65
Cold Junction Compensation 65
Fault and Status Reports 66
The 5069-IY4 and 5069-IY4K input modules have four differential, non-isolated channels. Each
channel supports connection to these types.
• Current
• Voltage
• RTD
• Thermocouple
Differential inputs have a greater resistance to the effects of electromagnetic noise and
provide improved flexibility regarding cable length when wiring your module.
Analog Device Support The 5069-IY4 and 5069-IY4K modules do not support connection to all analog devices. This
table lists the analog devices that the 5069-IY4 and 5069-IY4K modules support.
IMPORTANT Make sure that the channel configuration in your Studio 5000 Logix Designer project matches the input device type that
is connected to the channel. Choose the input type on the Channels page in the Module Properties.
For example, if a current input device is connected to channel 0 on the module, the channel configuration must be
Input Type = Current.
Current
Yes
In this example, voltage devices are connected to channels 0 and 1.
Voltage
2-wire analog device
4-wire analog device(1)
RTD Yes
2-wire RTD device In this example, a current device is connected to channel 0, a voltage device is
3-wire RTD device connected to channel 1, an RTD is connected to channel 3, a thermocouple is
connected to channel 4.
Thermocouple Yes
For more module configuration information, see Configure the Module Parameters.
For more information on how to wire devices to the 5069-IY4 and 5069-IY4K modules, see the
Compact 5000 I/O Modules and EtherNet/IP™ Adapters Specification Technical Data,
publication 5069-TD001.
Multiple Input Ranges The 5069-IY4 and 5069-IY4K modules offer multiple input ranges. The input type that you
choose during module configuration determines the available input ranges.
For the RTD input type, the sensor type that you choose determines the available input ranges.
The Studio 5000 Logix Designer application automatically sets the Input Range to the valid
setting after you select a sensor type.
Input Type Sensor Type Available Input Ranges
One of the following:
Current (mA) — • 0…20 mA
• 4…20 mA
One of the following:
• -10…10V
Voltage (V) —
• 0…5V
• 0…10V
100 Ω PT 385 1…500 Ω
200 Ω PT 385 2…1000 Ω
500 Ω PT 385 4…2000 Ω
1000 Ω PT 385 8…4000 Ω
100 Ω PT 3916 1…500 Ω
200 Ω PT 3916 2…1000 Ω
500 Ω PT 3916 4…2000 Ω
RTD
1000 Ω PT 3916 8…4000 Ω
10 Ω CU 427 1…500 Ω
120 Ω NI 672 1…500 Ω
100 Ω NI 618 1…500 Ω
120 Ω NI 618 1…500 Ω
200 Ω NI 618 2…1000 Ω
500 Ω NI 618 4…2000 Ω
mV or any
Thermocouple -100…+100 mV
Thermocouple type
Multiple Temperature Units You can use these temperature units with the 5069-IY4 and 5069-IY4K modules.
• Celsius
• Kelvin
• Fahrenheit
• Rankine
• Custom
Notch Filter The Notch Filter is a built-in feature of the Analog-to-Digital converter (ADC) that removes line
noise in your application. The removal of line noise is also known as noise immunity.
The Notch Filter attenuates the input signal at the specified frequency.
Select a Notch Filter based on what noise frequencies are present in the operating
environment and what sample requirements are needed for control. For example, if the Notch
Filter setting is 60 Hz, the 60 Hz AC line noise and the associated overtones are removed.
Available Notch Filter Settings
• 5 Hz • 100 Hz • 10,000 Hz
• 10 Hz • 200 Hz • 15,625 Hz
• 15 Hz • 500 Hz • 25,000 Hz
• 20 Hz • 1000 Hz • 31,250 Hz
• 50 Hz • 2500 Hz • 62,500 Hz
• 60 Hz • 5000 Hz
If you filter lower frequency noise, you get a slower input sample rate.
To set the notch filter, see Chxx.
In this table, each Notch Filter setting has two recommended minimum module RPI values that
allow the required time to collect samples from each channel. One setting provides faster
sample speed and the other provides slightly better resolution at slower sample speeds.
Recommended Minimum Module RPI Value
Application with All Channels Enabled and the
Notch Filter Application with Only One Channel Enabled
Same Notch Filter Setting on All Channels
Faster Sample Speed Better Noise Rejection Faster Sample Speed Better Noise Rejection
5 Hz 215 ms 635 ms 750 ms(1) —
10 Hz 110 ms 320 ms 440 ms —
15 Hz 65 ms 195 ms 260 ms —
20 Hz 60 ms 165 ms 240 ms 660 ms
50 Hz 25 ms 70 ms 100 ms 280 ms
60 Hz (default) 20 ms 60 ms 80 ms 240 ms
100 Hz 15 ms 35 ms 60 ms 140 ms
200 Hz 10 ms 20 ms 40 ms 80 ms
500 Hz 5 ms 10 ms 20 ms 40 ms
1000 Hz 2 ms 5 ms 8 ms 20 ms
2500 Hz 1.5 ms 2.5 ms 6 ms 10 ms
5000 Hz 1 ms 2 ms 4 ms 8 ms
10,000 Hz 0.8 ms 1 ms 3.2 ms 4 ms
15,625 Hz 0.8 ms 0.9 ms 3.2 ms 3.5 ms
25,000 Hz 0.8 ms 0.8 ms 3.2 ms 3.2 ms
31,250 Hz 0.8 ms 0.8 ms 3.2 ms 3.2 ms
62,500 Hz — 0.7 ms — 2.8 ms
(1) If you use the 5 Hz Notch Filter setting with four channels, the input data cannot be refreshed at every RPI, even if the
maximum RPI allowed is used. Instead, fresh data is delivered approximately every other RPI.
When input channels on the same module use different Notch Filter selections, the
recommended minimum RPI rates for all enabled channels are combined to produce the
recommended minimum module RPI.
Digital Filter The Digital Filter is a first-order lag filter. It smooths input data noise transients on each input
channel. This value specifies the time constant for a digital, first-order lag filter on the input.
The input is 63% of the step change after the first time constant elapses.
120
100
80
Amplitude %
60
40
Unfiltered Input
TA = 100 ms
20
TA = 500 ms
TA = 990 ms
0
0 100 200 300 400 500 600 700 800 900 1000 1100 1200
Time in Milliseconds
The filter value is specified in units of milliseconds. A value of 0 (zero) disables the filter. The
digital filter equation is as shown.
Δt * (Xn - Yn-1)
Yn = Yn-1 +
Δ t + TA
Underrange/Overrange Underrange/Overrange Detection detects when the 5069-IY4 or 5069-IY4K module is operating
beyond limits set by the input range.
Detection
The module can read input signal levels outside the low and high signal values for each input
range. The signal limits to which the module can read are thresholds. Only when the signal is
beyond a threshold is an underrange or overrange condition that is detected and indicated.
For example, if a 5069-IY4 module channel uses the + 10V input range, an overrange condition
does not exist until the input signal is greater than 12V.
Input Ranges, Sensor Types, and Thresholds
Underrange Overrange
Input Type Range or Sensor Type Threshold Threshold Deadband(1)
0…20 mA ≤ -0.07 mA
Current ≥ 23.00 mA 0.07 mA
4…20 mA ≤ 3 mA(2)
±10.00V ≤ -12.00V ≥12.00V 0.04V
Voltage 0…5V ≤ -0.02V ≥ 6.00V 0.02V
0…10V ≤ -0.04V ≥ 12.00V 0.04
≤ -200 °C ≥ 870 °C
≤ -328 °F ≥ 1598 °F
Pt385
≤ 73 °K ≥ 1143 °K
≤ 132 °R ≥ 2058 °R
≤ -200 °C ≥ 630 °C
≤ -328 °F ≥ 1166 °F
Pt3916
≤ 73 °K ≥ 903 °K
≤ 132 °R ≥ 1626 °R
≤ -200 °C ≥ 260 °C
≤ -328 °F ≥ 500 °F
RTD Cu427 —
≤ 73 °K ≥ 533 °K
≤ 132 °R ≥ 960 °R
≤ -80 °C ≥ 320 °C
≤ -112 °F ≥ 608 °F
Ni672
≤ 193 °K ≥ 593 °K
≤ 348 °R ≥ 1068 °R
≤ -60 °C ≥ 250 °C
≤ -76 °F ≥ 482 °F
Ni618
≤ 213 °K ≥ 523 °K
≤ 384 °R ≥ 942 °R
≤ 21 °C ≥ 1820 °C
≤ 68 °F ≥ 3308 °F
B
≤ 293 °K ≥ 2093 °K
≤ 528 °R ≥ 3768 °R
≤ 0.00 °C ≥ 2320 °C
≤ 32 °F ≥ 4208 °F
C
≤ 273 °K ≥ 2593 °K
≤ 492 °R ≥ 4668 °R
≤ -270 °C ≥ 1000 °C
≤ -454 °F ≥ 1832 °F
E
≤ 3 °K ≥ 1273 °K
≤ 6 °R ≥ 2292 °R
≤ -210 °C ≥ 1200 °C
≤ -346 °F ≥ 2192 °F
Thermocouple J —
≤ 63 °K ≥ 1473 °K
≤ 114 °R ≥ 2652 °R
≤ -270 °C ≥ 1372 °C
≤ -454 °F ≥ 2502 °F
K
≤ 3 °K ≥ 1645 °K
≤ 6 °R ≥ 2961 °R
≤ -270 °C ≥ 1300 °C
≤ -454 °F ≥ 2372 °F
N
≤ 3 °K ≥ 1573 °K
≤ 6 °R ≥ 2832 °R
≤ -50 °C ≥ 1768 °C
≤ -58 °F ≥ 3215 °F
R
≤ 223 °K ≥ 2041 °K
≤ 402 °R ≥ 3674 °R
IMPORTANT The Disable All Alarms feature does not disable the underrange/overrange
detection feature.
The Disable All Alarms feature disables alarms on the module. Underrange/
Overrange detection is not an alarm. It is an indicator that channel data has
gone beyond the absolute maximum or minimum, respectively, for the
channel range.
To disable the Underrange/Overrange detection feature, you must disable
the channel.
Process Alarms Process alarms alert you when the module has exceeded configured high or low limits for
each channel. This is a list of the user-configurable alarm trigger points.
• High high
• High
• Low
• Low low
Process Alarm trigger points are related to the Scaling parameters that you configure for the
channel. The engineering units that are established in Scaling determine the Process Alarm
trigger points. That is, the available trigger point values can be in signal units or engineering
units.
For example, consider a channel that uses the Current input type, the 4 mA…20 mA input
range, and scales the High and Low Engineering values of 100 and 0, respectively. The
available Process Alarm values range from 0…100.
In this case, if the High Limit alarm is set to 50 EU, when the input signal reaches 12 mA, the
High Limit alarm is set. The alarm is set because Scaling was configured for Percentage of Full
Scale and a signal value of 12 mA is 50% of the full scale of engineering units.
Latch Alarms
Select the Latch Process Alarms checkbox on the Alarms page to latch the process alarms. For
more information, see Alarms.
Unlatch Alarms
IMPORTANT Before you unlatch an alarm, make sure the condition that triggered the
alarm no longer exists.
Once an alarm is latched, you must manually unlatch it. To unlatch an alarm, toggle the output
tag for that alarm from 0 to 1. Use these tags to unlatch alarms.
• O.Chxx.LLAlarmUnlatch
• O.Chxx.LAlarmUnlatch
• O.Chxx.HAlarmUnlatch
• O.Chxx.HHAlarmUnlatch
• O.Chxx.RateAlarmUnlatch
IMPORTANT You must toggle the tag from 0 to 1 to unlatch the alarm each time it is
triggered.
You must also toggle the tag back to 0 after the alarm is unlatched.
If you do not change the tag back to 0 and the alarm is latched again in the
future, the alarm remains latched despite the tag value being 1.
For more information on how to use the module tags, see Module and Device Tags.
Alarm Deadband
You can set an alarm deadband when you configure the process alarms. If the alarm condition
is removed, the alarm status bit remains set as long as the input data stays within the
deadband of the alarm.
This graphic shows input data that sets each of the alarms during module operation. In this
example, a deadband is set and alarm latching is disabled, so each alarm turns Off when the
condition that caused it to turn On is removed and the input data exits the deadband.
Alarm Deadband Example
High high
High
= Deadband
Input data = Alarm turns on
= Related alarm turns off
Low
Low low
Also, the High alarm remains On during the High high alarm, and the Low alarm remains On
during the Low low alarm.
To to set the alarm deadband, see Alarms.
Rate Alarm The Rate Alarm defines the maximum rate of change between input samples in engineering
units per second. If the Rate Alarm Limit is exceeded, the I.Chxx.RateAlarm tag is set to 1.
You can enable or disable Rate Alarm Latching on each channel. To enable the Rate Alarm, see
Alarms.
To unlatch the alarm, toggle the O.Chxx.RateAlarmUnlatch tag to 1.
You can unlatch the alarm at any point in the system operation. If you change the unlatch tag
to 1 and the triggering condition remains, the alarm is immediately latched again.
We suggest that you unlatch the Rate Alarm only after the rate of change between input
samples has returned below the Rate Alarm Limit value.
Sensor Types This module supports multiple sensor types. The input type configuration dictates the
available selections.
Input Type Available Sensor Types
100 Ω PT 385 200 Ω PT 3916 100 Ω NI 618
200 Ω PT 385 500 Ω PT 3916 120 Ω NI 618
RTD 500 Ω PT 385 1000 Ω PT 3916 200 Ω NI 618
1000 Ω PT 385 10 Ω CU 427 500 Ω NI 618
100 Ω PT 3916 120 Ω NI 672
Thermocouple B, C, D, E, J, K, N, R, S, T, TXK/XK (L)
The choices that are made during module configuration for the following parameters
determine Sensor Type temperature limits:
• Input Type
• Sensor Type
• Temperature Units
To set the parameters that affect the temperature limits, see Chxx.
IMPORTANT When you configure the Input Type, Sensor Type, and Temperature Units,
the Scaling parameters are automatically set on the Chxx page in the
Module Properties. They cannot be changed manually.
The Low Signal value equals the Low Engineering value. The High Signal
value equals the High Engineering value.
Sensor Offset The Sensor Offset compensates for any known error on the sensor or channel to which the
sensor is connected. The value is set in signal units and is added to the data value.
For example, consider an application that uses the Current input type with the 4…20 mA range
and scaling at 0…100%. If a sensor has an error and the channel consistently reports current
signal values by 0.2 mA lower than the actual value, you must set Sensor Offset to 1.25%.
You must use the O.Chxx.SensorOffset tag to set the Sensor Offset. In the example above, the
O.Chxx.SensorOffset tag = 1.25.
10 Ohm Copper Offset With the 10 Ohm Copper Offset feature, you can compensate for a small offset error in a 10 Ω
copper RTD. The channel must be connected to the 10 Ω CU 427 Sensor Type to use this
feature. The offset value is indicated in units of 0.01 Ω.
For example, if the resistance of a copper RTD used with a channel is 9.74 Ω at 25 °C (77 °F),
the 10 Ohm Copper Offset lets you account for the error. You must set the 10 Ohm Copper
Offset field on the Configuration tab to -0.26 or by setting the C.Chxx.TenOhmOffset to -26.
Open Wire Detection Open Wire Detection detects when a wire is disconnected from the channel. To enable Open
Wire Detection, see Chxx.
On the 5069-IY4 and 5069-IY4K modules, this feature is available in these modes.
• Current
• Voltage
• RTD
• Thermocouple
IMPORTANT The Disable All Alarms feature does not disable the Open Wire Detection
feature because Open Wire Detection is not an alarm.
To disable the Open Wire Detection feature, you must clear the Open Wire
Detection checkbox in the module configuration.
Over Temperature The Over Temperature Detection feature indicates that the temperature of the conditions
within which the module is operating are higher than the module operating limits.
Detection
IMPORTANT Each module detects an ambient temperature that varies and is dependent on
how it is loaded and mounted, and the configuration conditions.
IMPORTANT The Disable All Alarms feature does not disable the Over Temperature
Detection feature because Over Temperature Detection is not an alarm.
Cold Junction When you use the 5069-IY4 and 5069-IY4K modules with a thermocouple input type, the
channel must account for the thermoelectric effect of a junction of the thermocouple field
Compensation wires and the RTB terminals.
IMPORTANT You must use a cold junction compensation (CJC) RTB when a 5069-IY4 or
5069-IY4K modules uses a thermocouple input type. The CJC RTBs account
for the thermoelectric effect.
The following CJC RTBs are available for order:
• 5069-RTB14CJC-SPRING
• 5069-RTB14CJC-SCREW
The junction at which temperature is measured is the hot junction. The junction where the
thermocouple wire interfaces with copper are the cold junction. The transition from
thermocouple wire to copper typically happens at the RTB terminal.
The thermoelectric effect alters the input signal and must be compensated for to measure
temperatures accurately. To compensate the input signal from your module accurately, you
must use cold junction compensation to account for the increased voltage.
Fault and Status Reports The 5069-IY4 and 5069-IY4K modules send fault and status data with channel data to the
owner-controller and listen-only controllers. The data is returned via module tags that you can
monitor in your Studio 5000 Logix Designer application.
With some exceptions, the 5069-IY4 and 5069-IY4K modules provide the fault and data status
in a channel-specific format. In this table, the tag names that include Chxx represent
channel-specific data, where xx is the channel number.
Fault Tags - 5069-IY4, 5069-IY4K
Tag Name Trigger That Sets Tag
ConnectionFaulted The owner-controller loses its connection to the module. This tag provides module-wide data and affects all channels simultaneously.
Chxx.Fault The channel data quality is bad.
CJChxx.Fault The cold junction data quality is bad.
One of these conditions.
Chxx.OpenWire • The channel uses the Voltage input type in any input range and the input signal value reaches full-scale.
• The channel uses the Current input type in any input range and the input signal goes below 100 µA. The input signal at the channel is below 100 µA.
• The channel uses the RTD or Thermocouple input type and a wire is disconnected from the channel.
CJChxx.OpenWire A wire is disconnected from the cold junction.
Chxx.Underrange The channel data is beneath the absolute minimum for this channel.
CJChxx.Underrange The cold junction at the channel is beneath the absolute minimum for this channel.
Chxx.Overrange The channel data is above the absolute maximum for this channel.
CJChxx.Overrange The cold junction at the channel is above the absolute maximum for this channel.
Topic Page
Multiple Output Ranges 68
Channel Offset 68
Hold for Initialization 68
Connection Fault Handling 69
Output Clamping 69
Clamp Alarming 70
Output Ramping/Rate Limiting 70
Data Echo 70
No Load Detection 71
Short Circuit Protection 71
Over Temperature Detection 71
Fault and Status Reports 72
The 5069-OF4, 5069-OF4K, and 5069-OF8 output modules have four and eight non-isolated
channels, respectively. Each channel supports connection to these output types.
• Current
• Voltage
Multiple Output Ranges The Compact 5000 I/O analog output modules offer multiple output ranges. The output type
that you choose during module configuration determines the available ranges.
Channel Offset The Channel Offset feature compensates for any known error on the sensor or channel to
which the sensor is connected. The value is set in signal units and is added to the output data.
For example, consider an application that uses the Current input type with the 4…20 mA range
and scaling at 0…100%. If a channel used in the 4…20 mA output range has an error that
results in consistent reports of 8 mA as 7.8 mA, you must set the Channel Offset to 1.25 to
account for the error.
Hold for Initialization The Hold for Initialization feature causes outputs to hold the current state until the value that
the controller requests matches the value at the output screw terminal, within 0.1% of full-
scale. This hold causes a bumpless transfer.
If Hold for Initialization is selected, outputs hold if there is an occurrence of any of these
conditions.
• Initial connection is established after power-up.
• A new connection is established after a communication fault occurs.
• There is a transition to Run mode from Program state.
• The module loses SA power. In this case, the data echo value goes to 0.0.
• The I.Chxx.InHold tag for a channel indicates that the channel is holding.
Connection Fault Handling You can configure the output module behavior when a connection fault occurs, that is, the
connection breaks between the owner-controller and the output module. This table describes
the parameters that you can configure.
Parameter Description Available Values
• Hold Last State - the output remains at that
value until the following occurs:
– The connection to the owner-controller is re-
Output state in If a connection fault occurs, the output state established.
fault mode changes to the selected option. – The output returns to normal operation, as
defined in the module configuration.
• User Defined Value - the output transitions to
the set value.
Fault state If you configure the output to transition to a • Forever
duration specific value after the connection fault, you
(after a fault) must define how long the output remains at • 1, 2, 5, or 10 seconds
Final fault the specified value before it transitions to a
final fault state value. User-defined
state value
Once the connection between the owner-controller and output module is re-established, the
output resumes normal operation.
Output Clamping Output Clamping limits the output from the analog module to remain within a range that is
controller-configured, even when the controller commands an output outside that range.
Once clamp values are set, if data received from the controller exceeds those clamps, the
following events occur:
• The output value transitions to the clamp limit but not to the requested value.
• The appropriate limit alarm is triggered.
For more information on limit alarms, see Clamp Alarming.
For example, an application can set the high clamp on a module to 8V and the low clamp to
-8V. If a controller sends a value to the module that corresponds to 9V, the module applies only
8V to its screw terminals.
You can disable or latch clamping alarms on a per channel basis. The alarms are disabled by
default.
IMPORTANT Clamp values are in engineering units and are not automatically updated
when the scaling high and low engineering units are changed. Failure to
update the clamp values can generate a small output signal that could be
misinterpreted as a hardware problem.
For example, a Compact 5000 I/O analog output module channel that uses
the Current output type with Clamping enabled has the following
configuration parameters:
• Scaling values: High Engineering = 100.0000%,
Low Engineering = 0.0000%
• Clamp Limits: High Clamp = 100.0000%, Low Clamp = 0.0000%
If you change the Scaling High Engineering value to 90.0000%, the High
Clamp value remains at 100.0000.
You must change the High Clamp value to 90.0000 to make sure that the
application continues to operate as expected.
To set the high clamp and low clamp parameters, see Limits.
Clamp Alarming Clamp Alarming works directly with Output Clamping. When a module receives a data value
from the controller that exceeds the limits for clamping, it applies signal values to the
clamping limit. In addition, a limit alarm is triggered.
The following tags indicate that a clamping alarm was triggered. That is, the tag is set to 1.
• I.Chxx.LLimitAlarm
• I.Chxx.HLimitAlarm
Output Ramping/Rate Output Ramping limits the speed at which an analog output signal can change. This feature
helps to prevent fast transitions in the output from damaging the devices that an output
Limiting module controls. Output Ramping is also known as Rate Limiting.
Type of Ramping Description
When the module is in Run mode, ramping occurs to all new output values at the
Ramp in Run mode maximum ramp rate.
When the current output value changes to the Program value after a Program
Ramp to Program mode command is received from the controller.
When the current output value changes to the Fault value after a communication
Ramp to Fault mode fault occurs.
The maximum rate of change in outputs is expressed in engineering units per second (EU/s), is
called the maximum ramp rate and set in the Ramp Rate field.
To enable the Ramp in Run mode, select the checkbox on the Limits page. To enable the Ramp
to Program mode or Ramp to Fault checkboxes, change these module tags to 1.
• C.Chxx.RampToProg
• C.Chxx.RampToFault
Data Echo Data Echo automatically sends channel data values that match the analog value that was sent
to the module’s screw terminals.
At the RPI, the output module sends fault and status data, and returns a value that was sent to
it by the owner-controller. The echoed value is indicated in the I.Chxx.Data and is represented
in engineering units.
No Load Detection The No Load Detection feature detects when a wire is disconnected from an output channel or
a load is missing for each output channel.
The output range that is used with the output channel determines whether a load is missing. If
the load draws less than the minimum level of current in the range, it is considered missing.
For example, if an output channel on a 5069-OF4 module uses in the 4…20 mA range, the
presence of a no load condition is detected when the channel is connected to a load that
draws less than 4 mA.
For example, if an output channel on a 5069-OF4 module uses in the 4…20 mA range, the presence of a no load condition is detected when the channel is connected to a load that draws less than 4 mA.
This table describes what happens when a No Load condition is detected and when it is
corrected. To correct the issue, reconnect the disconnected wires or troubleshoot the
application to correct the level of current that is driven from the channel.
Attribute No Load Condition Detected No Load Condition Corrected
I.Chxx.NoLoad tag value 1 0
No Load diagnostic value 1 0
I/O status indicator state Flashing red Steady Yellow
Short Circuit Protection Short Circuit Protection helps prevent damage that can result from driving a current from the
channel greater than the maximum current level the channel can handle.
This table describes what happens when a short circuit is detected and when it is corrected.
To correct the issue, remove the short circuit condition.
Attribute Short Circuit Detected Short Circuit Corrected
• Faults
Output behavior Restarts in its commanded state
• Electronically limited to 16 mA or less
I.Chxx.ShortCircuit tag value 1 0
Short Circuit diagnostic value 1 0
I/O status indicator state Flashing red Steady Yellow
Over Temperature The Over Temperature Detection feature indicates that the temperature of the conditions
within which the module is operating are higher than the module operating limits.
Detection
IMPORTANT Each module detects an ambient temperature that varies and is dependent on
how it is loaded and mounted, and the configuration conditions.
When an Over Temperature condition exists, the I.Chxx.OverTemperature tag is set to 1. If the
Digital to Analog Converter (DAC) reports an Over Temperature condition, a channel-level fault
is sent to the controller to identify the faulted channel.
IMPORTANT The Disable All Alarms feature does not disable the Over Temperature
Detection feature because Over Temperature Detection is not an alarm.
Fault and Status Reports The 5069-OF4, 5069-OF4K, and 5069-OF8 modules send fault and status data with channel
data to the owner and listen-only controllers. The data is returned via module tags that you
can monitor in your Studio 5000 Logix Designer application.
With some exceptions, the 5069-OF4, 5069-OF4K, and 5069-OF8 modules provide the fault and
data status in a channel-specific format. In this table, the tag names that include Chxx
represent channel-specific data, where xx is the channel number.
Topic Page
Analog Device Support 74
Multiple Input Ranges 74
Notch Filter 75
Digital Filter 76
Underrange/Overrange Detection 77
Process Alarms 78
Rate Alarm 80
Clamp Alarming 80
Sensor Offset 80
Channel Offset 80
Open Wire Detection 81
Over Temperature Detection 81
Field Power Loss Detection 81
Fault and Status Reports 82
The 5069-IF4IH analog 4-channel isolated current/voltage/HART input module offers channel-
to-channel isolated input channels that can connect to current, voltage, and HART input
devices. The module supports multiple ranges for each input type.
Analog Device Support The 5069-IF4IH module does not support connection to all analog devices. This table lists the
analog devices that the 5069-IF4IH module supports.
IMPORTANT Verify that the channel configuration in your Studio 5000 Logix Designer project matches the input device type that is
connected to the channel. Choose the input type on the Channels page in the Module Properties.
For example, if a current input device is connected to channel 0 on the module, the channel configuration must be
Input Type = Current.
Current
For more information on how to wire devices to the 5069-IF4IH modules, see the Compact
5000 I/O Modules and EtherNet/IP™ Adapters Specification Technical Data,
publication 5069-TD001.
Multiple Input Ranges The 5069-IF4IH module supports multiple input ranges. The input type that you choose during
module configuration determines the available input ranges. An input type is chosen on a
channel-by-channel basis.
Input Type Available Input Range
• 0…20 mA
Current (mA)
• 4…20 mA (HART)
• -10…10V
Voltage (V) • 0…5V
• 0…10V
Notch Filter The Notch Filter is a built-in feature of the Analog-to-Digital converter (ADC) that removes line
noise in your application. The removal of line noise is also known as noise immunity. The
Notch Filter attenuates the input signal at the specified frequency.
Choose a Notch Filter based on what noise frequencies are present in the module operating
environment and any sample requirements that are needed for control. For example, if the
Notch Filter setting is 60 Hz, the 60 Hz AC line noise and the associated overtones are
removed.
If you filter lower frequency noise, you get a slower input sample rate. Also, if you filter the
high frequency noise the effective resolution of the channel is limited.
Available Notch Filter Settings
• 5 Hz • 50 Hz • 1000 Hz
• 10 Hz • 60 Hz • 2500 Hz
• 15 Hz • 100 Hz • 5000 Hz
• 20 Hz • 200 Hz • 10,000 Hz
• 500 Hz
HART is supported from 5...500 Hz only.
If the RPI is smaller than the channel scan time, the controller might not receive new data with
each RPI. To help prevent over sampling, use these minimum recommended RPI values.
Notch Filter Min RPI Without Over Sampling
5 Hz 605 ms
10 Hz 305 ms
15 Hz 205 ms
20 Hz 155 ms
50 Hz 65 ms
60 Hz 55 ms
100 Hz 35 ms
200 Hz 20 ms
500 Hz 10 ms
1000 Hz 8 ms
2500 Hz 3 ms
5000 Hz 2.5 ms
10,000 Hz 2 ms
Digital Filter The Digital Filter is a first-order lag filter. It smooths input data noise transients on each input
channel. This value specifies the time constant for a digital, first-order lag filter on the input.
The input is 63% of the step change after the first time constant elapses.
120
100
80
Amplitude %
60
40
Unfiltered Input
TA = 100 ms
20
TA = 500 ms
TA = 990 ms
0
0 100 200 300 400 500 600 700 800 900 1000 1100 1200
Time in Milliseconds
The filter value is specified in units of milliseconds. A value of 0 (zero) disables the filter.
Digital Filter Equation
Δt * (Xn - Yn-1)
Yn = Yn-1 +
Δ t + TA
Underrange/Overrange Underrange/Overrange Detection detects when the 5069-IF4IH module is operating beyond
limits set by the input range.
Detection
The module can read input signal levels outside the low and high signal values for each input
range. The signal limits to which the module can read are thresholds. Only when the signal is
beyond a threshold is an underrange or overrange condition that is detected and indicated.
For example, if you configure a 5069-IF4IH module channel to use the + 10V input range, an
overrange condition does not exist until the input signal exceeds 10.7V.
This table lists the input ranges of the 5069-IF4IH module and the thresholds in each range
before the module detects an underrange/overrange condition.
Input Type Range Underrange Threshold Overrange Threshold Deadband Value
0…20 mA < 0.11 mA
Current > 23.00 mA 0.066 mA
4…20 mA < 3.00 mA
± 10.00V < -10.70V > 10.70V 0.0413V
Voltage 0…5V < -0.0206V > 5.35V 0.0206V
0…10V < -0.0413V > 10.70V 0.0413V
• The Deadband Value is the amount of change that is required past the threshold for the alarm condition to clear.
For example, if a module uses a Current input type in the 4…20 mA range and the signal value goes below 3 mA,
the underrange condition is triggered. Due to the 0.07 mA deadband, the condition is not cleared until the signal
value reaches 3.07 mA. For more information, see Alarm Deadband.
• When the underrange is set at < 3 mA, the I:Ch0x.Data tag reports values as low as 0.0 mA. The condition is
clamped when the signal reaches 3 mA.
IMPORTANT The Disable All Alarms feature does not disable the underrange/overrange
detection feature because underrange/overrange detection is not an
alarm.
To disable the Underrange/Overrange detection feature, you must disable
the channel.
Process Alarms For HART input modules, alarms alert you when the module has exceeded configured high or
low limits for each channel. This list is the user-configurable alarm trigger points.
• High high
• High
• Low
• Low low
To use the Process Alarms, you must complete the following tasks:
• Enable the alarms
• Configure the trigger points
For example, consider a channel that uses the Current input type, the 4 mA…20 mA input
range, and scales the High and Low Engineering values of 100 and 0, respectively. The
available Process Alarm values range from 0…100.
In this case, if the High Limit alarm is set to 50 EU, when the input signal reaches 12 mA, the
High Limit alarm is set. The alarm is set because Scaling was configured for Percentage of Full
Scale and a signal value of 12 mA is 50% of the full scale of engineering units.
Latch Alarms
Select the Latch Process Alarms checkbox on the Alarms tab to latch the process alarms. To
latch Process Alarms, see Alarms.
Unlatch Alarms
IMPORTANT Before you unlatch an alarm, make sure the condition that triggered the
alarm no longer exists.
Once an alarm is latched, you must manually unlatch it. To unlatch an alarm, toggle the output
tag for that alarm from 0 to 1. Use these tags to unlatch alarms.
• O.Chxx.LLAlarmUnlatch
• O.Chxx.LAlarmUnlatch
• O.Chxx.HAlarmUnlatch
• O.Chxx.HHAlarmUnlatch
• O.Chxx.RateAlarmUnlatch
IMPORTANT You must toggle the tag from 0 to 1 to unlatch the alarm each time it is
triggered.
You must also toggle the tag back to 0 after the alarm is unlatched.
If you do not change the tag back to 0 and the alarm is latched again in the
future, the alarm remains latched despite the tag value being 1.
Alarm Deadband
You can set an alarm deadband when you configure the process alarms. If the alarm condition
is removed, the alarm status bit remains set as long as the input data stays within the
deadband of the alarm.
This graphic shows input data that sets each of the alarms during module operation. In this
example, a deadband is set and alarm latching is disabled, so each alarm turns Off when the
condition that caused it to turn On is removed and the input data exits the deadband.
Alarm Deadband Example
High high
High
= Deadband
Input data = Alarm turns on
= Related alarm turns off
Low
Low low
The High alarm remains On during the High high alarm, and the Low alarm remains On during
the Low low alarm.
Rate Alarm For HART input modules, the Rate Alarm defines the maximum rate of change between input
samples in engineering units per second. If the Rate Alarm Limit is exceeded, the
I.Chxx.RateAlarm tag is set to 1.
You can enable or disable Rate Alarm Latching on each channel. To enable the Rate Alarm,
see Alarms.
You can unlatch the alarm at any point in the system operation. If you change the unlatch tag
to 1 and the triggering condition remains, the alarm is immediately latched again.
We suggest that you unlatch the Rate Alarm only after the rate of change between input
samples has returned below the Rate Alarm Limit value.
Clamp Alarming For HART output modules, Clamp Alarming works directly with Output Clamping. When a
module receives a data value from the controller that exceeds the limits for clamping, it
applies signal values to the clamping limit. In addition, a limit alarm is triggered.
The following tags indicate that a clamping alarm was triggered. That is, the tag is set to 1.
• I.Chxx.LLimitAlarm
• I.Chxx.HLimitAlarm
Sensor Offset For HART input modules, Sensor Offset compensates for any known error on the sensor or
channel to which the sensor is connected. The value is set in signal units and is added to the
data value. The Sensor Offset feature is used in the same way for both the Current and Voltage
input types.
For example, consider an application that uses the Current input type with the 4…20 mA range
and scaling at 0…100%. If a sensor has an error and the channel consistently reports current
signal values by 0.2 mA lower than the actual value, you must set the Sensor Offset to 1.25%.
Use the O.Chxx.SensorOffset tag to set the Sensor Offset. In the example above, the
O.Chxx.SensorOffset tag = 1.25.
Channel Offset For HART output modules, the Channel Offset feature compensates for any known error on the
sensor or channel to which the sensor is connected. The value is set in signal units and is
added to the output data.
For example, consider an application that uses the Current input type with the 4…20 mA range
and scaling at 0…100%. If a channel used in the 4…20 mA output range has an error that
results in consistent reports of 8 mA as 7.8 mA, you must set the Channel Offset to 1.25 to
account for the error.
Open Wire Detection The Open Wire Detection feature indicates that a wire is disconnected from the channel. To
enable Open Wire Detection, see Chxx.
Open Wire Conditions
Mode Cause of Detection Module Behavior
• Input data for the channel changes to a specific scaled value
The input signal for a channel that corresponds to the Underrange value for the Input Range.
Current is below 100 µA. • The I:Chxx.OpenWire tag changes to 1.
• A fault occurs and the I:Chxx.Fault tag is set to 1.
• Input data for the channel shows the scaled engineering value
The input signal value is within of the actual signal.
Voltage +/- 0.1V. • The I:Chxx.OpenWire tag changes to 1.
• A fault occurs and the I:Chxx.Fault tag is set to 1.
IMPORTANT The Disable All Alarms feature does not disable the Open Wire Detection
feature because Open Wire Detection is not an alarm.
To disable the Open Wire Detection feature, you must clear the Open Wire
Detection checkbox in the module configuration.
Over Temperature The Over Temperature Detection feature indicates that the temperature of the conditions
within which the module is operating are higher than the module operating limits.
Detection
IMPORTANT Each module detects an ambient temperature that varies and is dependent on
how it is loaded and mounted, and the configuration conditions.
IMPORTANT The Disable All Alarms feature does not disable the Over Temperature
Detection feature because Over Temperature Detection is not an alarm.
Field Power Loss Detection Field Power Loss Detection monitors for the loss of power at an input module channel. When
field power to the module is lost, and when SA power is out of range, a channel-level fault is
sent to the controller to identify the faulted channel.
When field power is lost, the I.Chxx.FieldPowerOff tag is set to 1.
IMPORTANT The Disable All Alarms feature does not disable the Field Power Loss
Detection feature because Field Power Loss Detection is not an alarm.
Fault and Status Reports The 5069-IF4IH module sends fault and status data with channel data to the owner-controller
and listen-only controllers. The data is returned via module tags that you can monitor in your
Studio 5000 Logix Designer application.
With some exceptions, the 5069-IF4IH module provides the fault and data status in a channel-
specific format. In this table, the tag names that include Chxx represent channel-specific data,
where xx is the channel number.
Fault Tags - 5069-IF4IH
Tag Name Triggering Event That Sets Tag
ConnectionFaulted The owner-controller loses its connection to the module. This tag provides module-wide data and affects all channels simultaneously.
Chxx.FieldPowerOff Field power is not present on the channel.
Chxx.Fault The channel data quality is bad.
One of these conditions.
Chxx.OpenWire • The channel uses a Voltage input type in any input range and the input signal value reaches full-scale.
• The channel uses a Current input type in any input range and the input signal goes below 100 µA. The input signal at the channel is below 100 µA.
Chxx.Underrange The channel data is beneath the absolute minimum for this channel.
Chxx.Overrange The channel data is above the absolute maximum for this channel.
Chxx.OverTemperature The module is at a higher temperature than its rated operating limits.
Topic Page
Multiple Output Ranges 84
Channel Offset 84
Hold for Initialization 84
Configure Channel Output State 84
Connection Fault Handling 85
Output Clamping 85
Clamp Alarming 86
Output Ramping/Rate Limiting 86
Data Echo 86
No Load Detection 87
Short Circuit Protection 87
Over Temperature Detection 87
Fault and Status Reports 88
Multiple Output Ranges The HART output modules offer multiple output ranges. The output type that you choose during
module configuration determines the available ranges.
Channel Offset The Channel Offset compensates for any known error in actuator operation. The value is set in
engineering units (EU) and the default is 0.0.
For example, consider an application that uses the Current input type with the 4…20 mA range
and scaling at 0…100%. If a channel has an error that results in consistent reports of 7.8 mA
instead of 8 mA, you must set the Channel Offset to 1.25 to account for the error.
IMPORTANT The Output Readback data value that is reported via I.Chxx.Data excludes the
Channel Offset.
Hold for Initialization Hold for Initialization causes outputs to hold the current state until the value that the
controller requests matches the value at the RTB within 0.1% of full-scale. This hold causes a
bumpless transfer.
If Hold for Initialization is selected, the current state is held if any of these conditions occur.
• Initial connection is established after power-up.
• A new connection is established after a communication fault occurs, or the module is
uninhibited.
• There is a transition to Run mode from Program state.
• The module loses SA power and the data echo value goes to 0.0V or 0.0 mA.
• The I.Chxx.InHold tag indicates that the channel is holding.
To enable Hold for Initialization, see Chxx.
Configure Channel Output You can configure individual output channels to specific states when the module is in Program
mode or Communications Fault mode. These output states are available.
State
• Off
• Hold Last State
• User-Defined Value
To configure the output states in Program mode or Communications Fault mode, see Chxx.
Connection Fault Handling You can configure the output module behavior when a connection breaks between the
owner-controller and the output module and causes a connection fault. This table describes
the parameters that you can configure.
Parameter Description Available Values
• User Defined Value - the output transitions to
the set value.
• Hold Last State - the output remains at that
Output state in If a connection fault occurs, the output state value until the following occurs:
fault mode changes to the selected option. – The connection to the owner-controller is
re-established.
– The output returns to normal operation, as
defined in the module configuration.
Fault state If you configure the output to transition to a • Forever
duration specific value after the connection fault, you
(after a fault) must define how long the output remains at • 1, 2, 5, or 10 seconds
Final fault the specified value before it transitions to a
final fault state value. User-defined
state value
Once the connection between the owner-controller and output module is re-established, the
output resumes normal operation.
Output Clamping Output Clamping limits the output from the analog module to remain within a range that is
controller-configured, even when the controller commands an output outside that range.
Once clamp values are set, if data received from the controller exceeds those clamps, the
following events occur:
• The output value transitions to the clamp limit but not to the requested value.
• The appropriate limit alarm is triggered.
For more information on limit alarms, see Clamp Alarming.
For example, an application can set the high clamp on a module to 8V and the low clamp to
-8V. If a controller sends a value to the module that corresponds to 9V, the module applies only
8V to its screw terminals.
You can disable or latch clamping alarms on a per channel basis. The alarms are disabled by
default.
IMPORTANT Clamp values are in engineering units (EU) and are not automatically
updated when the scaling high and low EUs are changed. Failure to update
the clamp values can generate a small output signal that could be
misinterpreted as a hardware problem.
For example, a Compact 5000 analog output module channel that uses the
Current output type with Clamping enabled has the following configuration
parameters:
• Scaling: High Engineering = 100.0000%, Low Engineering = 0.0000%
• Clamp Limits: High Clamp = 100.0000%, Low Clamp = 0.0000%
If you change the High Engineering value to 90.0000%, the High Clamp value
remains at 100.0000%.
You must change the High Clamp value to 90.0000 to make sure that the
application continues to operate as expected.
Clamp Alarming Clamp Alarming works directly with Output Clamping. When a module receives a data value
from the controller that exceeds the limits for clamping, it applies signal values to the
clamping limit. In addition, a limit alarm is triggered.
These tags are set to 1 to indicate that a clamping alarm is triggered.
• I.Chxx.LLimitAlarm
• I.Chxx.HLimitAlarm
Output Ramping/Rate Output Ramping limits the speed at which an analog output signal can change. This feature
helps to prevent fast transitions in the output from damaging the devices that an output
Limiting module controls. Output Ramping is also known as Rate Limiting.
Type of Ramping Description
When the module is in Run mode, ramping occurs to all new output values at the
Ramp in Run mode maximum ramp rate.
When the current output value changes to the Program value after a Program
Ramp to Program mode command is received from the controller.
When the current output value changes to the Fault value after a communication
Ramp to Fault mode fault occurs.
The maximum rate of change in outputs is expressed in engineering units per second (EU/s), is
called the maximum ramp rate and set in the Ramp Rate field.
Data Echo Data Echo automatically sends channel data values that match the analog value that was sent
to the module’s RTB.
At the RPI, the output module sends fault and status data, and returns a value that was sent to
it by the owner-controller. The echoed value is indicated in the I.Chxx.Data and is represented
in engineering units.
For more information, see Output Module Data.
No Load Detection No Load Detection indicates when a wire is disconnected from an output channel or a load is
missing for each output channel.
This table describes what happens when a No Load condition is detected and when it is
corrected. To correct the issue, reconnect the disconnected wires or troubleshoot the
application to correct the level of current that is driven from the channel.
Attribute No Load Condition Detected No Load Condition Corrected
I.Chxx.NoLoad tag value 1 0
No Load diagnostic value 1 0
I/O status indicator state Flashing red Steady Yellow
Short Circuit Protection Short Circuit Protection helps prevent damage that can result from driving a current from the
channel greater than the maximum current level the channel can handle.
This table describes what happens when a short circuit is detected and when it is corrected.
To correct the issue, remove the short circuit condition.
Attribute Short Circuit Detected Short Circuit Corrected
Output behavior Faults Restarts in its commanded state
I.Chxx.ShortCircuit tag value 1 0
Short Circuit diagnostic value 1 0
I/O status indicator state Flashing red Steady Yellow
Over Temperature The Over Temperature Detection feature indicates that the temperature of the conditions
within which the module is operating are higher than the module operating limits.
Detection
IMPORTANT Each module detects an ambient temperature that varies and is dependent on
how it is loaded and mounted, and the configuration conditions.
When an Over Temperature condition exists, the I.Chxx.OverTemperature tag is set to 1. If the
Digital to Analog Converter (DAC) reports an Over Temperature condition, a channel-level fault
is sent to the controller to identify the faulted channel.
IMPORTANT The Disable All Alarms feature does not disable the Over Temperature
Detection feature because Over Temperature Detection is not an alarm.
Field Power Loss Detection Field Power Loss Detection monitors for the loss of power at an input module channel. When
field power to the module is lost, and when SA power is out of range, a channel-level fault is
sent to the controller to identify the faulted channel.
IMPORTANT The Disable All Alarms feature does not disable the Field Power Loss
Detection feature because Field Power Loss Detection is not an alarm.
Fault and Status Reports The HART output modules send fault and status data with channel data to the owner and
listen-only controllers. The data is returned via module tags that you can monitor in your
Studio 5000 Logix Designer application.
With some exceptions, as noted in this table, the HART output modules provide the fault and
data status in a channel-specific format. In this table, the tag names that include Chxx
represent channel-specific data, where xx is the channel number.
Fault Tags - 5069-OF4IH
Tag Name Trigger That Sets Tag
ConnectionFaulted The owner-controller loses its connection to the module. This tag provides module-wide data and affects all channels simultaneously.
Chxx.FieldPowerOff Field power is not present on the channel.
Chxx.Fault The channel data quality is bad.
Chxx.NoLoad A no load condition exists on the channel.
Chxx.ShortCircuit A short circuit condition exists on the channel.
Chxx.OverTemperature The module is at a higher temperature than its rated operating limits.
Chxx.Underrange The channel data is beneath the underrange threshold for this channel.
Chxx.Overrange The channel data is above the overrange threshold for this channel.
Topic Page
Information and Identity 89
Inhibit Device 90
Electronic Keying 90
Configuration Change Notification 91
Rolling Timestamp of Dynamic or Device Variable Data 91
Producer/Consumer Communication 91
Execute HART Commands Through Producer/Consumer Data 92
Execute HART Commands Through Explicit Messaging 93
Fault and Status Reporting 94
This chapter describes the features of HART devices when they are used with the Compact
5000® HART I/O modules.
Information and Identity Use the Studio 5000 Logix Designer® application to retrieve this information from a HART
device in the system.
IMPORTANT After a configuration change occurs in the device, the module needs some
time to refresh the data, typically within 30 seconds. Therefore, the latest
configuration of the device that is reflected on the Device Info page could
be delayed.
Inhibit Device You can suspend data exchange between the controller and individual HART devices in online
mode, or in offline mode after download. Inhibition does not make the device to cease
operation. This option allows for maintenance of the device without faults being reported to
the controller.
Inhibit HART devices on the device Connection page.
Electronic Keying The electronic keying feature for HART devices automatically compares the expected device
to the physical device before HART device connection is established. You can use electronic
keying to help prevent connection to a HART device that does not match the expected type and
revision.
For each HART device, the user-selected keying option determines if and how an electronic
keying check is performed.
Available Keying Options
Keying Type Description
A protective mode that requires a match between the physical HART device and the HART
Exact Match device that is configured in the software, according to HART Expanded Device Type, major
revision, and minor revision.
This mode allows the physical HART device to accept the key of the HART device configured in
the software, if the configured device is one that the physical device can emulate.
These requirements make a device compatible.
Compatible • HART Expanded Device Type must match.
Module (default) • Major revision of the physical device must be greater or equal than the configured major
revision.
• If the major revision exactly matches, the minor revision of the physical device must be
greater or equal than the configured minor revision if the configured minor revision is not 0.
This mode allows the software to ignore the keying attributes when it attempts to
communicate with a HART device. Other attributes, like data size and format, must match
before HART connection is established.
WARNING: With Disabled Keying, HART connection can occur with a device other than the type
Disable Keying specified in the I/O configuration tree with unpredictable results.
If used incorrectly, this option can lead to personal injury or death, property damage, or
economic loss. We strongly recommend that you do not use Disable Keying.
If you use Disable Keying, you take full responsibility to understand if the device can fulfill the
functional requirements of the application.
Configuration Change If any configuration parameters are changed in a HART device for any reason, the
ConfigurationChanged tag is set to 1 in the producer data. When this tag is set to 1, the device
Notification completes these actions.
1. Toggles the ResetConfigurationChanged tag from 0 to 1 in the consumer data.
2. Executes the Get HART Device Information Service.
For more information, see CIP Object Model of HART Devices.
3. Performs the other HART services that are needed to get the other configuration data
that the Studio 5000 Logix Designer application manages.
Rolling Timestamp of Whenever a HART I/O module receives new HART Dynamic or Device variable data from a HART
device, the module also records the value of RollingTimestamp. The Logix 5000® controller
Dynamic or Device Variable uses the last two rolling timestamp values to calculate the amount of time between the
Data samples.
Producer/Consumer The Producer/Consumer communication between a controller and a HART device allows you to
complete these actions.
Communication
• Monitor HART device status or configuration change.
• Get PlantPAx® specific data required for the PlantPAx HART instruction on a PlantPAx
connection.
• Get periodical updates of dynamic variable data and status.
• Get periodical updates of device variable data and status.
• Execute HART commands on-demand.
Execute HART Commands Use this information and guidelines to execute HART commands through Producer/Consumer
Data.
Through Producer/
• A command execution starts with a rising edge of Command.Execute in the consumer
Consumer Data data.
• In the producer data, Command.ReadyToExecute = 1 when the HART device has no
outstanding commands from the consumer data and Command.Execute = 0 in the most
recent consumer data.
• Toggle Command.Execute to 1 only when Command.ReadyToExecute = 1.
• After you execute a command, you can toggle Command.Execute back to 0 once
Command.ReadyToExecute = 0. The transition of Command.ReadyToExecute from 1 to 0
indicates that the HART I/O module has received the command execution request.
• After a command is complete, check the status of the producer data in the Command
tag before you retrieve the response data from the command.
Command Execution Examples
Example Type Sequence Steps
Steps 1 2 3 4
ReadyToExecute 1. To execute a HART command, toggle Command.Execute to 1 in the consumer data when
Command.ReadyToExec = 1 in the producer data of the HART device.
2. After the HART I/O module receives the consumer data, Command.Active = 1 and
Command.ReadyToExec = 0 are reported in the producer data of the HART device.
Typical Execute 3. Once the module receives the execution request and the controller receives
Command Command.ReadyToExec = 0, toggle Command.Execute to 0 in the consumer data.
Execution 4. When the HART command execution is complete, the HART I/O module reports
Active Command.Completed = 1 and Command.ReadyToExec = 1 in the producer data of the HART
device together with the command result and response data.
Steps 1 2 3 4
1. To execute a HART command, toggle Command.Execute to 1 in the consumer data when
ReadyToExecute Command.ReadyToExec = 1 in the producer data of the HART device.
2. After the HART I/O module receives the consumer data, the HART command is completed
within an RPI. Hence, Command.Completed = 1 and Command.ReadyToExec = 0 are
reported in the next producer data of the HART device. An active state is not reported for
Command Execute
the command.
Completed 3. Once the controller receives Command.ReadyToExec = 0, toggle Command.Execute to 0 in
within an RPI the consumer data.
Active 4. When the HART I/O module receives the consumer data, the next producer data of the
HART device reports Command.ReadyToExec = 1.
Complete
To initiate another command execution, repeat steps 1…3.
Execute HART Commands The HART I/O modules allow you to define message instructions to send commands to HART
devices. The CIP™ service is Service 0x4C of HART Process Device Object that is defined in CIP
Through Explicit Messaging Volume 7B, “Integration of HART Devices into the CIP Architecture”, with an exception that
Class ID 0x3B8 must be used for HART Process Device Object.
Periodic command execution through explicit messaging, like connected and cached message
instruction, is not recommended because the execution of HART commands through explicit
messaging causes update delays in dynamic or device variables in the producer data of the
HART device.s
Fault and Status Reporting The HART I/O modules send fault and status data, configured dynamic variables, and device
variables in the producer data for each HART device.
This table lists the HART device fault and status tags available in the Studio 5000 Logix
Designer application.
Fault Tags - HART Devices
Tag Name Trigger that Sets the Tag
ConnectionFaulted The owner-controller loses its connection to the module. This tag provides module-wide data and affects all channels simultaneously.
CurrentMismatch The HART digital value does not match the analog module channel value.
Malfunction The device has detected a hardware error or failure.
<NameOfVariable>.Ch.Fault Data is inaccurate and cannot be trusted for use in the application.
<NameOfVariable>.Ch.Underrange The input signal at the channel is less than, or equal to, the min detectable signal.
<NameOfVariable>.Ch.Overrange The input signal at the channel is greater than, or equal to, the max detectable signal.
Static.Fault Indicates if the set of static data is valid. For PlantPAx connection only.
Topic Page
Before You Begin 95
Create a New Module 96
Reserve an I/O Module Slot 102
Configure the Module Parameters 103
This chapter describes how to configure your Compact 5000® analog I/O modules in a
Studio 5000 Logix Designer® project. You can use the default module configuration or edit the
module configuration.
For detailed information about module features, see these sections.
• Common Analog I/O Module Features
• Current/Voltage Analog Input Module Features - 5069-IF8
• Current/Voltage/RTD/Temperature Analog Input Module Features - 5069-IY4, 5069-IY4K
• Current/Voltage Analog Output Module Features - 5069-OF4, 5069-OF4K, 5069-OF8
• Current/Voltage/HART Analog Input Module Features - 5069-IF4IH
• Current/Voltage/HART Analog Output Module Features - 5069-OF4IH
For information about the tags created when you configure the modules,
see Module and Device Tags
Before You Begin You must complete these tasks before you configure the module.
1. Create a Studio 5000 Logix Designer® project.
2. If you use the standard I/O modules as remote modules, add a Compact 5000
EtherNet/IP™ adapter to the project.
For more information on how to add a Compact 5000 I/O EtherNet/IP adapter to a
Studio 5000 Logix Designer project, see the Compact 5000 EtherNet/IP Adapters User
Manual, publication 5069-UM007.
Create a New Module Use one of these methods to add modules to the project.
• Go Online and Discover Local I/O Modules
• Remain Offline and Add New Local I/O Modules
• Go Online and Discover Remote I/O Modules
• Remain Offline and Add New Remote I/O Modules
The Studio 5000 Logix Designer application automatically detects available modules
that are connected to the backplane and the Select Module Type dialog opens.
If you have more than one module to add, do not select the Close on Create
checkbox.
4. At the New Module dialog, configure the module properties and click OK.
A warning opens.
5. Verify that the Inhibit module connection(s) checkbox is selected and click Yes.
When you inhibit the module connection, you must remember to
uninhibit the connection later.
6. To add additional local I/O modules with this method, repeat steps 3…5.
2. Navigate to the catalog number for the module that you are adding, and click Create.
3. At the New Module dialog, configure the module properties and click OK.
4. To add additional local I/O modules with this method, repeat steps 2…3.
The Studio 5000 Logix Designer application automatically detects available modules
that are connected to the adapter and the Select Module Type dialog opens.
If you have more than one module to add, do not select the Close on Create
checkbox.
3. At the Select Module Type dialog, click Create to add the discovered module to your
project.
4. At the New Module dialog, configure the module properties and click OK.
A warning opens.
5. Verify that the Inhibit module connection(s) checkbox is selected and click Yes.
When you inhibit the module connection, you must remember to
uninhibit the connection later.
6. To add additional local I/O modules with this method, repeat steps 3…5.
2. Navigate to the catalog number for the module that you are adding, and click Create.
3. At the New Module dialog, configure the module properties and click OK.
4. To add additional local I/O modules with this method, repeat steps 2…3.
Reserve an I/O Module Slot As described in Use a 5069-ARM Address Reserve Module to Reserve a Node Address, the
5069-ARM address reserve module reserves a module slot in the physical system and in the
Studio 5000 Logix Designer project that is configured for the system.
You must delete the 5069-ARM module from the project as these steps show.
1. Right-click the module name and choose Delete.
3. To add the Compact 5000 I/O module that uses the node address that the 5069-ARM
module reserved, use one of the methods in Create a New Module.
Configure the Module Click the parameter pages in the New Module dialog box to view and change the parameters
that are associated with that module.
Parameters
IMPORTANT This chapter shows how to configure the parameters as you add the module
to the Studio 5000 Logix Designer project in the New Module dialog box.
If you access the parameters after the module has been added to the
project, the dialog box is named Module Properties. The Module Properties
dialog box shows the same parameters as the New Module dialog box.
General
• Name the module
• Assign a slot number (required)
• Describe the module
• Access the Module Definition
For more information, see the Module Definition table.
Module Info
These actions are available when the project is online.
• View module information and status
• Access module diagnostics
• Refresh the data on the screen
• Reset the module
Module Definition
Click Change… on the General parameters page to access the configurable module definition
parameters.
Available Selections
Parameter Description (vary by module type)
Series Module hardware series Module-specific
Revision Module firmware revision, including major and minor revision levels Module-specific
Software method by which you reduce the possibility of using the wrong
device in a control system. • Exact Match
For more information, see the following:
Electronic Keying • Compatible Module
• Electronic Keying
• Disable Keying
• Electronic Keying in Logix 5000® Control Systems Application
Technique, publication LOGIX-AT001
Determines these items for the module type that you configure. • Data
• Available configuration parameters • Data with Calibration Data
Connection • Listen Only
• Data type transferred between the module and the controller
For more information, see Connection Types Available with Compact
• Which tags are generated when the configuration is complete 5000 I/O Analog Modules.
• Analog Data
Input Data - All available configuration, input, and output data for the input module • Analog and Discrete - HART I/O modules only
Input modules only that is being defined.
• Discrete - HART I/O modules only
Output Data - All available configuration, input, and output data for the output module • Analog Data
Output module only that is being defined. • None - Available only when Connection = Listen Only.
Module-specific Parameters
Some parameters are specific to the module type. This table describes the additional
parameters and the modules to which these parameters apply.
IMPORTANT If you use the Listen Only connection type, the Channels and Calibration
pages are not available.
Module-specific Parameters
Parameter Description Modules Configurable Parameters
Page
5069-IF4IH
5069-IF8
5069-IY4,
Overview of the 5069-IY4K
Channels configuration values for
all module channels. The
values for each
parameter indicate how
each channel is
configured on the Chxx 5069-OF4,
page. 5069-OF4K
5069-OF4IH
5069-OF8
5069-IF4IH,
5069-IF8,
5069-IY4,
The configuration 5069-IY4K
options available for the
channel, where xx
represents the channel
number. Scaling and
Chxx Filter options correspond
to the type and range of
the channel.
Limits
Each output channel has
an associated limit. The 5069-OF4,
Signal Units options 5069-OF4K,
correspond to the input 5069-OF4IH,
type and range for the 5069-OF8
channel.
Configuration for a
5069-IY4,
Thermocouple input 5069-IY4K
type.
Notes:
Topic Page
Before You Begin 109
Create a New Device 110
Update or Add a HART EDD File 114
Configure the Device Parameters 117
This chapter describes how to configure the HART devices that are connected to your HART I/O
modules in a Studio 5000 Logix Designer® project. You can use the default device
configuration or edit the device configuration.
• Some HART device profiles are pre-loaded in the Studio 5000 Logix Designer application
and are recognized when you connect them to HART enabled channels.
• Some HART devices need Electronic Device Description (EDD) information updates
before you can use them.
• Some HART devices are not recognized and need generic profiles to connect to the
channels.
For detailed information about device features, see HART Device Features.
Before You Begin You must complete these tasks before you configure the device:
1. Create a Studio 5000 Logix Designer project.
2. If you use the standard I/O modules as remote modules, add a Compact 5000®
EtherNet/IP™ adapter to the project.
For more information on how to add a Compact 5000 I/O EtherNet/IP adapter to a
Studio 5000 Logix Designer project, see the Compact 5000 EtherNet/IP Adapters User
Manual, publication 5069-UM007.
3. Configure the HART I/O module. For more information, see Configure the Module.
Set at least one channel Input Type to Current, the Input Range to 4…20 mA, and select
the Enable HART checkbox.
Create a New Device Use one of these methods to add devices to the project if they are already in the device list in
the application.
• Go Online and Discover Local HART Devices
• Remain Offline and Add New Local HART Devices
• Go Online and Discover Remote HART Devices
• Remain Offline and Add New Remote HART Devices
The Studio 5000 Logix Designer application automatically detects available devices
that are connected to the HART I/O module and the Select Module Type dialog opens.
If you have more than one device to add, do not select the Close on Create
checkbox.
4. At the New Module dialog, configure the device properties and click OK.
5. To add additional local HART devices with this method, repeat steps 3…4.
3. At the New Module dialog, configure the device properties and click OK.
4. To add additional local HART devices with this method, repeat steps 2…3.
The Studio 5000 Logix Designer application automatically detects available devices
that are connected to the HART I/O module and the Select Module Type dialog opens.
If you have more than one device to add, do not select the Close on Create
checkbox.
4. At the New Module dialog, configure the device properties and click OK.
5. To add additional local HART devices with this method, repeat steps 3…4.
2. Navigate to the catalog number for the device that you are adding, and click Create.
3. At the New Module dialog, configure the device properties and click OK.
4. To add additional remote HART devices with this method, repeat steps 2…3.
Update or Add a HART EDD The HART device EDD files are included with most HART device profiles. If you require
additional or updated EDD files, you must download them. Some EDD files are available on the
File Registered Products page at the FieldComm Group™ website. Otherwise, request the file from
the HART device vendor.
You can add or update the EDD file in one of these ways.
• Update an EDD File for a Specific HART Device
• Add an EDD File for a Generic HART Device
3. Navigate to the location of the EDD file, select it, and click Open.
4. Click Open.
A Successfully added EDD alert opens.
5. Click OK.
2. On the Module Definition dialog, enter the correct Expanded Device Type ID for the HART
device.
IMPORTANT To add an EDD file successfully, the Expanded Device Type ID must match
your device.
3. Click Add HART EDD.
4. Navigate to the location of the EDD file and select it.
5. Click Open.
A Successfully added EDD alert opens.
6. Click OK.
Configure the Device Click the parameter pages in the New Module dialog box to view and change the parameters
that are associated with that device.
Parameters
IMPORTANT This section shows how to configure the parameters in the New Module
dialog box as you add the device to the Studio 5000 Logix Designer project.
If you access the parameters after the device is added to the project, the
dialog box is named Module Properties. The Module Properties dialog box
shows the same parameters as the New Module dialog box.
General Page
These actions are available on the General Page.
• Name the device.
• Describe the device.
• Access the device definition.
Device Definition
Click Change… on the General page to access the configurable device definition parameters.
Available Selections
Parameter Description or Action (varies by device type)
Select the checkbox to enable Expanded Device Type.
Use Expanded Device WARNING: Enabled
If you disable Expanded Device Type, Disable Keying is the only option available for Electronic Keying.
Type Disabled
We recommend that you do not use Disable Keying. For more information, see Electronic Keying.
Expanded Device Enter the device-specific device type ID.
Type Device-specific
Revision Displays the device revision.
Exact Match
When Electronic Keying is used, it decreases the possibility of using the wrong device in a control system.
Electronic Keying Compatible Module
WARNING: We recommend that you do not use Disable Keying. For more information, see Electronic Keying. Disable Keying
Data
Connection Displays the I/O connection to the device. PlantPAx® Data
Add HART EDD See Update or Add a HART EDD File –
Variables Page
You can configure the dynamic and device variables that are included in the input tag of the
HART device on this page.
Attribute Description
Dynamic Variables Displays the included Dynamic Variables.
Available Displays the names of the supported Device Variables. Right-click to sort the list.
Displays the list of Device Variables that are in use.
Used The list can contain a maximum of 8 variables.
Add/Remove Moves variables between the Available and Used lists.
Move Modifies the order in which the variables occur.
Commands Page
You can configure the command variables for the HART device on this page.
Attribute Description
Available Displays the names of the supported commands. Right-click to sort the list.
Displays the list of commands that are in use.
Used The list can contain a maximum of 4 commands.
Add/Remove Moves commands between the Available and Used lists.
Move Modifies the order in which the commands occur.
Request Parameters Displays the name, HART data type, and initial value for each request parameter.
Response Parameters Displays the name and data type for each response parameter.
Topic Page
Before You Begin 119
Calibration Differences and Accuracy 120
Calibrate the Input Modules 120
Calibrate the Output Modules 125
The Compact 5000® analog I/O modules are calibrated during the manufacturing process.
The accuracy of each module remains high throughout its lifespan. You are not required to
calibrate the module.
You can calibrate on a per channel basis or in groups.
IMPORTANT This chapter describes a few example module calibration scenarios. It does
not cover how to calibrate every Compact 5000 analog I/O module in all
operating modes that the module supports.
The controller must be in Program mode or Remote Program to calibrate the module. We
recommend that your module is in Program mode and not actively controlling a process when
you calibrate it.
Grouped inputs share an Analog-to-Digital converter, so when any input channel is in the
calibration process, the I.Chxx.Uncertain tag is set to 1 for the other input channels in that
group. This change happens because the data sample rate slows for all input channels in the
group.
Calibration Differences and The purpose of calibrating the Compact 5000 analog I/O modules is the same for input and
output modules, to improve the module’s accuracy and repeatability. The procedures used to
Accuracy calibrate the module differ by module type:
• When you calibrate input modules, you use current, voltage, or ohms reference signals
to send a signal to the module to calibrate it.
• When you calibrate output modules, you use a digital multimeter (DMM) to measure the
current or voltage signal the module is sending out.
IMPORTANT If you calibrate your module with an instrument that is less accurate than
the recommendation, the following events can result:
• Calibration appears to occur normally but the module gives inaccurate
data during operation.
• A calibration fault occurs that forces you to cancel calibration.
• The I.Chxx.CalFault tag is set for the channel that you tried to calibrate.
To clear the tag, complete a valid calibration or cycle power to the
module. In this case, you must recalibrate the module with an instrument
as accurate as recommended.
Calibrate the Input Modules Apply low and high signal references to the Compact 5000 analog input module to calibrate it.
The references must match the input range of the channel is using.
6. Select the checkbox of the channel that you want to calibrate, and click Next.
7. At the Attach Low Reference Voltage Signals dialog, set the calibrator to the low
reference and apply it to the channel.
8. Click Next.
The One at a Time Low Reference Results dialog opens and indicates the status of the
channel after applying the low reference.
The One at a Time High Reference Results dialog opens and indicates the status of the
channel after applying the low reference.
6. Select the checkbox of the channel that you want to calibrate, and click Next.
7. At the Attach Low Reference Ohm Sources dialog, connect a 1 Ω resistor to the channel
being calibrated and click Next.
The One at a Time Low Reference Results dialog opens and indicates the status of the
channel after calibrating for the low reference.
The One at a Time High Reference Results dialog opens and indicates the status of the
channel after calibrating for a high reference
Calibrate the When calibrating a Compact 5000 analog output channel, the Studio 5000 Logix Designer
application commands the module to output specific signal levels. The channel output type
Output Modules determines the signal type.
You must measure the actual level and record the results to account for any module
inaccuracies.
6. Select the checkbox of the channel that you want to calibrate, or select Calibrate
Channels in Groups.
7. Click Next.
The One At a Time Low Reference Results dialog opens and indicates the status of the
calibrated channel.
12. The Output Reference Signals dialog opens and indicates the channel to be calibrated
for the high reference, click Next.
The One At a Time High Reference Results dialog opens and indicates the status of the
calibrated channel.
Notes:
Topic Page
Troubleshoot with the Status Indicators 129
Troubleshoot with the Studio 5000 Logix Designer 134
Application
Troubleshoot a HART Device 137
Troubleshoot with the Use this information to troubleshoot with the status indicators.
Status Indicators Status Indicators - Compact 5000 Analog Input Modules
Troubleshoot with the The Studio 5000 Logix Designer application indicates the presence of fault conditions in these
ways.
Studio 5000 Logix Designer
• Warning Signal in the I/O Configuration Tree
Application • Status and Fault Information in the Module Properties
• Studio 5000 Logix Designer Tag Editor
The module status is indicated on the General page of the Modules Properties.
The Module Fault box on the Connection page lists fault descriptions. The description includes
an error code that is associated with the specific fault type.
Module Diagnostics
Troubleshoot a HART Device The Studio 5000 Logix Designer application indicates the presence of device fault conditions
in these ways.
• Warning Symbol in the I/O Configuration Tree
• Status and Fault Information in the Module Properties
• Studio 5000 Logix Designer Tag Editor
If a warning signal appears in the I/O Configuration tree, verify these items.
• The device is powered up and properly wired to the module.
• There are no electronic keying mismatches.
• There is no fault status on the analog channel.
Some fault error codes are returned with the CIP™ messages that are sent to HART devices.
Either the Connection page or the CIP messaging responses report these error codes.
Error Code Description
Timeout - one of these conditions exists.
• The channel is not configured as HART-enabled
• The owner controller connection is down between the HART I/O
0x01/0x204 module and the controller
• No HART device is wired on the channel
• The HART device is rebooting
• The discovery with Command 0 is in progress on the HART device
0x0C The object is in the wrong mode
• Electronic Keying mismatch
0x01/0x114
• HART expanded device type mismatch
• Electronic Keying mismatch
0x01/0x116
• Major or Minor Revision mismatch
0x02 No resource
0x20 Invalid parameter found in the CIP request
Ox1E Service failed – the HART command failed due to a link layer error
Topic Page
View the Tags 140
Input Module Tags 141
Output Module Tags 147
HART Device Tags 151
Module tags are created when you add a module to the Studio 5000 Logix Designer® project.
The tag types are available with the Compact 5000® analog I/O modules:
• Configuration (C)
• Input (I)
• Output (O)
The available set of module tags depends on the module type and the parameters that you
select during module configuration. For example, if you select a Listen Only connection, the
Studio 5000 Logix Designer application creates only Input tags for that module.
The tables in this section list all tags available with each module. Not all tags in the list are
available when a module is first added to a project. More tags are available as you configure
the module.
The Data Tag Function represents the input data that is returned to the owner-controller.
Input Module Tags This section describes the tags that are associated with the 5059-IF4IH, 5069-IF8, 5069-IY4,
and 5069-IY4K modules. For more information, see View the Tags.
Configuration Tags - 5069-IF4IH, 5069-IF8, 5069-IY4, 5069-IY4K
Valid Values
Name Size Description
5069-IF4IH 5069-IF8 5069-IY4, 5069-IY4K
The CJ measurement is not used when the module
calculates the CJ compensation.
There are two CJ measurements that can be taken on
the module. The combination of configuration values
determines how CJ compensation is affected. Consider
the following: • 0 = Cold junction measurement is used to calculate CJ
CJChxx.Disable BOOL • If you enable CJCh00 and CJCh01 measurements, both compensation
measurements are used to calculate CJ • 1 = Cold junction measurement is not used to calculate CJ
compensation. compensation
• If you enable only one CJChxx measurement, only that
measurement is used to calculate CJ compensation.
• If you disable both CJChxx measurements, it is
assumed that the cold junction temperature is 0 in the –
CJ compensation.
Indicates if the cold junction sensor is mounted on a
remote termination block when set, rather than on the
• 0 = Cold junction sensor is not mounted on a remote
local terminal block. Needed for proper cold junction termination block
CJChxx.Remote BOOL compensation when you have linear thermocouples.
If the cold junction sensor is mounted on a remote • 1 = Cold junction sensor is mounted on a remote termination
block
termination block, CJCh00 is used with channels 00 and
01, and CJCh01 is used with channels 02 and 03.
Offset added directly to the measured CJ temperature.
CJChxx.SensorOffset REAL Used to compensate for cold junction temperature Any
sensor error.
• 0 = -10…10V
• 1 = 0…5V
• 2 = 0…10V
• 0 = -10…10V • 4 = 0…20 mA
• 1 = 0…5V • 5 = 4…20 mA
Chxx.Range SINT Channel’s operating range – • 2 = 0…10V • 6 = -100...100 mV
• 4 = 0…20 mA • 7 = unused
• 5 = 4…20 mA • 8 = 1…500 Ω
• 9 = 2…1,000 Ω
• 10 = 4…2,000 Ω
• 11 = 8…4,000 Ω
• 0 = 10 Hz (simultaneous • 8 = 5000 Hz
50/60Hz rejection) • 9 = 10,000 Hz
• 1 = 50 Hz • 10 = 15,625 Hz
• 2 = 60 Hz • 11 = 25,000 Hz
Chxx.NotchFilter SINT Notch Filter removes line noise for the channel. • 3 = 100 Hz • 12 = 31,250 Hz
• 4 = 200 Hz • 13 = 5 Hz
• 5 = 500 Hz • 14 = 62,500 Hz
• 6 = 1000 Hz • 15 = 15 Hz
• 7 = 2500 Hz • 16 = 20 Hz
RTD Mode:
• 0 = no linearization, Ω
• 1 = 100 Ω Platinum 385
• 2 = 200 Ω Platinum 385
• 3 = 500 Ω Platinum 385
• 4 = 1000 Ω Platinum 385
• 5 = 100 Ω Platinum 3916
• 6 = 200 Ω Platinum 3916
• 7 = 500 Ω Platinum 3916
• 8 = 1000 Ω Platinum 3916
• 9 = 10 Ω Copper 427
• 10 = 120 Ω Nickel 672
• 11 = 100 Ω Nickel 618
• 12 = 120 Ω Nickel 618
Displays the selected type for the RTD or Thermocouple • 13 = 200 Ω Nickel 618
Chxx.SensorType SINT sensor. –
• 14 = 500 Ω Nickel 618
Thermocouple Mode:
• 0 = mV
• 1=B
• 2=C
• 3=E
• 4=J
• 5=K
• 6=N
• 7=R
• 8=S
• 9=T
• 10 = TXK/XK (L)
DiagnosticSequence Increments for each time a distinct diagnostic condition is detected, and when a distinct diagnostic
SINT condition transitions from detected to not detected. -128…+127
Count Wraps from 255 or -1 to 1, and skips zero. A module reset or power cycle sets this bit to 0.
• 0 = Good
• 1 = Bad, causes a fault
Indicates that the data is inaccurate and cannot be trusted for use in the application. These are the typical causes of fault data.
Chxx.Fault, CJChxx.Fault BOOL If the tag is set to 1, you must troubleshoot the module to correct the cause of the inaccuracy. – Channel is disabled
IMPORTANT: Once the condition that causes the tag to change to 1 is removed, the tag automatically – Open Wire condition
resets to 0. – Underrange/Overrange condition
– Short Circuit condition
We recommend that you first troubleshoot the
module to see if the typical causes exist.
• 0 = Good data
• 1 = Uncertain data
Indicates that the last attempted Calibration for this channel failed or there is no calibration data
• 0 = Calibration did not fail
Chxx.CalFault BOOL present. • 1 = Calibration failed
This tag is cleared, that is, set to 0, when power is cycled to the module.
• 0 = Channel calibration is not in progress
Chxx.Calibrating BOOL Indicates that the channel calibration is in progress. • 1 = Channel calibration is in progress
Indicates that a valid Low Reference signal has been sampled on this channel. • 0 = Valid Low Reference signal has not been
Chxx.CalGoodLowRef BOOL IMPORTANT: This tag is available only when you select the Data with Calibration sampled on this channel
connection type in the Module Definition. If you select the Data connection type, this tag • 1 = Valid Low Reference signal has been sampled
does not appear in the module tags. For more information, see Module Definition. on this channel
Indicates that an invalid Low Reference signal has been sampled on the channel. You
must correct this condition to calibrate the module.
If calibration is aborted with an invalid Low Reference signal, the Chxx.CalFault tag is set • 0 = Invalid Low Reference signal has not been
sampled on this channel
Chxx.CalBadLowRef BOOL for this channel until a successful calibration is performed. • 1 = Invalid Low Reference signal has been
IMPORTANT: This tag is available only when you select the Data with Calibration
connection type in the Module Definition. If you select the Data connection type, this tag sampled on this channel
does not appear in the module tags. For more information, see Module Definition.
Indicates that a valid High Reference signal has been sampled on this channel. • 0 = Valid High Reference signal has not been
IMPORTANT: This tag is available only when you select the Data with Calibration sampled on this channel
Chxx.CalGoodHighRef BOOL connection type in the Module Definition. If you select the Data connection type, this tag • 1 = Valid High Reference signal has been sampled
–
does not appear in the module tags. For more information, see Module Definition. on this channel
Indicates that an invalid High Reference signal has been sampled on this channel.
You must correct this condition to calibrate the module.
If calibration is aborted with an invalid High Reference signal, the Chxx.CalFault tag is set • 0 = Invalid High Reference signal has not been
sampled on this channel
Chxx.CalBadHighRef BOOL for this channel until a successful calibration is performed. • 1 = Invalid High Reference signal has been
IMPORTANT: This tag is available only when you select the Data with Calibration
connection type in the Module Definition. If you select the Data connection type, this tag sampled on this channel
does not appear in the module tags. For more information, see Module Definition.
Indicates that calibration on this channel is complete and the Calibrating state has been
exited. • 0 = Calibration was not successful
This tag remains set after valid calibration as long as the connection is open. • 1 = One of the following:
Chxx.CalSuccessful BOOL
IMPORTANT: This tag is available only when you select the Data with Calibration • Calibration is complete and successful.
connection type in the Module Definition. If you select the Data connection type, this tag • Calibration data is present and applied.
does not appear in the module tags. For more information, see Module Definition.
Chxx.Data REAL Channel data in scaled Engineering engineering units. Any positive or negative value.
A 15 timer that runs continuously and counts in milliseconds.
Chxx.RollingTimestamp INT The value of RollingTimestamp is recorded whenever a module scans its channels. 0…32767
The controller program uses the last two rolling timestamp values to calculate the amount of time
between the samples.
Chxx.HAlarmUnlatch BOOL Unlatches a latched High Alarm when the bit first transitions from 0 to 1. • 0 = High Alarm remains latched
• 1 = High Alarm unlatches
• 0 = High High Alarm remains latched
Chxx.HHAlarmUnlatch BOOL Unlatches a set High High Alarm when the bit first transitions from 0 to 1. • 1 = High High Alarm unlatches
• 0 = Rate Alarm remains latched
Chxx.RateAlarmUnlatch BOOL Unlatches a set Rate Alarm when the bit first transitions from 0 to 1.
• 1 = Rate Alarm unlatches
Initiates the Calibration process.
This tag must remain set until a valid Low Reference and High Reference values are applied to • 0 = Calibration process is not started
Chxx.Calibrate BOOL the input. If the tag value transitions to 0 before calibration is finished, the process stops and • 1 = Calibration process is started
calibration fails.
The rising edge triggers the Low Calibration at the Low Reference Point for the current input
range value.
A valid Low Reference signal must be connected to the channel before you set this tag. • 0 = Low Reference Signal is not applied to the RTB
Chxx.CalLowRef BOOL
IMPORTANT: This tag is available only when you select the Data with Calibration connection • 1 = Low Reference Signal is applied to RTB
type in the Module Definition. If you select the Data connection type, this tag does not appear in
the module tags. For more information, see Module Definition.
The rising edge triggers a High Calibration at the High Reference Point for the current input
range value.
A valid High Reference signal must be connected to the channel before you set this tag. • 0 = High Reference Signal is not applied to the RTB
Chxx.CalHighRef BOOL
IMPORTANT: This tag is available only when you select the Data with Calibration connection • 1 = High Reference Signal is applied to RTB
type in the Module Definition. If you select the Data connection type, this tag does not appear in
the module tags. For more information, see Module Definition.
Compensates for any known offset error on the sensor or channel to which the sensor is
Any valid float value, 0.0 = default
Chxx.SensorOffset REAL connected, and is in terms of engineering units. We recommend that you use a value in the channel’s
The value of this tag is added to the measured value in engineering units and is used in the
Chxx.Data input tag. operating range.
Output Module Tags These tables describe the tags that are associated with the 5069-OF4, 5069-OF4K, 5069-OF4IH,
and 5069-OF8 modules. For more information, see View the Tags.
Configuration Tags - 5069-OF4, 5069-OF4K, 5069-OF4IH, 5069-OF8
Valid Values
Name Size Definition
5069-OF4IH 5069-OF4, 5069-OF4K, 5069-OF8
• 0 = -10…10V
• 1 = 0…5V
Chxx.Range SINT Channel’s operating range – • 2 = 0…10V
• 4 = 0…20 mA
• 5 = 4…20 mA
• 0 = Alarms are enabled
Chxx.AlarmDisable BOOL Disables all alarms on the channel. • 1 = Alarms are disabled (default)
• 0 = Latching disabled (default)
Chxx.LimitAlarmLatchEn BOOL Configures Limit alarms to latch until they are explicitly unlatched.
• 1 = Latching enabled
Chxx.RampAlarmLatchEn BOOL Latches Ramp alarm when set so that it does not clear until manually unlatched. • 0 = Latching disabled (default)
• 1 = Latching enabled
• 0 = Disabled (default)
Chxx.NoLoadEn BOOL Enable the input No Load diagnostic • 1 = Enabled
• 0 = Channel is enabled (default)
Chxx.Disable BOOL Disables the channel.
• 1 = Channel is disabled
Determines output action when a connection fault occurs.
At the fault occurrence, the output holds its last state or transitions to the value
Chxx.FaultMode BOOL set in the Fault Value parameter. • 0 = Transition to user-defined value
• 1 = Hold Last State (default)
The channel continues the Fault Mode for the length of time set in the Fault Value
State Duration parameter.
Determines output action when the controller transitions to Program mode or the
connection to the module is inhibited. • 0 = Transition to user-defined value
Chxx.ProgMode BOOL
At the transition to Program mode, the output holds its last state or transitions to • 1 = Hold Last State (default)
the value set in the Program Value parameter.
Determines channel action if a connection faults while the module is in a safe
state for Program mode.
Chxx.ProgramToFaultEn BOOL The channel can remain in the safe state for Program mode or transition to a safe • 0 = Remains in the Program state
state for Fault mode. • 1 = Transitions to the safe state for the Fault mode
If the channel remains in a safe state for Program mode, the Final Fault State
parameter is ignored.
Chxx.RampInRun BOOL Enables Output Ramping when the module is in Run mode. • 0 = Ramping disabled (default)
Output changes in Run mode are limited to the Maximum Ramp Rate value. • 1 = Ramping enabled in Run mode
Enables Output Ramping when the controller transitions to Program mode. • 0 = Ramping disabled (default)
Chxx.RampToProg BOOL Output changes in Program mode are limited to the Maximum Ramp Rate value. • 1 = Ramping enabled to Program mode state
Enables Output Ramping when the connection to the module faults.
• 0 = Ramping disabled (default)
Chxx.RampToFault BOOL Output transitions to FaultValue and FaultFinalState are limited to the • 1 = Ramping enabled to Fault mode state
MaximumRampRate.
Instructs the channel to hold the last signal until it is initialized with a value within
0.1% of full-scale of its current value when one of these conditions occurs.
Chxx.HoldForInit BOOL • Module initial connection (power up) • 0 = Output O.Chxx.Data signal immediately
• Controller transition from Program mode back to Run mode • 1 = Hold last signal until initialization match
• Module re-establishes communication after a fault
• SA power is restored after being lost.
Chxx.FaultValue Determines the length of time the FaultMode or FaultValue parameter value is held • 0 = Hold forever (default)
StateDuration SINT before the Final Fault State. • 1, 2, 5, or 10 seconds
Maximum rate at which the channel can transition to in Engineering Units/s.
Any value > 0.0
This tag is used only if at least one of these output ramping modes is enabled: 1,000,000.00 = default
Chxx.MaxRampRate REAL • Ramp In Run
• Ramp To Fault If the MaxRampRate = 0.0, the ramp rate is limited to ramping the range
full scale in one RPI.
• Ramp To Program
Current applications - Any value less than the high signal in the range.
• 0 = default for 0…20 mA range
Corresponds to the low engineering term when scaled, and is in terms of the input • 4 = default for 4…20 mA
Chxx.LowSignal REAL
signal units. Voltage applications - Any value less than the high signal in the range.
• -10 = default for -10…10V range
• 0 = default for 0…5V and 0…10V range
Current applications - Any value greater than the low signal in the
range, 20 = default for either current input range
Corresponds to the high engineering term when scaled, and is in terms of the input Voltage applications - Any value greater than the low signal in the
Chxx.HighSignal REAL signal units. range.
• 10 = default for 0…10V and -10…10V ranges
• 5 = default for 0…5V range
Current applications - Any value less than the high engineering value,
0.0 = default
Determines the engineering units that the signal values scale into. Corresponds to
Chxx.LowEngineering REAL the low signal value. Voltage applications - Any value less than the high engineering value,
Low signal = default.
For example, with the -10…10V range, the default = -10.
Chxx.HighLimit REAL The highest value to which the output can go based on the operating range that Any value higher than the LowLimit
the Output Clamping feature establishes. The tag value is in engineering units. 0.0 = default
Compensates for any known error on the sensor or channel to which the sensor is Any value - We recommend that you use a small value.
Chxx.Offset REAL connected. The tag value is in engineering units. 0.0 = default
The output changes to this value if these events exist.
• Fault Mode = 0
• Either of the following: Any value
Chxx.FaultValue REAL – The controller is in Run mode and the connection is lost 0.0 = default
– The controller is in Program mode, the connection is lost, and the
ProgamToFaultEn tag is set
The channel changes to this value if these events exist.
Chxx.ProgValue REAL • Program Mode = 0 Any value
0.0 = default
• Controller transitions to Program mode
The channel changes to this value if these events exist.
• Connection is lost
• The time that the FaultValueStateDuration parameter defines has been Any value
Chxx.FaultFinalState REAL
exceeded 0.0 = default
Output transitions to FaultValue and FaultFinalState are limited to the
MaximumRampRate.
Chxx.ShortCircuit BOOL A Short Circuit or Overcurrent condition exists. • 0 = No Short Circuit or Overcurrent condition exists
This condition is detected only when the channel is used in voltage mode. • 1 = Short Circuit or Overcurrent condition exists
The module is higher temperature than its operating limits.
If this tag is set to 1 but a fault does not exist on the channel, this tag is only an indication • 0 = Module temperature is not over the operating limits
Chxx.OverTemperature BOOL
of operating conditions but the channel is functioning. • 1 = Module temperature is over the operating limits
If this tag is set to 1 and a fault exists on the channel, the channel is not functioning.
Chxx.RampAlarm BOOL Indicates that the analog output has been commanded to change value in a way such • 0 = Alarm is not triggered
that the Maximum Ramp Rate is exceeded • 1 = Alarm is triggered
Indicates that the last attempted Calibration for this channel failed. • 0 = Calibration did not fail
Chxx.CalFault BOOL This tag is cleared, that is, set to 0, when power is cycled to the module. • 1 = Calibration failed
• 0 = Channel calibration is not in progress
Chxx.Calibrating BOOL Indicates that the channel calibration is in progress.
• 1 = Channel calibration is in progress
Indicates that a valid Low Reference measurement was passed through
the output tag to the module. • 0 = Valid Low Reference measurement was not passed to the
Chxx.CalGoodLowRef BOOL IMPORTANT: This tag is available only when you select the Data with module
Calibration connection type in the Module Definition. If you select the Data • 1 = Valid Low Reference measurement was passed to the
connection type, this tag does not appear in the module tags. For more module
information, see Module Definition.
Indicates that an invalid Low Reference signal has been sampled on the
channel. You must correct this condition to calibrate the module.
If calibration is aborted with an invalid Low Reference signal, the
• 0 = Invalid Low Reference signal has not been sampled on
Chxx.CalFault tag is set for this channel until a successful calibration is this channel
Chxx.CalBadLowRef BOOL performed.
IMPORTANT: This tag is available only when you select the Data with • 1 = Invalid Low Reference signal has been sampled on this
channel
Calibration connection type in the Module Definition. If you select the Data
connection type, this tag does not appear in the module tags. For more
information, see Module Definition.
Indicates that a valid High Reference measurement was passed through
the output tag to the module. • 0 = Valid High Reference measurement was not passed to the
IMPORTANT: This tag is available only when you select the Data with module
Chxx.CalGoodHighRef BOOL Calibration connection type in the Module Definition. If you select the Data • 1 = Valid High Reference measurement was passed to the
– connection type, this tag does not appear in the module tags. For more module
information, see Module Definition.
Indicates that an invalid High Reference signal has been sampled on this
channel.
You must correct this condition to calibrate the module.
If calibration is aborted with an invalid High Reference signal, the • 0 = Invalid High Reference signal has not been sampled on
Chxx.CalFault tag is set for this channel until a successful calibration is this channel
Chxx.CalBadHighRef BOOL
performed. • 1 = Invalid High Reference signal has been sampled on this
IMPORTANT: This tag is available only when you select the Data with channel
Calibration connection type in the Module Definition. If you select the Data
connection type, this tag does not appear in the module tags. For more
information, see Module Definition.
Indicates that calibration on this channel is complete and the Calibrating
state has been exited.
This tag remains set after valid calibration as long as the connection is
open. • 0 = Calibration was not successful
Chxx.CalSuccessful BOOL IMPORTANT: This tag is available only when you select the Data with • 1 = Calibration is complete and successful.
Calibration connection type in the Module Definition. If you select the Data
connection type, this tag does not appear in the module tags. For more
information, see Module Definition.
Chxx.Data REAL Indicates the current RTB output signal value in scaled engineering units. Any positive or negative value.
A 15 timer that runs continuously and counts in milliseconds.
Chxx.RollingTimestamp INT Whenever the data echo value changes, the output module updates the value of the 0…32767
RollingTimestamp.
A transition from 0 to 1 indicates that the Chxx.Data output tag data contains the • 0 = Not sending Recorded Cal Low Ref
Chxx.CalLowRefPassed BOOL • 1 = Sending Recorded Cal Low Reference in Output Data for
recorded Low Reference value for the channel that the module uses in Calibration. Calibration Verification
A transition from 0 to 1 indicates that the Chxx.Data output tag data contains the • 0 = Not sending Cal High Reference
Chxx.CalHighRefPassed BOOL recorded High Reference value for the channel that is the module uses in • 1 = Sending recorded Calibration High Reference Signal in Output
Calibration. Data for Calibration Verification
Data value change that triggers the channel to complete the Calibration procedure,
Chxx.CalFinishCalibration BOOL and to apply the received valid Low and High References. • 0 = Channel not triggered to complete the calibration procedure
• 1 = Channel triggered to complete the calibration procedure
Channel exits the Calibration state if successful.
Chxx.Data REAL The value that is converted to the signal on the RTB in scaled engineering units. Any valid engineering unit
HART Device Tags These tables describe the tags that are associated with HART devices.
CurrentFixed BOOL The loop current is being held at a fixed value and is not responding to process variations. • 0 = Current not fixed
• 1 = Current fixed
More status information is available than can be returned in the Field Device Status.
MoreStatusAvailable BOOL HART CMD #48, Read Additional Status Information, provides this additional status • 0 = More status not available
• 1 = More status available
information.
CurrentMismatch BOOL Set to 1 if the HART digital value does not match analog module channel value. • 0 = Current match
• 1 = Current mismatch
Set to 1 after the HART device configuration changes and the module retrieves all HART device
configuration data that the Get HART Device Information service returns. The Studio 5000
Logix Designer application uses this bit to perform logic when the HART device configuration
has changed.
ConfigurationChanged BOOL For more information on how to use the command, see Configuration Change Notification. • 0 = Configuration not changed
• 1 = Configuration changed
Note: If the HART device does not support HART CMD #38, only the first configuration change
after the device start up can be detected and ConfigurationChanged in the input tag is set. All
configuration changes after that are not detectable and ConfigurationChanged in the input
tag is not set for these changes.
Indicates that the device detects a hardware error or failure. Further information may be • 0 = No hardware error or failure is
Malfunction BOOL detected
available through HART CMD #48. • 1 = Hardware error or failure is detected
The bit is set to 1 in these conditions.
• Device Malfunction in Field Device Status is set in the response of HART CMD
#3/#9.
• Loop Current Saturated in Field Device Status is set in the response of any
HART command.
• The command response returns any of these items. • 0 = Normal good data
LoopCurrent.Fault BOOL – HART command is not successful • 1 = Data is definitely bad
– No valid command response after three attempts
– Communication error
– Response Code indicates an error
• The value that is returned is NAN (there are no reported cases of this).
For • The Underrange or Overrange bit is set.
PlantPAx® This tag is to 1 when Loop Current Fixed in the Field Device Status is set in • 0 = No question about data validity
LoopCurrent.Uncertain BOOL connections response to HART CMD #3. • 1 = Data validity is questionable
only
LoopCurrent.Underrange BOOL The input signal at the channel is less than or equal to the minimum detectable • 0 = Loop Current > 3.8 mA
signal. • 1 = Loop Current is ≤ 3.6 mA
The input signal at the channel is greater than or equal to the maximum • 0 = Loop Current is < 20.5 mA
LoopCurrent.Overrange BOOL detectable signal. • 1 = Loop Current is ≥ 21.0 mA
LoopCurrent.Data REAL Current loop current value, Floating Point. Any positive or negative value
A 15-bit timer that runs continuously and counts in milliseconds (unrelated to
the CST).
LoopCurrent.RollingTimestamp INT The value of RollingTimestamp is recorded whenever a module scans its 0…32767
channels. The controller program uses the last two rolling timestamp values to
calculate the amount of time between the samples.
Indicates that the data is inaccurate and cannot be trusted for use in the application.
• <NameOfVariable> could be PV, SV, TV, QV, or <NameOfDeviceVariable>
• For PlantPAx connections only - <NameOfVariable> could be LoopCurrent
IMPORTANT: Once the condition that causes the tag to change to 1 is removed, the tag
automatically resets to 0.
The bit is set to 1 in these conditions.
• Device Malfunction in the field device status is set in the response of the command to
retrieve this HART variable.
• The command response returns any of these items.
– HART command is not successful • 0 = Good
<NameOfVariable>.Ch.Fault BOOL
– No valid command response after three attempts • 1 = Bad, causes a fault
– Communication error
– Response Code indicates an error
• The HART variable value that is returned is NAN.
• The device variable status indicates “process data status bad”.
• If this Device Variable is PV – when “primary variable out of limits in the field device status”
is set in the response of the command to retrieve PV.
• For HART 5 and 6 devices, and if this variable is SV, TV, or QV, when “non PV out of limits in
field device status” is set in the response of the command to retrieve this HART variable.
• The Underrange or Overrange bit is set.
Indicates that the channel data can be inaccurate but the degree of inaccuracy is not known.
IMPORTANT: Once the condition that causes the tag to change to 1 is removed, the tag
automatically resets to 0. • 0 = Good data
<NameOfVariable>.Ch.Uncertain BOOL
The bit is set to 1 in these conditions. • 1 = Uncertain data
• The device variable status is Process Data Status Manual/Fixed or Poor Accuracy.
• The device variable status is Limit Status Constant and process data status is Not Bad.
Indicates that the input signal at the channel is less than, or equal to, the minimum detectable
• 0 = Not underrange
<NameOfVariable>.Ch.Underrange BOOL signal. • 1 = Underrange
The bit is set to 1 when the device variable status is Low Limited.
Indicates that the input signal at the channel is greater than, or equal to, the maximum
• 0 = Not overrange
<NameOfVariable>.Ch.Overrange BOOL detectable signal. • 1 =Overrange
The bit is set to 1 when the device variable status is High Limited.
The last good value received from the device.
<NameOfVariable>.Ch.Data REAL If a value has not yet been received from the device, the value is 0.0. Any positive or negative value
A 15-bit timer that runs continuously and counts in milliseconds. It is not related to CIP Sync™.
<NameOfVariable>. The value of RollingTimestamp is recorded whenever a module scans its channels. The
controller program uses the last two rolling timestamp values to calculate the amount of time 0…32767
INT
Ch.RollingTimestamp
between the samples.
Device Variable Classification
<NameOfVariable>.Class USINT
If the HART device does not support device variables, this bit is set to 0. 0…255
<NameOfVariable>.Unit USINT Unit code of the variable. 0…255
Indicates that the data value is manually controlled.
• 0 = Data is not manual
<NameOfVariable>.Manual BOOL It is set to 1 when the device variable status is Process Data Status Manual/Fixed and the limit • 1 = Data is manual
status is Not Limited.
Indicates that the data value is constant. • 0 = Data is not constant
<NameOfVariable>.Constant BOOL It is set to 1 when the variable status is Constant. • 1 = Data is constant
• 0 = Static data is good
Static.Fault BOOL Indicates if the set of static data is valid.
• 1 = Static data is bad
Static.PVUnit USINT Unit code of PV. 1…253
Static.HARTRevision USINT HART protocol major revision number. 5, 6, or 7
Static.HARTTagName STRING Assigned name of HART device. Same as Identity attribute 15. String with 32 characters, max
Static.Descriptor STRING Descriptor of HART device. String with 16 characters, max
For PlantPAx
Static.PVAtSignal4 REAL connections PV Lower Range value. Any value less than Static.PVAtSignal20
Static.PVAtSignal20 REAL only PV Higher Range value. Any value greater than Static.PVAtSignal4
• 0 = More status not available
Static.AdditionalDeviceStatus SINT[25] Additional Device Status from HART CMD #48. • 1 = More status available
This member is the engineering unit value of 4 mA according to the
ChDataAtSignal4 REAL Any value less than ChDataAtSignal20
corresponding analog input channel configuration of the module.
ChDataAtSignal20 REAL This member is the engineering unit value of 20 mA according to the Any value greater than ChDataAtSignal4
corresponding analog input channel configuration of the module.
Indicates that the data value is constant and that it is ready for a new command execution.
<NameOfCommand>.ReadyToExecute BOOL The bit is set to 1 when the variable status is Constant. • 0 = Ready to accept a new execution
• 1 = Not ready to accept a new execution
For more information, see Execute HART Commands Through Producer/Consumer Data.
• 0 = No command has been completed or
Indicates that the command execution is complete. the current command execution is in
<NameOfCommand>.Completed BOOL For more information, see Execute HART Commands Through Producer/Consumer Data. progress
• 1 = Execution has been completed
• 0 = No command has been completed or
Indicates that the command execution is on-going. the current command execution is in
<NameOfCommand>.Active BOOL For more information, see Execute HART Commands Through Producer/Consumer Data. progress
• 1 = Execution has been completed
Notes:
Topic Page
Create User-defined Diagnostic Assembly Types 155
Configure the Message Type User Tags 160
This appendix explains how to create and configure Diagnostic Assembly types for the
HART I/O Modules.
Create User-defined Use the Studio 5000 Logix Designer® application to create user-defined Diagnostic Assembly
and Channel Data types for the HART I/O modules. From the Controller Organizer pane, expand
Diagnostic Assembly Types Data Types to configure each data type. The Channel Data types must be retrieved as a part of
the Diagnostic Assemblies Instance.
IMPORTANT The members that are indicated in the tables are arranged according to the
Data Alignment Rules of controllers. If you do not strictly follow the Data
Type and sequence of the members that are indicated in these tables, data
misalignment can occur after a Get Attribute Single Message Instruction.
Data
Member Type Bytes Valid Values
0 = Idle
RunMode
1 = Run
InfoBits_Pad1 These data types act as padding to achieve byte alignment. They can be
renamed.
0 = No diagnostics are active.
DiagnosticActive 1 = One or more diagnostics are active or the prognostics threshold is reached.
0 = CIP Sync™ is not available.
CIPSyncValid
1 = CIP Sync is available.
BOOL 0 = A valid time leader has not timed out.
1 = A valid time leader was detected on the backplane, but the time leader has
CIPSyncTimeout timed out. The module is using its local clock and can be drifting away from the
last known time leader.
1
InfoBits_Pad2 These data types act as padding to achieve byte alignment. They can be
renamed.
1 = Field Power is not present.
FieldPowerOff 0 = Field Power is present.
InfoBits_Pad3 These data types act as padding to achieve byte alignment. They can be
renamed.
0…255
Count that increases in these conditions.
• Each time a distinct diagnostic condition is detected, and
DiagnosticSequence Count SINT • Each time a distinct diagnostic condition transitions from detected to not
detected.
Wraps from 255 to 1, and skips zero. A device reset or power cycle sets the
count to 0.
Diagbits_Pad1…
Diagbits_Pad12 –
0 = Flash update is not required.
FlashUpdateRequired
1 = Flash update is required.
BOOL 2
SelfTestFault 0 = Module initialization code did not detect an error.
1 = Module initialization code detected an error.
Diagbits_Pad13…
Diagbits_Pad14 –
Pad DINT 4
The offset in nanoseconds from the local clock to the system time. Use this
LocalClockOffset value to detect steps in time. This value updates when a Precision Time
Protocol (PTP) update is received.
LINT
The time when the Local Clock Offset was most recently sampled. The initial
LocalClockOffset Timestamp value is zero and the first time stamp occurs when the module synchronizes
8 with the leader clock.
GrandMasterClockID SINT[8] The EUI-64 Identity of the CIP Sync Grand leader clock to which the module is
synced.
FieldPowerOnTimestamp The most recent time when the field power transitioned from off to on.
LINT
FieldPowerOffTimestamp The most recent time when the field power transitioned from on to off.
Diag_Channel_00
Diag_Channel_01 User
288 See AB:5000_AI_Channel:D:1
Diag_Channel_02 defined
Diag_Channel_03
AB:5000_AI_Channel:D:1
Data
Member Bytes Valid Values
Type
DataBits_Pad1 –
0 = No fault exists.
1 = A fault exists.
A fault is a roll-up of all diagnostic conditions that the module can detect and
Fault indicates bad data. If there is a detailed data type member that indicates a given
detected condition, this fault member does not affect the DiagnosticActive or
DiagnosticSequenceCount members. However, if there is no detailed data type for
a given detected condition, this fault member triggers both the DiagnosticActive
member and increases or decreases the Diagnostic Sequence Count.
0 = Data is valid.
Uncertain 1 = Data validity is uncertain. The device is operating outside of the designed
operating range, or the data is under manual or override control.
0 = The signal wire is connected to the channel or RTB, or open wire detection
OpenWire is disabled.
1 = The signal wire is disconnected from the channel or RTB.
DataBits_Pad2 –
0 = Module temperature is not over the operating limits.
OverTemperature
1 = Module temperature is over the operating limits.
RunMode 0 = Idle
1 = Run
InfoBits_Pad1 These data types act as padding to achieve byte alignment. They can be renamed.
0 = No diagnostics are active.
DiagnosticActive 1 = One or more diagnostics are active or the prognostics threshold is reached.
0 = CIP Sync is not available
CIPSyncValid
1 = CIP Sync is available
BOOL 0 = A valid time leader has not timed out.
1 = A valid time leader was detected on the backplane, but the time leader has
CIPSyncTimeout timed out. The module is using its local clock and can be drifting away from the
1 last known time leader.
InfoBits_Pad2 These data types act as padding to achieve byte alignment. They can be renamed.
FieldPowerOff 1 = Field Power is not present.
0 = Field Power is present.
InfoBits_Pad3 These data types act as padding to achieve byte alignment. They can be renamed.
0…255
Count that increases in these conditions.
• Each time a distinct diagnostic condition is detected, and
DiagnosticSequence SINT • Each time a distinct diagnostic condition transitions from detected to not
Count
detected.
Wraps from 255 to 1, and skips zero. A device reset or power cycle sets the count
to 0.
Diagbits_Pad1…
–
Diagbits_Pad12
FlashUpdateRequired 0 = Flash update is not required.
1 = Flash update is required.
BOOL 2
0 = Module initialization code did not detect an error.
SelfTestFault 1 = Module initialization code detected an error.
Diagbits_Pad13…
Diagbits_Pad14 –
Pad DINT 4
LocalClockOffset The offset in nanoseconds from the local clock to the system time. Use this value
to detect steps in time. This value updates when a PTP update is received.
LINT The most-recent time when the Local Clock Offset was sampled. The initial value
LocalClockOffset is zero and the first time stamp occurs when the module synchronizes with the
Timestamp
leader clock.
GrandMasterClockID SINT[8] 8 The EUI-64 Identity of the CIP Sync Grandmaster clock that the module is synced
to.
FieldPowerOn
Timestamp The most-recent time when the field power transitioned from off to on.
LINT
FieldPowerOff
The most-recent time when the field power transitioned from on to off.
Timestamp
Diag_Channel_00… User 256 See AB:5000_AO_Channel:D:1
Diag_Channel_03 defined
AB:5000_AO_Channel:D:1
Data
Member Bytes Valid Values
Type
DataBits_Pad1 –
0 = No fault exists.
1 = A fault exists.
A fault is a roll-up of all diagnostic conditions that the module can detect and
Fault indicates bad data. If there is a detailed data type member that indicates a given
detected condition, this fault member does not affect the DiagnosticActive or
DiagnosticSequenceCount members. However, if there is no detailed data type for
a given detected condition, this fault member triggers both the DiagnosticActive
member and increments/decrements the Diagnostic Sequence Count.
0 = Data is valid.
Uncertain BOOL 1 = Data validity is uncertain. The module is operating outside its designed
operating range, or data is under manual or override control.
NoLoad 0 = No Load condition is not detected.
1 = No Load condition is detected.
2 0 = No short circuit or over current is detected.
ShortCircuit 1 = A short circuit or over current is detected.
0 = Module temperature is not over the operating limits.
OverTemperature
1 = Module temperature is over the operating limits.
FieldPowerOff 0 = Field power is present.
1 = Field power is not present.
DataBits_Pad2…
DataBits_Pad10 SINT –
Configure the Message Create Message type user tags for requests and associated response user tags for each of the
new user-defined diagnostic assembly types.
Type User Tags
From the Controller Organizer pane, select Tasks > MainTask > MainProgram.
1. Create the Message type user tags for each request.
2. Create the associated response user tags for each new user-defined diagnostic
assembly type.
3. Add the user tags to your ladder program.
4. Click the … button to open the message configuration page.
6. On the Communication tab, select the path to the module to which you wish to send the
messages.
7. Download the project and set it to Run mode.
You can monitor the user-defined tag values from the Program Parameters and Local Tags
window.
These tables provide guidelines for communicating with ControlLogix® 5580 controllers that
use CIP™.
104 MessageString USINT[32] (32 bytes CMD#12, Byte 0…23, unpacked to normal ASCII representation
unpacked ASCII) MessageSize and MessageString combine to form a standard Logix String data type.
136 PVCode CMD#50, Byte 0, 0xff if not supported. PV assignment code
137 SVCode CMD#50, Byte 1, 0xff if not supported. SV assignment code
138 TVCode CMD#50, Byte 2, 0xff if not supported. TV assignment code
139 QVCode CMD#50, Byte 3, 0xff if not supported. QV assignment code
140 PVUnits CMD#3, Byte 4
USINT
141 SVUnits CMD#3, Byte 9, 0 if not present
142 TVUnits CMD#3, Byte 14, 0 if not present
143 QVUnits CMD#3, Byte 19, 0 if not present
144 TransferFunction CMD#15, Byte 1
145 RangeUnits CMD#15, Byte 2
146 Pad 3 for alignment Octet [2] The value is 0.
148 PVUpperRange CMD#15, Bytes 3…6
152 PVLowerRange REAL CMD#15, Bytes 7…10
156 DampingValue CMD#15, Bytes 11…14
160 WriteProtectCode USINT CMD#15, Byte 15
161 Pad 4 for alignment Octet [3] The value is 0.
Numerics configuration 32
5069-AEN2TR adapter Compact 5000 I/O system 23
connect power electronic keying 34
power supply consideration 19 HART device 117
5069-ARM address reserve module 102 I/O module
module definition 104
5069-FPD field potential distributor 20 I/O modules 21
module tags 139
RPI 23
A configure parameters 103
absolute module accuracy 38 HART devices 117
alarm deadband connection 21
5069-IF4IH module 79 Data 104
5069-IF8 module 48 Data with Calibration 104
5069-IY4 and 5069-IY4K modules 61 fault handling
alarms 36 5069-IF4IH module 82
clamp alarming 5069-IF8 module 50
5069-IF4IH module 80 5069-IY4 and 5069-IY4K modules 66
5069-OF4, 5069-OF4K, and 5069-OF8 5069-OF4, 5069-OF4K, and 5069-OF8
modules 69 modules 69
5069-OF4IH module 86 5069-OF4IH module 85
latching 36 inhibit the module 33
process alarm 59 Listen Only 26, 104
process alarms 47, 78 producer-consumer communication 35
rate alarm 61 types 22
5069-IF4IH module 80 connection types
5069-IF8 module 49 HART Devices
unlatching 37 data 117
PLantPAx data 117
I/O modules
C Data 22
Data with Calibration 22
calibration 36, 119 Listen Only 22
absolute module accuracy 38 copper offset
input module 120 5069-IY4 and 5069-IY4K modules 64
output module 125 create new HART device
channel offset 38
add new offline
5069-IF4IH module 80 local 111
5069-OF4, 5069-OF4K, and 5069-OF8 remote 113
modules 68 discover online
5069-OF4IH module 84 local 110
channel output state remote 112
5094-OF4IHS module 84 create new module
5094-OF8IH module 84 add new offline
CIP messages local I/O 97
HART device 138 remote I/O 100
clamp limit discover online
5069-IF4IH module 80 local I/O 96
5069-OF4, 5069-OF4K, and 5069-OF8 remote I/O 99
modules 69
5069-OF4IH module 86
clamping D
5069-OF4, 5069-OF4K, and 5069-OF8 data echo
modules 69 5069-OF4, 5069-OF4K, and 5069-OF8
5069-OF4IH module 85 modules 70
command-response data exchange
communication protocol 29 data echo 70, 86
communication protocol data offset 38
command-response 29 multicast 23
producer-consumer communication 35
scaling signal value to engineering unit 37
unicast 23
T
temperature
effect on module accuracy 38
thermoelectric effect
cold junction compensation 65
troubleshooting 129
input module status indicator 132
module status indicator 131
output module status indicator 133
software 134
U
underrange/overrange detection
5069-IF4IH module 77
5069-IF8 module 46
5069-IY4 and 5069-IY4K modules 58
unicast data exchange method 23
Documentation Feedback
Your comments help us serve your documentation needs better. If you have any suggestions on how to improve our content, complete the
form at rok.auto/docfeedback.
At the end of life, this equipment should be collected separately from any unsorted municipal waste.
Rockwell Automation maintains current product environmental compliance information on its website at rok.auto/pec.
Allen-Bradley, Compact 5000, CompactLogix, ControlLogix, GuardLogix, Integrated Architecture, Kinetix, Logix 5000, PanelView, PlantPAx, Rockwell Software, Rockwell Automation, Stratix,
Studio 5000, and Studio 5000 Logix Designer are trademarks of Rockwell Automation, Inc.
CIP Sync and EtherNet/IP are trademarks of ODVA, Inc.
Trademarks not belonging to Rockwell Automation are property of their respective companies.
Rockwell Otomasyon Ticaret A.Ş. Kar Plaza İş Merkezi E Blok Kat:6 34752, İçerenköy, İstanbul, Tel: +90 (216) 5698400 EEE Yönetmeliğine Uygundur