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 Tag Definitions

Configuration Tags
Name
Data Type
Definition
Valid Values
Chxx.Range
SINT
Channel’s operating range
  • 0 = -10…+10V
  • 1 = 0…5V
  • 2 = 0…10V
  • 4 = 0…20 mA
  • 5 = 4…20 mA
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.LimitAlarmLatchEn
BOOL
Configures Limit alarms to latch until they are explicitly unlatched.
  • 0 = Latching disabled
  • 1 = Latching enabled
Chxx.RampAlarmLatchEn
BOOL
Latches Ramp Alarm when set so that it does not clear until explicitly unlatched.
  • 0 = Latching disabled
  • 1 = Latching enabled
Chxx.NoLoadEn
BOOL
Enables the input No Load diagnostic.
  • 0 = Disabled
  • 1 = Enabled
Chxx.Disable
BOOL
Disables the channel.
  • 0 = Channel is enabled
  • 1 = Channel is disabled
Chxx.FaultMode
BOOL
Determines output action when a connection fault occurs.
At the fault occurrence, the output holds its last state or transitions to the value set in the Fault Value parameter. The channel continues the Fault Mode for the length of time set in the Fault Value State Duration parameter.
  • 0 = Transition to user-defined value
  • 1 = Hold Last State
Chxx.ProgMode
BOOL
Determines output action when the controller transitions to Program Mode or Inhibit mode.
At the transition to Program Mode or Inhibit mode, the output holds its last state or transitions to the value set in the Program Value parameter.
  • 0 = Transition to user-defined value
  • 1 = Hold Last State
Chxx.ProgramToFaultEn
BOOL
Determines channel action if a connection faults while the module is in a safe state for Program Mode.
The channel can remain in a safe state for Program Mode or transition to a safe state for Communication Fault mode.
If the channel remains in a safe state for Program Mode, the Final Fault State parameter is ignored.
  • 0 = Remains in the Program state
  • 1 = Transitions to the safe state for the Fault mode
Chxx.FaultValueStateDuration
SINT
Determines the length of time the FaultMode or FaultValue parameter value is held prior to the Final Fault State.
  • 0 = Forever
  • 1 = 1 s
  • 2 = 2 s
  • 5 = 5 s
  • 10 = 10 s
Chxx.FaultValue
REAL
Value to which the output changes if the following events exist:
  • Fault Mode = 0
  • Either of the following:
    • Controller is in Run Mode and the connection is lost
    • Controller is in Program Mode, the connection is lost, and the ProgamToFaultEn tag is set
Any value
Chxx.ProgValue
REAL
Value to which the channel changes if the following events exist:
  • Program Mode = 0
  • Controller transitions to Program Mode
Any value
Chxx.FaultFinalState
REAL
If FaultValueStateDuration is nonzero, this value determines the final Output state after the configured FaultValueStateDuration timeout occurs.
Any value
Chxx.RampInRun
BOOL
Enables Output Ramping when the module is in Run Mode.
Output changes during Run Mode are limited to the Maximum Ramp Rate value.
  • 0 = Ramping disabled
  • 1 = Ramping enabled in Run Mode
Chxx.RampToProg
BOOL
Enables Output Ramping when the controller transitions to Program Mode.
Output changes during Program Mode are limited to the Maximum Ramp Rate value.
  • 0 = Ramping disabled
  • 1 = Ramping enabled to Program Mode state
Chxx.RampToFault
BOOL
Enables Output Ramping when the connection to the module faults.
Output transitions to FaultValue and FaultFinalState are limited to the MaximumRampRate.
  • 0 = Ramping disabled
  • 1 = Ramping enabled to Fault mode state
Chxx.HoldForInit
BOOL
When set, configures the channel to hold, or not change, until initialized with a value within 0.1% of full scale of its current value when one of the following conditions occurs.
  • Module initial connection (powerup)
  • Controller transition from Program Mode back to Run Mode
  • Module re-establishes communication after a fault
  • SA power is restored after being lost.
  • 0 = Output O.Chxx.Data signal immediately
  • 1 = Hold last signal until initialization match
Chxx.MaxRampRate
REAL
Maximum rate at which the channel can transition to in Engineering Units/Second.
This tag is used only if at least one of the following output ramping modes is enabled:
  • Ramp In Run
  • Ramp To Fault
  • Ramp To Program
If the MaxRampRate = 0.0, the ramp rate is limited to ramping the range full scale in one RPI.
Any value greater than zero = Trigger point
Chxx.LowSignal
REAL
One of four points used in scaling. The low signal is in terms of the inputs signal units and corresponds to the low engineering term when scaled.
Any value less than the high signal in range
Chxx.HighSignal
REAL
One of four points used in scaling. The high signal is in terms of the inputs signal units and corresponds to the high engineering term when scaled.
Any value greater than the low signal in range
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.LowLimit
REAL
Lowest value to which the output can go. The tag value is engineering units.
Any value lower than the HighLimit
Chxx.HighLimit
REAL
Highest value to which the output can go. The tag value is engineering units.
Any value higher than the LowLimit
Chxx.Offset
REAL
Compensates for any known error on the sensor or channel to which the sensor is connected. The value is set in engineering units.
Any value
Use a small value.

Input Tag Definitions

Input Tags
Name
Data Type
Definition
Valid Values
RunMode
BOOL
Channel’s operating state
  • 0 = Idle – It means one of the following:
    • Connection is not up.
    • Connection has been opened but the module has not started producing data for the connection.
    • Because the controller is in Program Mode, the module is not applying the Output tag data but is applying the Program Mode state of the channels instead.
  • 1 = Run – 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.NoLoad
BOOL
The signal wire is disconnected from the channel or the RTB is removed from the module.
This condition is detected only when the channel is used in current mode.
  • 0 = No Load condition does not exist
  • 1 = No Load condition exists
Chxx.ShortCircuit
BOOL
A Short Circuit or Overcurrent condition exists.
This condition is detected only when the channel is used in voltage mode.
  • 0 = No Short Circuit or Overcurrent condition exists
  • 1 = Short Circuit or Overcurrent condition exists
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.InHold
BOOL
Indicates that the channel is currently holding until the received data value is within 0.1% range full scale of the current data value.
  • 0 = Channel is not holding
  • 1 = Channel is holding
Chxx.Underrange
BOOL
Indicates that the commanded output data in output tag is below the Underrange threshold. When it happens, the actual output signal is limited at the threshold or the configured Low Limit (whichever is higher).
  • 0 = Commanded output data is not below the underrange threshold
  • 1 = Commanded output data is below the underrange threshold
Chxx.Overrange
BOOL
Indicates that the commanded output data in output tag is above the Overrange threshold. When it happens, the actual output signal is limited at the threshold or the configured High Limit (whichever is lower).
  • 0 = Commanded output data is not above the overrange threshold
  • 1 = Commanded output data is above the overrange threshold
Chxx.LLimitAlarm
BOOL
Triggered when the requested output value is below the configured Low Limit value. It remains set until the requested output is above the Low Limit.
If the Chxx.AlarmDisable tag is set to 1, that is, the output signal is still clamped at the Low Limit value. But the Low Limit alarm is not triggered.
  • 0 = Alarm is not triggered
  • 1 = Alarm is triggered
Chxx.HLimitAlarm
BOOL
Triggered when the requested output value is above the configured High Limit value. It remains set until the requested output is below the High Limit.
If the Chxx.AlarmDisable tag is set to 1, that is, the output signal is still clamped at the High Limit value. But the High Limit alarm is not triggered.
  • 0 = Alarm is not triggered
  • 1 = Alarm is triggered
Chxx.RampAlarm
BOOL
Indicates that the analog output has been commanded to change value in a way such that the Maximum Ramp Rate is exceeded.
  • 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
Indicates the signal value currently output at the RTB in scaled Engineering Units.
Any value
Chxx.RollingTimestamp
INT
Continuously-running 15-bit timer that counts in milliseconds.
Whenever the data echo value changes, the output module updates the value of the RollingTimestamp.
0…32767

Output Tag Definitions

Output Tags
Name
Data Type
Definition
Valid Values
Chxx.LLimitAlarmUnlatch
BOOL
Unlatches a latched Low Limit Alarm at the first instance of the bit transitioning from 0 to 1.
  • 0 = Alarm remains latched
  • 1 = Alarm is unlatched
Chxx.HLimitAlarmUnlatch
BOOL
Unlatches a latched High Limit Alarm at the first instance of the bit transitioning from 0 to 1.
  • 0 = Alarm remains latched
  • 1 = Alarm is unlatched
Chxx.RampAlarmUnlatch
BOOL
Unlatches a latched Ramp Alarm at the first instance of the bit transitioning from 0 to 1.
  • 0 = Alarm remains latched
  • 1 = Alarm is 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 channel.
  • 0 = Not to start calibration process
  • 1 = Start calibration process
Chxx.CalOutputLowRef
BOOL
A 0 to 1 transition commands the channel to produce the Low Calibration Reference Point for the chosen current or voltage output range.
  • 0 = Do not output Calibration Low Reference Signal
  • 1 = Output Calibration Low Reference Signal
    Do not set this tag and the CalOutputHighRef tag to 1 simultaneously.
Chxx.CalOutputHighRef
BOOL
A 0 to 1 transition commands the channel to produce the High Calibration Reference Point for the chosen current or voltage output range.
  • 0 = Do not Output Calibration High Reference Signal
  • 1 = Output Calibration High Reference Signal
    Do not set this tag and the CalOutputLowRef tag to 1 simultaneously.
Chxx.CalLowRefPassed
BOOL
A 0 to 1 transition indicates that the Chxx.Data output tag data contains the recorded Low Reference value for the channel that is used by the module in Calibration.
  • 0 = Not sending recorded Calibration Low Reference Signal in Output Data
  • 1 = Sending recorded Calibration Low Reference Signal in Output Data for Calibration Verification
Chxx.CalHighRefPassed
BOOL
A 0 to 1 transition indicates that the Chxx.Data output tag data contains the recorded High Reference value for the channel that is used by the module in Calibration.
  • 0 = Not sending recorded Calibration High Reference Signal in Output Data
  • 1 = Sending recorded Calibration High Reference Signal in Output Data for Calibration Verification
Chxx.CalFinish
BOOL
Data value change that triggers the channel to complete the Calibration procedure, applying the valid Low and High References received.
Channel exits the Calibration state if successful.
  • 0 = Do not complete the calibration procedure
  • 1 = Complete the calibration procedure
Chxx.Data
REAL
The value that is converted to the signal on the RTB in scaled Engineering Units.
Any value
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal