Module Tag Definitions

Module tags are created when you add a module to the Studio 5000 Logix Designer application project. The set of module tags associated with a module depends on the module type and Device Definition choices made during module configuration. The tables contained in this section list all of the tags available with a module. Not all tags in the list are used when that module type is added to a project. Tag use varies by module configuration.
Configuration Tags
Name
Data Type
Definition
Valid Values
ChxxSourcing
BOOL
Controls whether the channel provides loop power to connected devices.
  • 0 = The channel does not supply loop power. External power must be provided.
  • 1 = The channel supplies loop power.
Chxx.SensorType
SINT
Not applicable
Not applicable to this module
Chxx.NotchFilter
SINT
Notch Filter removes line noise for the channel.
  • 0 = 10 Hz
  • 16 = 20 Hz with 50/60 Hz noise rejection
  • 4 = 200 Hz
  • 21 = 1,200 Hz
  • 22 = 4,800 Hz for non-HART
  • 23 = 9,600 Hz for non-HART
Chxx.AlarmDisable
BOOL
Disables all alarms on the channel.
IMPORTANT: Consider the following:
  • If you change this tag to 0, that is, so that the alarms are not disabled, you must also enable the individual alarms for them to work.
    For example, if you want to use the Low Low Alarm for a channel, you must set the Chxx.AlarmDisable to 0 and set the Chxx.LLAlarmEn output tag to 1 so that the alarm is enabled.
    This applies to all alarms on the module.
  • Conversely, if you set this tag to 1, alarms are disabled regardless of the setting on the alarm enable tag for any alarm.
  • 0 = Alarms are enabled
  • 1 = Alarms are disabled
Chxx.ProcessAlarmLatchEn
BOOL
Configures Process alarms to latch until they are explicitly unlatched.
The Process alarms include:
  • HighHigh Alarm
  • High Alarm
  • Low Alarm
  • LowLow Alarm
  • 0 = Latching disabled
  • 1 = Latching enabled
Chxx.RateAlarmLatchEn
BOOL
Configures the Rate Alarm to latch until it is explicitly unlatched.
  • 0 = Latching disabled
  • 1 = Latching enabled
Chxx.OpenWireEn
BOOL
Configures OpenWire detection when the signal wire is disconnected from one of its channels or the RTB.
  • 0 = OpenWire detection is disabled
  • 1 = OpenWire detection is enabled
Chxx.Disable
BOOL
Disables the channel.
  • 0 = Channel is enabled
  • 1 = Channel is disabled
Chxx.TenOhmOffset
INT
Not Applicable
0
Chxx.DigitalFilter
INT
One of four points used in scaling. The high engineering helps determine the engineering units the signal values scale into. The high engineering term corresponds to the high signal value.
0…32,767 ms
Chxx.LowSignal
REAL
One of four points used in scaling. The high engineering helps determine the engineering units the signal values scale into. The high engineering term corresponds to the high signal value.
Any value
Chxx.HighSignal
REAL
One of four points used in scaling. The high engineering helps determine the engineering units the signal values scale into. The high engineering term corresponds to the high signal value.
Any value
Chxx.LowEngineering
REAL
One of four points used in scaling. The low engineering helps determine the engineering units the signal values scale into. The low engineering term corresponds to the low signal value.
Any value
Chxx.HighEngineering
REAL
One of four points used in scaling. The high engineering helps determine the engineering units the signal values scale into. The high engineering term corresponds to the high signal value.
Any value
Chxx.LLAlarmLimit
REAL
The Low Low Alarm trigger point. Causes the Chxx.LLAlarm to trigger when the input signal moves beneath the configured trigger point. Value is in terms of engineering units.
Any value
Chxx.LAlarmLimit
REAL
The Low Alarm trigger point. Causes the Chxx.LAlarm to trigger when the input signal moves beneath the configured trigger point. Value is in terms of engineering units.
Any value
Chxx.HAlarmLimit
REAL
The High Alarm trigger point. Causes the Chxx.HAlarm to trigger when the input signal moves above the configured trigger point. Value is in terms of engineering units.
Any value
Chxx.HHAlarmLimit
REAL
The High High Alarm trigger point. Causes the Chxx.HHAlarm to trigger when the input signal moves above the configured trigger point. Value is in terms of engineering units.
Any value
Chxx.RateAlarmLimit
REAL
The Rate Alarm trigger point. Causes the Chxx.RateAlarm to trigger when the input signal changes at a rate faster than the configured Rate Alarm. Configured in Engineering Units per second.
0 = Rate Alarm is not used
Any value greater than zero = Trigger point
Chxx.AlarmDeadband
REAL
Allows a process alarm to remain set, despite the alarm condition disappearing, as long as the input data remains within the deadband of the process alarm.
The deadband value is subtracted from the High and High High Alarm Limits to calculate the deadband thresholds for these alarms. The deadband value is added to the Low and Low Low Alarm Limits to calculate the deadband thresholds for these alarms.
Any non-negative value

