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
Counterxx.InputOffOnFilter
SINT
The amount of time that a signal must be in the On state before the input data indicates the On state.
The amount of time is indicated using an enumeration.
  • 5 = 0 μs
  • 12 = 500 μs
  • 13 = 1 ms
  • 14 = 2 ms
  • 15 = 5 ms
  • 16 = 10 ms
  • 17 = 20 ms
  • 18 = 50 ms
Counterxx.InputOnOffFilter
SINT
The amount of time that a signal must be in the Off state before the input data indicates the Off state.
The amount of time is indicated using an enumeration.
  • 5 = 0 μs
  • 12 = 500 μs
  • 13 = 1 ms
  • 14 = 2 ms
  • 15 = 5 ms
  • 16 = 10 ms
  • 17 = 20 ms
  • 18 = 50 ms
Counterxx.RolloverAtPreset
BOOL
Determines whether the simple counter will rollover to 0 at the Preset value.
  • 0 = No rollover at the Preset value
    When the counter counts to the Preset value, the Done bit is set.
    When the counter reaches maximum DINT (2,147,483,647) and continues counting, it rolls over to 0 and the Rollover bit is set.
  • 1 = Rollover at the Preset value
    When the counter reaches Preset-1 and continues counting, it rolls over to 0 and the Rollover bit is set. The Done bit is always 0.
Ptxx.InputOffOnFilter
SINT
The amount of time that a signal must be in the On state before the input data indicates the On state.
The amount of time is indicated using an enumeration.
  • 5 = 0 μs
  • 12 = 500 μs
  • 13 = 1 ms
  • 14 = 2 ms
  • 15 = 5 ms
  • 16 = 10 ms
  • 17 = 20 ms
  • 18 = 50 ms
Ptxx.InputOnOffFilter
SINT
The amount of time that a signal must be in the Off state before the input data indicates the Off state.
The amount of time is indicated using an enumeration.
  • 5 = 0 μs
  • 12 = 500 μs
  • 13 = 1 ms
  • 14 = 2 ms
  • 15 = 5 ms
  • 16 = 10 ms
  • 17 = 20 ms
  • 18 = 50 ms
Ptxx.ChatterTime
INT
A value from 1…10,000 ms in whole ms increments
1…10,000
Ptxx.ChatterCount
SINT
The number of input changes that are considered Chatter
  • 0 = Disabled
  • 2…127 = Enabled
Ptxx.CaptureOffOnEn
BOOL
Enables capturing Off to On timestamps. If cleared, the point does not record Off to On timestamps.
  • 0 = Capture disabled for Off to On input transitions
  • 1 = Capture enabled for Off to On input transitions
Ptxx.CaptureOnOffEn
BOOL
Enables capturing On to Off timestamps. If cleared, the point does not record On to Off timestamps.
  • 0 = Capture disabled for On to Off input transitions
  • 1 = Capture enabled for On to Off input transitions
Ptxx.TimestampLatchEn
BOOL
Determines whether timestamps latching is enabled.
  • 0 = Timestamps are overwritten with each successive transition
    The new timestamp overwrites the reported timestamp immediately, even if the controller has yet to extract that data.
  • 1 = Timestamps are latched until acknowledged
    The reported timestamp is not overwritten until acknowledged. All subsequent transitions on that point are ignored until acknowledged/reset.
Timestamp is acknowledged by copying the value from input tag TimestampOffOnNumber/TimestampOnOffNumber to output tag TimestampOffOnNumberAck/TimestampOnOffNumberAck.
The acknowledgment also clears TimestampOverflowOffOn/TimestampOverflowOnOff.
Ptxx.ProgramToFaultEn
BOOL
Determines if an output transitions to the Communication Fault Mode if the connection faults while in Program Mode.
  • 0 = Stay in Program Mode state
  • 1 = Go to Communication Fault Mode state
Ptxx.FaultMode
BOOL
Selects the behavior that the output point takes if a communication fault occurs. FaultValue defines the value to go to when set to user-defined value.
IMPORTANT: When Ptxx.FaultModeLocalControl tag exists and is set to 1, this configuration is ignored.
  • 0 = Go to a user-defined value
  • 1 = Hold last state
Ptxx.FaultValue
BOOL
Defines the value that the discrete output assumes if a communication fault occurs when FaultMode = 0.
  • 0 = Off
  • 1 = On
Ptxx.ProgMode
BOOL
Selects the behavior that the output point takes when transitioned into Program Mode or Inhibit mode. ProgValue defines the value to go to when set to user-defined value.
IMPORTANT: When Ptxx.ProgModeLocalControl tag exists and is set to 1, this configuration is ignored.
  • 0 = Go to a user-defined value
  • 1 = Hold last state
Ptxx.ProgValue
BOOL
Defines the value that the output takes when the connection transitions to Program Mode or Inhibit mode if the ProgMode bit is set to user-defined value.
  • 0 = The output state is Off during Program Mode or Inhibit mode
  • 1 = The output state is On during Program Mode or Inhibit mode
Ptxx.FaultFinalState
BOOL
If FaultValueStateDuration is nonzero, determines the final Output state after the configured FaultValueStateDuration time out occurs.
  • 0 = The output state is Off after the FaultValueStateDuration time expires
  • 1 = The output state is On after the FaultValueStateDuration time expires
Ptxx.FaultValueStateDuration
SINT
This value determines the length of time the Communication Fault Mode state is held before the FaultFinalState is applied.
  • 0 = Hold forever
  • 1, 2, 5, or 10 seconds
Ptxx.NoLoadEn
BOOL
Enables No Load detection for output points.
  • 0 = Disable
  • 1 = Enable
PtxxPowerSource
SINT
Indicates the power source that is used for the point.
  • 0…7 = Point number of the Power Supply mode point that is used as SSV to the Ptxx input.
  • -1 = External power supply
  • -2 = Module SSV power

Input Tag Definitions

Input Tags
Name
Data Type
Definition
Valid Values
RunMode
BOOL
The module'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.
    • Module is not applying new output tag data because the controller is in Program Mode.
  • 1 = Run – It means the following:
    • Connection is up.
    • Module is producing data for the connection.
    • Output tag data is being applied or there is no output tag data for the connection (For example, all points configured as digital input without timestamp).
ConnectionFaulted
BOOL
Indicates if a connection to the target is running.
The module always returns a zero in this member. The controller overwrites the zero with a one when the connection is not up.
  • 0 = Connection is running.
  • 1 = Connection is not running.
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.
CIPSyncValid
BOOL
Indicates whether the module is synced with a 1588 master.
A set bit alone cannot indicate that it is synced to the same master clock of the owner controller.
You must compare the Grandmaster Clock ID of both the module and the owner controller.
  • 0 = CIP Sync is not available.
  • 1 = CIP Sync is available.
CIPSyncTimeout
BOOL
Indicates that the module was once synced with a 1588 master, but the module is not synced now due to a timeout.
  • 0 = A valid time master has not timed out.
  • 1 = A valid time master was detected on the backplane, but the time master has timed out.
    The module is using its local clock and can be drifting away from the last known master time.
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.
Counterxx.Data
BOOL
Indicates the current digital input value.
  • 0 = Off
  • 1 = On
Counterxx.Fault
BOOL
Indicates that counter 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 = Good
  • 1 = Bad, causing fault
Counterxx.Uncertain
BOOL
Indicates that the counter 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 = Good data
  • 1 = Uncertain data
Counterxx.Done
BOOL
If RolloverAtPreset is set, indicates if Count ≥ Preset.
If RolloverAtPreset is not set, always 0.
  • 0 = Counter has not reached the Preset value
  • 1 = Counter has reached the Preset value
Counterxx.Rollover
BOOL
The counter counted up to Preset -1 and continued counting from 0.
The RolloverAck bit transitioning from 0 to 1 or the Reset bit transitioning from 0 to 1 clears this bit.
  • 0 = Counter has not rolled over from Preset -1 to 0
  • 1 = Counter counted up to Preset -1 and continued counting from 0
Counterxx.Count
DINT
The number of rising edge of input signal counted by the counter
All values
Ptxx.Data
(Input mode)
BOOL
Indicates the current digital input value.
  • 0 = Off
  • 1 = On
Ptxx.Data
(Output mode)
BOOL
Indicates the current digital output value applied at the screw.
  • 0 = Off
  • 1 = On
Ptxx.Fault
BOOL
Indicates that point 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 = Good
  • 1 = Bad, causing fault
Ptxx.Uncertain
BOOL
Indicates that the point 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 = Good data
  • 1 = Uncertain data
Ptxx.Chatter
BOOL
Indicates if the input is chattering per the ChatterTime and ChatterCount settings.
  • 0 = Normal
  • 1 = Input is chattering
Ptxx.TimestampOverflowOffOn
BOOL
Indicates an Off to On timestamp was lost.
A timestamp can be lost when TimestampLatchEn is set but the reported timestamp is not acknowledged in time.
0 or 1
Ptxx.TimestampOverflowOnOff
BOOL
Indicates an On to Off timestamp was lost.
A timestamp can be lost when TimestampLatchEn is set but the reported timestamp is not acknowledged in time.
0 or 1
Ptxx.CIPSyncValid
BOOL
Indicates whether the module is synced with a 1588 master.
A set bit alone cannot indicate that it is synced to the same master clock of the owner controller.
You must compare the Grandmaster Clock ID of both the module and the owner controller.
  • 0 = CIP Sync is not available.
  • 1 = CIP Sync is available.
Ptxx.CIPSyncTimeout
BOOL
Indicates that the module was once synced with a 1588 master, but the module is not synced now due to a timeout.
  • 0 = A valid time master has not timed out.
  • 1 = A valid time master was detected on the backplane, but the time master has timed out.
    The module is using its local clock and can be drifting away from the last known master time.
Ptxx.TimestampOffOnNumber
INT
An Off to On timestamp identifier for the currently produced timestamp
All values
Ptxx.TimestampOnOffNumber
INT
An On to Off timestamp identifier for the currently produced timestamp
All values
Ptxx.TimestampOffOn
LINT
64-bit timestamp corresponding to when a change of state Off to On was recorded at the input
All values
Ptxx.TimestampOnOff
LINT
64-bit timestamp corresponding to when a change of state On to Off was recorded at the input
All values
Schedule[x].State
SINT
Current state of the schedule tags at index x
  • 0 = Inactive
  • 1 = Active – Schedule is next to be applied to the output
  • 2 = Queued – Schedule is queued after the Active schedule
  • 3 = Expired – Schedule has been applied
  • 4 = Discarded – One of the following:
    • The requested schedule was late (received after its scheduled application time) and a more recent schedule has already been applied to that output.
    • The output point does not exist or scheduling is not enabled on the output point.
  • 5 = Late – Schedule is received after the time scheduled (schedule is applied immediately)
Schedule[x].ScheduleNumber
SINT
Echo of SequenceNumber from the output tag
All values
LateScheduleCount
INT
Count of schedules that arrive late. That is, the arrival time is after scheduled time. Counter rolls over every 65,535 late updates.
The output is still being driven to new state if this is the most recent schedule for that point. Useful in indicating that network delays/losses are causing scheduling issues.
All values
LostScheduleCount
INT
Increments whenever the schedule sequence number in the output tag skips a value, which can indicate a lost schedule. Counter rolls over every 65,535 lost updates.
All values

Output Tag Definitions

Output Tags
Name
Data Type
Definition
Valid Values
Counterxx.Reset
BOOL
When this bit transitions from 0 to 1, Count and Rollover are set to zero.
  • 0 = Count and Rollover values are not set to 0
  • 1 = Count and Rolloever values are set to 0
Counterxx.RolloverAck
BOOL
Clears the Rollover bit in the input tag when it transitions from 0 to 1.
  • 0 = Rollover bit is not cleared
  • 1 = Rollover bit is cleared
Counterxx.Preset
DINT
  • If RolloverAtPreset is set, when the counter reaches Preset-1 and continues counting, it rolls over to 0 and the Rollover bit is set. The Done bit is always 0.
  • If RolloverAtPreset is not set, when the counter counts to the Preset value, the Done bit is set.
    When the counter reaches maximum DINT (2,147,483,647) and continues counting, it rolls over to 0 and the Rollover bit is set.
0…2,147,483,647
Ptxx.ResetTimestamps
BOOL
Erases all recorded timestamps for the input point when it transitions from 0 to 1.
  • 0 = Timestamps are not erased
  • 1 = Timestamps are erased
Ptxx.TimestampOffOnNumberAck
INT
An Off to On timestamp identifier that the controller writes to indicate that the identified timestamp has been seen and acted on.
When Latching is enabled and the Timestamp Number that is received from the controller matches the most recent timestamp that is produced, the module is then allowed to produce a new timestamp.
All values
Ptxx.TimestampOnOffNumberAck
INT
An On to Off timestamp identifier that the controller writes to indicate that the identified timestamp has been seen and acted on.
When Latching is enabled and the Timestamp Number that is received from the controller matches the most recent timestamp that is produced, the module is then allowed to produce a new timestamp.
All values
Ptxx.Data
BOOL
Current digital output data to be applied
  • 0 = Off
  • 1 = On
Ptxx.ScheduleEn
BOOL
Specifies the use of normal output data or scheduled data.
  • 0 = Normal output data
  • 1 = Scheduled data
TimeBase
LINT
Indicates the TimeBase for all schedule times.
When a new schedule entry is received, the module uses TimeBase + Schedule[n].TimeOffset to determine the time for the schedule entry.
Once the schedule entries that are based on the current TimeBase are echoed back by the module, a new TimeBase can be set to incorporate new schedule entry creations.
Any positive value
Schedule[x].ID
SINT
Indicates which hardware scheduler to use. Typically, you set the ID to the schedule index x + 1.
If you use an ID before that same ID of the previous schedule is completed, the new schedule overwrites the old schedule.
The schedule is considered complete when the schedule state is reported as Expired, Late, or Discarded.
  • 0 = No schedule
  • 1…32 = Valid hardware scheduler ID
Schedule[x].SequenceNumber
SINT
For every new schedule of Schedule[x], the sequence number is increased.
The expected sequence to request the module to perform a new schedule is:
  1. Set all other Schedule[x] members properly in the output tag.
  2. Increase the sequence number after step 1 is completed.
Once the module receives a new sequence number of Schedule[x], it starts processing it.
All values
Schedule[x].OutputPointSelect
SINT
Selects the output point that this schedule applies to.
0xFF means no output point selected.
0…15
Schedule[x].Data
BOOL
Output data to be applied at time that is specified in schedule
0 or 1
Schedule[x].TimeOffset
DINT
Offset from schedule base time. For more information, see the definition for TimeBase.
All values
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal