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
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.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.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

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.
    • Because the controller is in Program Mode, the module is not applying new output tag data but is applying the Program Mode state of the output point 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 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.
Uncertain (Packed data)
BOOL
Indicates if the module is operating outside the designed operating range, or data is under manual or override control.
  • 0 = Good data
  • 1 = Uncertain data
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.
Ptxx.Data
PtxxData (Packed data)
BOOL
Echo of the current digital output value
  • 0 = Off
  • 1 = On
Data (Packed data)
INT
Indicates the current values for all points of the module. Each bit represents 1 point. For example, Bit.3 represents the Data of Pt03.
For each point:
  • 0 = Off
  • 1 = On
Ptxx.Fault
PtxxFault (Packed data)
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
Fault (Packed data)
INT
Indicates the fault state for all points of the module. Each bit represents 1 point. For example, Bit.3 represents Fault status of Pt03.
Fault state 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.
For each point:
  • 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.NoLoad
BOOL
Indicates that the signal wire is disconnected from one of the RTB terminals or the RTB is removed.
  • 0 = No fault
  • 1 = Fault
Ptxx.ShortCircuit
BOOL
Indicates a short to high is detected on the safety input point.
  • 0 = No short circuit
  • 1 = Short circuit
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
Ptxx.Data
PtxxData (Packed data)
BOOL
Current digital output data to be applied
  • 0 = Off
  • 1 = On
Data (Packed data)
INT
Indicates the current values for all points of the module. Each bit represents 1 point. For example, Bit.3 represents the Data of Pt03.
For each point:
  • 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