Input Tag Definitions

Input Tags
Name
Data Type
Definition
Valid Values
RunMode
BOOL
Channel’s operating state
  • 0 = Idle
  • 1 = Run
    When the vallue is 0, it means one of the following:
    • Connection is up.
    • Connection has been opened but the module has not started producing data for the connection.
    • Module is not applying new Output tag data because the controller is in Program Mode.
  • When the value is 1, it means the following:
    • Connection is up.
    • Module is producing data for the connection.
    • Output tag data is being applied.
ConnectionFaulted
BOOL
Indicates if a connection is running.
The module sets this tag to 0 when connected. If the module is not connected, it changes the tag to 1.
  • 0 = A connection exists between the module and the controller
  • 1 = Connection is timed out or inhibited
DiagnosticActive
BOOL
Indicates if any diagnostics are active or if the prognostics threshold is reached.
  • 0 = No diagnostics are active
  • 1 = One or more diagnostics are active or the prognostics threshold is reached.
DiagnosticSequenceCount
SINT
Increments for each time a distinct diagnostic condition is detected, and when a distinct diagnostic condition transitions from detected to not detected.
-128...+127
The value of 0 is skipped except during module powerup.
Chxx.Fault
BOOL
Indicates that channel data is inaccurate and cannot be trusted for use in the application.
If the tag is set to 1, you must troubleshoot the module to correct the cause of the inaccuracy.
IMPORTANT: Once the condition that causes the tag to change to 1 is removed, the tag automatically resets to 0.
  • 0 = No fault exists
  • 1 = Fault exists
Chxx.Uncertain
BOOL
Indicates that the channel data can be inaccurate but the degree of inaccuracy is not known.
If the tag is set to 1, you must troubleshoot the module to correct the cause of the inaccuracy.
IMPORTANT: Once the condition that causes the tag to change to 1 is removed, the tag automatically resets to 0.
  • 0 = Valid data
  • 1 = Data validity uncertain
Chxx.OpenWire
BOOL
The signal wire is disconnected from the channel or the RTB is removed from the module.
  • 0 = Open wire condition does not exist or open wire detection is disabled.
  • 1 = Open wire condition exists, which means the signal wire is disconnected from the channel or the RTB is removed from the module.
Chxx.OverTemperature
BOOL
Not applicable for this module.
N/A
Chxx.FieldPowerOff
BOOL
Field power is not present at the channel.
  • 0 = Field power is present
  • 1 = Field power is not present
Chxx.NotANumber
BOOL
Indicates that the last value received for the channel output data value was not a number.
  • 0 = Last channel data received was a number
  • 1 = Last channel data received was not a number
Chxx.Underrange
BOOL
Indicates that the channel data is beneath the underrange threshold for this channel.
For example, when the channel operates in the 4…20 mA input range, the underrange threshold on the channel is <3.0 mA. If the input signal is 0 mA, this tag is set to 1.
  • 0 = Channel data is not beneath the underrange threshold
  • 1 = Channel data is beneath the underrange threshold
Chxx.Overrange
BOOL
Indicates that the channel data is above the overrange threshold for this channel.
For example, when the channel operates in the 4…20 mA output range, the overrange threshold on the channel is >23.0 mA. If the input signal is 24 mA, this tag is set to 1.
  • 0 = Channel data is not above the overrange threshold
  • 1 = Channel data is above the overrange threshold
Chxx.LLAlarm
BOOL
Triggered when the input data value is less than the Low Low Alarm value.
If latching is enabled, this alarm remains triggered until unlatched. If latching is not enabled, the alarm clears after the input data value is greater than the Low Low Limit plus the Alarm Deadband.
  • 0 = Alarm is not triggered
  • 1 = Alarm is triggered
Chxx.LAlarm
BOOL
Triggered when the input data value is less than the Low Alarm value.
If latching is enabled, this alarm remains triggered until unlatched. If latching is not enabled, the alarm clears after the input data value is greater than the Low Limit plus the Alarm Deadband.
  • 0 = Alarm is not triggered
  • 1 = Alarm is triggered
Chxx.HAlarm
BOOL
Triggered when the input data value is greater than the High Alarm value.
If latching is enabled, this alarm remains triggered until unlatched. If latching is not enabled, the alarm clears after the input data value is less than the High Limit minus the Alarm Deadband.
  • 0 = Alarm is not triggered
  • 1 = Alarm is triggered
Chxx.HHAlarm
BOOL
Triggered when the input data value is greater than the High High Alarm value.
If latching is enabled, this alarm remains triggered until unlatched. If latching is not enabled, the alarm clears after the input data value is less than the High High Limit minus the Alarm Deadband.
  • 0 = Alarm is not triggered
  • 1 = Alarm is triggered
Chxx.RateAlarm
BOOL
Triggered when the change between consecutive channel samples divided by the period of time between when the samples were taken exceeds the Rate Alarm. If latched, this tag remains set until it is unlatched.
  • 0 = Alarm is not triggered
  • 1 = Alarm is triggered
Chxx.CalFault
BOOL
Indicates that the last attempted Calibration for this channel failed or there is no calibration data present.
This tag is cleared, that is, set to 0, when power is cycled to the module or a successful calibration for the range on the channel is performed.
  • 0 = Calibration did not fail
  • 1 = Calibration failed
Chxx.Calibrating
BOOL
Indicates that the channel is currently being calibrated.
  • 0 = Channel is not being calibrated
  • 1 = Channel is being calibrated
Chxx.CalGoodLowRef
BOOL
Indicates that a valid Low Reference signal is sampled on this channel in the calibration process.
IMPORTANT: This tag is available only when you use the Data with Calibration connection type in the Device definition dialog. If you use the Data connection type, this tag does not appear in the module tags.
  • 0 = Valid Low Reference signal has not been sampled on this channel
  • 1 = Valid Low Reference signal has been sampled on this channel
Chxx.CalBadLowRef
BOOL
Indicates that an invalid Low Reference signal is sampled on this channel in the calibration process. You must correct this condition to successfully calibrate the module.
If calibration is aborted with an invalid Low Reference signal, the Chxx.CalFault tag is set for this channel until a successful calibration is performed.
IMPORTANT: This tag is available only when you use the Data with Calibration connection type in the Device definition dialog. If you use the Data connection type, this tag does not appear in the module tags.
  • 0 = Invalid Low Reference signal has not been sampled on this channel
  • 1 = Invalid Low Reference signal has been sampled on this channel
Chxx.CalGoodHighRef
BOOL
Indicates that a valid High Reference signal is sampled on this channel in the calibration process.
IMPORTANT: This tag is available only when you use the Data with Calibration connection type in the Device definition dialog. If you use the Data connection type, this tag does not appear in the module tags.
  • 0 = Valid High Reference signal has not been sampled on this channel
  • 1 = Valid High Reference signal has been sampled on this channel
Chxx.CalBadHighRef
BOOL
Indicates that an invalid High Reference signal is sampled on this channel in the calibration process.
You must correct this condition to successfully calibrate the module.
If calibration is aborted with an invalid High Reference signal, the Chxx.CalFault tag is set for this channel until a successful calibration is performed.
IMPORTANT: This tag is available only when you use the Data with Calibration connection type in the Device definition dialog. If you use the Data connection type, this tag does not appear in the module tags.
  • 0 = Invalid High Reference signal has not been sampled on this channel
  • 1 = Invalid High Reference signal has been sampled on this channel
Chxx.CalSuccessful
BOOL
Indicates calibration on this channel is complete and the Calibrating state has been exited.
This tag remains set after valid calibration and until a new calibration process is started or the connection is closed.
IMPORTANT: This tag is available only when you use the Data with Calibration connection type in the Device definition dialog. If you use the Data connection type, this tag does not appear in the module tags.
  • 0 = Calibration was not successful
  • 1 = One of the following:
    • Calibration was successful and calibrating state has been exited.
    • Calibration data is present and applied.
Chxx.Data
REAL
Channel data in scaled Engineering Units.
Any value
Chxx.RollingTimestamp
INT
Continuously-running 15-bit timer that counts in milliseconds.
Whenever an input module scans its channels, it also records the value of RollingTimestamp at that time. The user program uses the last two RollingTimestamp values and calculates the interval between receipt of data.
0…32,767

Output Tag Definitions

Output Tags
Name
Data Type
Definition
Valid Values
Chxx.LLAlarmEn
BOOL
Enables the Low Low Alarm.
IMPORTANT:
To use this alarm, set this tag to 1 and confirm that the Chxx.AlarmDisable configuration tag for the same channel is set to 0.
If the Chxx.AlarmDisable configuration tag is set to 1, that is, alarms are disabled, this alarm does not work regardless of the tag value.
  • 0 = Disable alarm
  • 1 = Enable alarm
Chxx.LAlarmEn
BOOL
Enables the Low Alarm.
IMPORTANT:
To use this alarm, set this tag to 1 and confirm that the Chxx.AlarmDisable configuration tag for the same channel is set to 0.
If the Chxx.AlarmDisable configuration tag is set to 1, that is, alarms are disabled, this alarm does not work regardless of the tag value.
  • 0 = Disable alarm
  • 1 = Enable alarm
Chxx.HAlarmEn
BOOL
Enables the High Alarm.
IMPORTANT:
To use this alarm, set this tag to 1 and confirm that the Chxx.AlarmDisable configuration tag for the same channel is set to 0.
If the Chxx.AlarmDisable configuration tag is set to 1, that is, alarms are disabled, this alarm does not work regardless of the tag value.
  • 0 = Disable alarm
  • 1 = Enable alarm
Chxx.HHAlarmEn
BOOL
Enables the High High Alarm.
IMPORTANT:
To use this alarm, set this tag to 1 and confirm that the Chxx.AlarmDisable configuration tag for the same channel is set to 0.
If the Chxx.AlarmDisable configuration tag is set to 1, that is, alarms are disabled, this alarm does not work regardless of the tag value.
  • 0 = Disable alarm
  • 1 = Enable alarm
Chxx.RateAlarmEn
BOOL
Enables the Rate Alarm.
IMPORTANT:
To use this alarm, set this tag to 1 and confirm that the Chxx.AlarmDisable configuration tag for the same channel is set to 0.
If the Chxx.AlarmDisable configuration tag is set to 1, that is, alarms are disabled, this alarm does not work regardless of the tag value.
  • 0 = Disable alarm
  • 1 = Enable alarm
Chxx.LLAlarmUnlatch
BOOL
Unlatches a latched Low Low Alarm at the first instance of the bit transitioning from 0 to 1.
  • 0 = Low Low Alarm remains latched
  • 1 = Low Low Alarm unlatched
Chxx.LAlarmUnlatch
BOOL
Unlatches a latched Low Alarm at the first instance of the bit transition from 0 to 1.
  • 0 = Low Alarm remains latched
  • 1 = Low Alarm unlatched
Chxx.HAlarmUnlatch
BOOL
Unlatches a latched High Alarm at the first instance of the bit transition from 0 to 1.
  • 0 = High Alarm remains latched
  • 1 = High Alarm unlatched
Chxx.HHAlarmUnlatch
BOOL
Unlatches a set High High Alarm at the first instance of the bit transition from 0 to 1.
  • 0 = High High Alarm remains latched
  • 1 = High High Alarm unlatched
Chxx.RateAlarmUnlatch
BOOL
Unlatches a set Rate Alarm at the first instance of the bit transition from 0 to 1.
  • 0 = Rate Alarm remains latched
  • 1 = Rate Alarm unlatched
Chxx.Calibrate
BOOL
Initiates the Calibration process.
This tag must remain set until a valid Low Reference and High Reference values are applied to the input.
If the tag value transitions to 0 before calibration is finished, the process stops and calibration fails.
  • 0 = Not to start calibration process
  • 1 = Start calibration process
Chxx.CalLowRef
BOOL
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 setting this tag.
IMPORTANT: This tag is available only when you use the Data with Calibration connection type in the Device Definition. If you use the Data connection type, this tag does not appear in the module tags.
  • 0 = Not to start low reference sampling
  • 1 = Start low reference sampling
Chxx.CalHighRef
BOOL
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 setting tag.
IMPORTANT: This tag is available only when you use the Data with Calibration connection type in the Device Definition. If you use the Data connection type, this tag does not appear in the module tags.
  • 0 = Not to start high reference sampling
  • 1 = Start high reference sampling
Chxx.SensorOffset
REAL
Compensates for any known offset error on the sensor or channel to which the sensor is connected. Value is in terms of engineering units.
The value of this tag is added to the measured value in engineering units and is used in the Chxx.Data input tag.
Any valid float value
Use a value in the channel’s operating range.
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal