Tag definitions (5034-UB8F)
The 5034-UB8F module has configuration, input, output, event input, and event output
tags.
Name | Data Type | Definition | Valid Values |
|---|---|---|---|
PtxxPowerSource | SINT | Indicates the power source that is used for the point. |
|
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. |
|
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. |
|
Counterxx.RolloverAtPreset | BOOL | Determines whether the simple counter will rollover to 0 at the
Preset value. |
|
Counterxx.ProgramToFaultEn | BOOL | Determines if the counter transitions to the Communication Fault
Mode if the connection faults while in Program Mode. |
|
Counterxx.FaultMode | SINT | Selects the behavior that the counter takes if a communication
fault occurs. FaultValue defines the value to go to when set to
user-defined value. |
|
Counterxx.FaultValue | DINT | Defines the value that the counter assumes when a communication
fault occurs if FaultMode is set to user-defined value. | All values |
Counterxx.ProgMode | SINT | Selects the behavior that the counter takes when transitioned
into Program Mode or Inhibit mode. ProgValue defines the value
to go to when set to user-defined value. |
|
Counterxx.ProgValue | DINT | Defines the value that the counter assumes when the connection
transitions to Program Mode or Inhibit mode if ProgMode set to
user-defined value. | All values |
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. |
|
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. |
|
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 |
|
Ptxx.CaptureOffOnEn | BOOL | Enables capturing Off to On timestamps. If cleared, the point
does not record Off to On timestamps. |
|
Ptxx.CaptureOnOffEn | BOOL | Enables capturing On to Off timestamps. If cleared, the point
does not record On to Off timestamps. |
|
Ptxx.TimestampLatchEn | BOOL | Determines whether timestamps latching is enabled. |
Timestamp is acknowledged by copying the value from input tag
TimestampOffOnNumber/TimestampOnOffNumber to output tag
TimestampOffOnNumberAck/TimestampOnOffNumberAck. The acknowledgment also clears
TimestampOverflowOffOn/TimestampOverflowOnOff. |
Ptxx.FaultMode | BOOL | Determines 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.
|
|
Ptxx.FaultValue | BOOL | Defines the value that the discrete output assumes if a
communication fault occurs when FaultMode = 0. |
|
Ptxx.ProgMode | BOOL | Determines 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.
|
|
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. |
|
Ptxx.FaultFinalState | BOOL | If FaultValueStateDuration is nonzero, determines the final
Output state after the configured FaultValueStateDuration time
out occurs. |
|
Ptxx.ProgramToFaultEn | BOOL | Determines output action if a connection faults while the module
is in a Program state. The output can remain in a Program mode or transition to a safe
state for Fault mode. If the output remains in a Program mode, the Final Fault State
parameter is ignored. |
|
Ptxx.FaultValueStateDuration | SINT | Determines the length of time the Communication Fault Mode state
is held before the FaultFinalState is applied. |
|
Ptxx.FaultModeLocalControl | BOOL | Indicates whether the output continues to operate when
communication fault occurs. |
|
Ptxx.ProgModeLocalControl | BOOL | Indicates whether the output continues to operate when
transitioning to Program or Inhibit mode. |
|
Pwmxx.Enable | BOOL | Determines whether the output is Pulse Width Modulation or
Digital Output. |
|
Pwmxx.CycleCountEn | BOOL | Indicates whether to stop generating pulse cycles after a defined
number or continue generating pulse cycles until stopped. |
|
Pwmxx.ExecuteAllCycles | BOOL | Determines the PWM action when O.Ptxx.Data transitions to 0. Only applicable when C.Pwmxx.CycleCountEn = 1. |
|
Pwmxx.EnforcePTODutyCycle | BOOL | Indicates whether to enforce the PTO specific duty cycle, which
is fixed at 50%. |
|
Pwmxx.IdleState | BOOL | Determines the state of the output when PWM is idle. |
|
Ptxx.OrPt[yy]Select | BOOL | Indicates whether Pt[yy].Data participates in the logic OR
calculation. The state of the output point is determined by the logical OR of
the selected points in the OR table, combined with logical AND
of the selected points in the AND table. |
|
Ptxx.AndPt[yy]Select | BOOL | Indicates whether Pt[yy].Data participates in the logic AND
calculation. The state of the output point is determined by the logical OR of
the selected points in the OR table, combined with logical AND
of the selected points in the AND table. |
|
Ptxx.TriggerSelect | SINT | Specifies the input that triggers the pulse function. |
|
Ptxx.InvertTrigger | BOOL | Indicates whether the output pulse is triggered on the rising or
falling edge of the input. |
|
FIFOLatchEvents | BOOL | Indicates whether the FIFO event latching is enabled. |
|
Name | Data Type | Definition | Valid Values |
|---|---|---|---|
RunMode | BOOL | The module's operating state |
|
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. |
|
DiagnosticActive | BOOL | Indicates if any diagnostics are active or if 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. |
|
CIPSyncTimeout | BOOL | Indicates that the module was once synced with a 1588 master, but
the module is not synced now due to a timeout. |
|
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. |
EventsQueuedCount | DINT | Specifies the number of unacknowledged timestamp events that are
queued in the module’s buffer. This includes events that are
stored in the internal FIFO buffer and produce FIFO buffer. | 0...276 |
Counterxx.Data | BOOL | Indicates the current digital input value. |
|
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.
|
|
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.
|
|
Counterxx.Done | BOOL | If RolloverAtPreset is set, indicates if Count ≥ Preset. If RolloverAtPreset is not set, always 0. |
|
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. |
|
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. |
|
Ptxx.Data (Output mode) | BOOL | Indicates the current digital output value applied at the
screw. |
|
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.
|
|
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.
|
|
Ptxx.TriggerMissed | BOOL | Indicates that at least one trigger is missed. |
|
Ptxx.EventOverflow | BOOL | Indicates whether the timestamp is discarded after the internal
buffer is full. |
|
Ptxx.Chatter | BOOL | Indicates if the input is chattering per the ChatterTime and
ChatterCount settings. |
|
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. |
|
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. |
|
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 |
|
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 |
EventStatus[x].EventDropped | BOOL | Indicates when an event has been discarded because events are
occurring faster than they are being acknowledged. |
|
EventStatus[x].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. |
|
EventStatus[x].CIPSyncTimeout | BOOL | Indicates that the module was once synced with a 1588 master, but
the module is not synced now due to a timeout. |
|
EventStatus[x].EventReset | BOOL | When Eventxx.ResetEvent transitions from 0 to 1,
EventStatus[x].EventReset transitions to 1 to indicate that the
reset was received and completed. It stays 1 until Eventxx.ResetEvent transition to zero. |
|
EventStatus[x].EventsPending | SINT | The number of events currently queued in the module. A value
greater than zero indicates that the controller is not currently
keeping up with the rate of events. | All positive values |
EventStatus[x].EventNumber | DINT | Running count of events, which increments by one for each new
time event. The originator sets Eventxx.EventNumberAck to Eventxx.EventNumber
to acknowledge receipt of the event. When the number of events reaches its maximum value and rolls
over, it rolls over to 1, not 0. | All values |
Pwmxx.Active | BOOL | Indicates whether the output is generating PWM pulses. |
|
Pwmxx.Error | BOOL | Indicates whether there is an error with generating the PWM
pulse. |
|
FIFO[x].CIPSyncTimeout | BOOL | Indicates the time sync timeout status when the timestamp event
is captured. |
|
FIFO[x].CIPSyncValid | BOOL | Indicates the time sync status when the timestamp event is
captured |
|
FIFO[x].Data | BOOL | Indicates the state of the input when the timestamp event is
captured. |
|
FIFO[x].EventNumber | DINT | A running count of events, which increment by one for each new
event. Write this EventNumber into the output data field
EventNumberAck to acknowledge receipt of the event. If the
EventNumber reaches its maximum value, it rolls over to 1
instead of 0. | 0…4,294,967,296 |
FIFO[x].Fault | BOOL | Indicates that point data is inaccurate and cannot be trusted for
use in the application when the timestamp event is captured. If the tag is set to 1, you must troubleshoot the module to
correct the cause of the inaccuracy. |
|
FIFO[x].Point | SINT | Indicates the point at which the event is recorded. | 0...7 |
FIFO[x].TimeStamp | LINT | Indicates the timestamp of the captured event. | All positive values |
FIFO[x].Uncertain | BOOL | Indicates that the point data can be inaccurate but the degree of
inaccuracy is not known when the timestamp event is
captured. If the tag is set to 1, you must troubleshoot the module to
correct the cause of the inaccuracy. |
|
Name | Data Type | Definition | Valid Values |
|---|---|---|---|
Counterxx.Reset | BOOL | When this bit transitions from 0 to 1, Count and Rollover are set
to zero. |
|
Counterxx.RolloverAck | BOOL | Clears the Rollover bit in the input tag when it transitions from
0 to 1. |
|
Counterxx.Preset | DINT |
| 0…2,147,483,647 |
Ptxx.ResetTimestamps | BOOL | Erases all recorded timestamps for the input point when it
transitions from 0 to 1. |
|
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 |
|
Ptxx.ScheduleEn | BOOL | Specifies the use of normal output data or scheduled data. |
|
Ptxx.OverrideDataEn | BOOL | Enables the output state to be overridden by the
OverrideDataValue tag. |
|
Ptxx.OverrideDataValue | BOOL | Indicates the forced output state when the OverrideDataEn tag is
set to 1. |
|
Ptxx.PulseActiveTime | REAL | Specifies the active duration in seconds for the generated output
pulse. | All positive values |
Ptxx.PulseDelay | REAL | Specifies the delay time in seconds between the trigger event and
the start of the output pulse. | All positive values |
Ptxx.ResetTriggerMissed | BOOL | Resets I.Ptxx.TriggerMissed bit. | A rising edge of ResetTriggerMissed bit clears the
I.Ptxx.TriggerMissed bit. |
Ptxx.Trigger | BOOL | Triggers the output pulse. | A rising edge of this bit triggers the output pulse. The
Ptxx.PulseDelay and Ptxx.PulseActiveTime still apply. |
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 but a previous schedule entry that uses the same
ID is not yet complete, the new schedule entry overwrites the
previous schedule. The schedule is considered complete when the schedule state is
reported as Expired, Late, or Discarded. |
|
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:
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…7 |
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 |
Pwmxx.CycleTime | REAL | Indicates the period in seconds of one pulse cycle. | 10 μs…30 s |
Pwmxx.DutyCycle | REAL | Indicates in percentage of the pulse cycle time when output is in
the active state. | 0…100% |
Pwmxx.CycleCountLimit | DINT | Determines the number of pulse cycles to be generated when there
is a rising edge in the data. Only applicable when C.Pwmxx.CycleCountEn = 1. | 0…2,147,483,647 |
FIFO.EventNumberAck | DINT | Acknowledges all events with EventNumber less than or equal to
this number.
IMPORTANT:
If EventNumberAck
does not match any event in the FIFO produce buffer, no
event is acknowledged.
| All values |
FIFO.ResetEvents | BOOL | Erases all recorded timestamped events. | A rising edge of this bit clears all the timestamp events in the
internal buffer and FIFO produce buffer, and resets
I.Ptxx.EventOverflow bit. |
Name | Data Type | Definition | Valid Values |
|---|---|---|---|
RunMode | BOOL | The point's operating state |
|
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. |
|
DiagnosticActive | BOOL | Indicates if any diagnostics are active or if the prognostics
threshold is reached. |
|
DiagnosticSequenceCount | BOOL | 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. |
Eventxx.Fault | BOOL | Detects whether the signal is good data. The fault is set to 1 by
the originator when the connection is lost. 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.
|
|
Eventxx.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.
|
|
Eventxx.EventDropped | BOOL | Indicates when an event has been discarded because events are
occurring faster than they are being acknowledged. |
|
Eventxx.EventRising | BOOL | Indicates whether an event triggered when an input transition
results in an event pattern being matched. |
|
Eventxx.EventFalling | BOOL | Indicates whether an event triggered when an input transition
resulted in an event pattern no longer being matched. |
|
Eventxx.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. |
|
Eventxx.CIPSyncTimeout | BOOL | Indicates that the module was once synced with a 1588 master, but
the module is not synced now due to a timeout. |
|
Eventxx.EventsPending | SINT | The number of events currently queued in the module. A value
greater than zero indicates that the controller is not currently
keeping up with the rate of events. | All positive values |
Eventxx.EventNumber | DINT | Running count of events, which increments by one for each new
time event. The originator sets Eventxx.EventNumberAck to Eventxx.EventNumber
to acknowledge receipt of the event. When the number of events reaches its maximum value and rolls
over, it rolls over to 1, not 0. | All values |
Eventxx.EventTimestamp | LINT | The time that the event occurred | All positive values |
Eventxx.PtxxData | BOOL | Indicates the data value of input Ptxx when event was
triggered. |
|
Eventxx.CounterxxDone | BOOL | Indicates the Done status of Counterxx when event was
triggered. |
|
Eventxx.PtxxFault | BOOL | Indicates the fault status of input Ptxx when event is
triggered. |
|
Eventxx.CounterxxFault | BOOL | Indicates the fault status of Counterxx when event is
triggered. |
|
Name | Data Type | Definition | Valid Values |
|---|---|---|---|
Eventxx.En | BOOL | When set, the corresponding event trigger definition is active
and events are triggered when conditions match the definition.
|
|
Eventxx.EventRisingEn | BOOL | Triggers an event each time a condition change results in
conditions that match the event trigger definition. | Values (EventRisingEn, EventFallingEn) represent:
|
Eventxx.EventFallingEn | BOOL | Triggers an event each time a condition change results in
conditions that do not match the event trigger definition. | |
Eventxx.LatchEn | BOOL | When set, events are latched until acknowledged. When not set, new events overwrite old events. |
|
Eventxx.ResetEvent | BOOL | A transition from 0 to 1 resets all events and clears the event
queue on the Eventxx. |
|
Eventxx.IndependentConditionTriggerEn | SINT | Determines whether an input state change or a pattern of input
state changes triggers an event. |
|
Eventxx.EventNumberAck | DINT | The controller writes back EventNumber into EventNumberAck to
indicate receipt of the event. | All values |
Eventxx.PtxxDataSelect | BOOL | Determines whether the input participates in the event trigger.
|
|
Eventxx.CounterxxSelect | BOOL | Determines whether the counter participates in the event
trigger. |
|
Eventxx.PtxxDataValue | BOOL | Determines the state of the input to match after the
transition. |
|
Eventxx.CounterxxDataValue | BOOL | Determines the done state of the counter to match after the
transition. |
|
Provide Feedback