Input Tag definitions (5034-ENC)

The following table lists the available input tags.
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 channel 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.
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.
Windowxx.InWindow
BOOL
Indicates if the selected HSC/SSI data is in the specified window.
For the definition of "in the window", see Figure 1.
  • 0 = Value is outside the specified window
  • 1 = Value is inside the specified window
Windowxx.NotANumber
BOOL
Indicates that the last value received for the window data was not a number. In this case, the last valid window data is used.
  • 0 = Last window data received was a number
  • 1 = Last window data received was not a number
Counter00.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
    Typically, this tag is set when the Counterxx.QuadratureErrorCount tag is any number other than 0.
    The Counterxx.QuadratureErrorCount tag only applies when the module is operating in the X1, X2, or X4 Quadrature mode.
Counter00.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
    The following are causes of uncertain data:
    • Measured frequency is too high. That is, the Measured frequency > 1.2 * f
      MAX
       (f
      MAX
       = 1 Mhz).
    • Measured period is too long. That is, the Measured period > T
      P-MAX
      .
      Where T
      P-MAX
       = 1/(Input pulse frequency, min)
      If the period is longer than T
      P-MAX
      , the module assumes that the input frequency is 0.
    • Measured pulse width is too short. That is, the pulse width is less than the module’s rated minimum pulse width, T
      PW-MIN
       (T
      PW-MIN
       = 125 ns).
    • If duration of the number of pulses that is configured in the Counter00:AverageOverPulses tag is greater than T
      P-MAX
      .
      In this case, the average frequency and average pulse width are reported based on the length of the complete and incomplete pulses that are measured and the Counter00.PartialAvgFrequency tag is set.
Counter00.Direction
BOOL
Indicates the count direction.
  • 0 = Count up
  • 1 = Count down
Counter00.StoredDirection
BOOL
Indicates the count direction when the Store function is triggered.
  • 0 = Count up
  • 1 = Count down
Counter00.RevolutionCount
INT
The number of Rollover and Rollunder transitions
This value increments when a Rollover occurs and decrements when a Rollunder occurs.
Any value
Counter00.Count
DINT
The value of the counter
The counter mode that is selected determines how the input transitions are counted.
Any value
Counter00.Frequency
REAL
Frequency of the input transitions measured by the counter
This frequency is measured on Input A except in the Up/Down mode. For more information, see the PointMax High-speed Counter/SSI encoder user manual, publication 5034-UM006.
Any value
Counter00.PulseWidth
REAL
On-state pulse width of the last pulse received measured in microseconds when the input is not inverted.
Off-state pulse width of the last pulse received in microseconds when the input is inverted.
This pulse width is measured on Input A except in Up/Down mode. For more information, see the PointMax High-speed Counter/SSI encoder user manual, publication 5034-UM006.
Any value
Counter00.Accel
REAL
The acceleration of the pulses measured by the counter
This acceleration is measured on Input A except in Up/Down mode. For more information, see the PointMax High-speed Counter/SSI encoder user manual, publication 5034-UM006.
Any value
Counter00.FrequencyAvg
REAL
The average frequency
Any value
Counter00.PulseWidthAvg
REAL
The average pulse width measured in microseconds
Any value
Counter00.AccelAvg
REAL
The average acceleration
Any value
Counter00.ScaledCount
REAL
The count value that is scaled to engineering units
Any value
Counter00.ScaledFrequency
REAL
The frequency value that is scaled to engineering units
Any value
Counter00.ScaledAccel
REAL
The acceleration value that is scaled to engineering units
Any value
Counter00.ScaledFrequencyAvg
REAL
The average frequency that is scaled to engineering units
Any value
Counter00.ScaledAccelAvg
REAL
The average acceleration value that is scaled to engineering units
Any value
Counter00.StoredRevolutionCount
INT
The Revolution Count value when the Store function is triggered
Any value
Counter00.StoredCount
DINT
The count value when the Store function is triggered
Any value
Counter00.StoredFrequency
REAL
The frequency value when the Store function is triggered
Any value
Counter00.StoredPulseWidth
REAL
The pulse width value when the Store function is triggered
Any value
Counter00.StoredAccel
REAL
The acceleration when the Store function is triggered
Any value
Counter00.ScaledStoredCount
REAL
The stored count value that is scaled to engineering units
Any value
Counter00.ScaledStoredFrequency
REAL
The stored frequency that is scaled to engineering units
Any value
Counter00.ScaledStoredAccel
REAL
The stored acceleration that is scaled to engineering units
Any value
Counter00.Rollover
BOOL
Indicates that the counter counted up to Rollover value and then has continued counting from the Rollunder.
  • 0 = Counter has not counted to the Rollover value and continued counting from the Rollunder value
  • 1 = Counter counted to the Rollover value and has continued counting from the Rollunder value
Counter00.Rollunder
BOOL
Indicates that the counter counted down to Rollunder value and then has continued counting from the Rollover.
  • 0 = Counter has not counted down to the Rollunder value and continued counting from the Rollover value
  • 1 = Counter has counted down to the Rollunder value and continued counting from the Rollover value
Counter00.RolloverLeqRollunder
BOOL
Indicates that the Rollover value is less than or equal to the Rollunder value and the module is using either the last valid or default Rollover and Rollunder values.
  • 0 = Rollover value is greater than the Rollunder value
  • 1 = Rollover value is less than or equal to the Rollunder value
Counter00.FrequencyOverrange
BOOL
Indicates that the counter frequency exceeds the module’s maximum rated frequency, and therefore cannot be tracking the signal properly.
  • 0 = Counter frequency does not exceed the module’s maximum rated frequency
  • 1 = Counter frequency exceeds the module’s maximum rated frequency
Counter00.PartialAvgFrequency
BOOL
Indicates that the counter's average frequency is complete or partial with respect to Counter00.AvgOverPulses.
Average frequency can be partial when the number of pulses received in the maximum time window (T
p-Max
) is less than the required number of pulses for averaging (Counter00.AvgOverPulses).
Only applicable when Counter00.AvgOverPulsesEn = 0.
  • 0 = Counter's average frequency is complete and is based on the complete number of pulses with respect to Counter00.AvgOverPulses
  • 1 = Counter's average frequency is partial and is based on the length of the complete and incomplete pulses that are measured within the T
    P-MAX
     time window
Counter00.PartialAvgPulseWidth
BOOL
Indicates that the counter's average pulse width is complete or partial with respect to Counter00.AvgOverPulses.
Average pulse width can be partial when the number of pulses received in the maximum time window (T
p-Max
) is less than the required number of pulses for averaging (Counter00.AvgOverPulses).
Only applicable when Counter00.AvgOverPulsesEn = 1.
  • 0 = Counter’s average pulse width is complete and is based on the complete number of pulses with respect to Counter00.AvgOverPulses
  • 1 = Counter’s average pulse width is partial and is based on the length of the complete and incomplete pulses that are measured within the T
    P-MAX
     time window
Counter00.MissingPulseAlarm
BOOL
Indicates that the period of a pulse was greater than the missing pulse timeout or was never completed.
  • 0 = Period of the pulse was normal
  • 1 = Period of the pulse was greater than the missing pulse timeout or was never completed
Counter00.ZeroFrequencyAlarm
BOOL
Counter frequency is less than the Zero Frequency Alarm limit. Therefore, the frequency and rate are being reported as zero.
  • 0 = Counter frequency is not less than the Zero Frequency Alarm limit.
  • 1 = Counter frequency is less than the Zero Frequency Alarm limit.
Counter00.ZeroFrequencyAvgAlarm
BOOL
Counter average frequency is less than the Zero Frequency Alarm limit. Therefore, the frequency and rate are being reported as zero.
  • 0 = Counter average frequency is not less than the Zero Frequency Alarm limit.
  • 1 = Counter average frequency is less than the Zero Frequency Alarm limit.
Counter00.FrequencyAlarm
BOOL
Counter frequency has exceeded the Frequency Alarm limit.
  • 0 = Counter frequency has not exceeded the Frequency Alarm limit.
  • 1 = Counter frequency has exceeded the Frequency Alarm limit.
Counter00.FrequencyAvgAlarm
BOOL
Counter average frequency has exceeded the Frequency Alarm limit.
  • 0 = Counter average frequency has not exceeded the Frequency Alarm limit.
  • 1 = Counter average frequency has exceeded the Frequency Alarm limit.
Counter00.PulseWidthAlarm
BOOL
Indicates if the counter pulse width is greater than the maximum pulse width established by the Pulse Width Alarm limit, triggering this alarm.
  • 0 = Alarm is not triggered
    That is, the counter pulse width is not greater than the Pulse Width Alarm limit.
  • 1 = Alarm is triggered
    That is, the counter pulse width is greater than the Pulse Width Alarm limit.
Counter00.PulseWidthAvgAlarm
BOOL
Indicates if the counter average pulse width is greater than the maximum pulse width established by the Pulse Width Alarm limit, triggering this alarm.
  • 0 = Alarm is not triggered
    That is, the counter average pulse width is not greater than the Pulse Width Alarm limit.
  • 1 = Alarm is triggered
    That is, the counter average pulse width is greater than the Pulse Width Alarm limit.
Counter00.AccelAlarm
BOOL
Indicates that the counter acceleration rate exceeds the Acceleration Alarm limit, triggering this alarm.
  • 0 = Alarm is not triggered
    That is, the counter acceleration rate does not exceed the Acceleration Alarm limit.
  • 1 = Alarm is triggered
    That is, the counter acceleration rate exceeds the Acceleration Alarm limit.
Counter00.AccelAvgAlarm
BOOL
Indicates the counter average acceleration rate exceeds the Acceleration Alarm limit, triggering this alarm.
  • 0 = Alarm is not triggered
    That is, the counter average acceleration rate does not exceed the Acceleration Alarm limit.
  • 1 = Alarm is triggered
    That is, the counter average acceleration rate exceeds the Acceleration Alarm limit.
Counter00.DecelAlarm
BOOL
Indicates that the counter deceleration rate exceeds the Deceleration Alarm limit, triggering this alarm.
  • 0 = Alarm is not triggered
    That is, the counter deceleration rate does not exceed the Deceleration Alarm limit.
  • 1 = Alarm is triggered
    That is, the counter deceleration rate exceeds the Deceleration Alarm limit.
Counter00.DecelAvgAlarm
BOOL
Indicates that the counter average deceleration rate exceeds the Deceleration Alarm limit, triggering this alarm.
  • 0 = Alarm is not triggered
    That is, the counter average deceleration rate does not exceed the Deceleration Alarm limit.
  • 1 = Alarm is triggered
    That is, the counter average deceleration rate exceeds the Deceleration Alarm limit.
Counter00.NotANumber
BOOL
Indicates that the last value received for the counter data was not a number. In this case, the last valid counter data is used.
  • 0 = Last counter data received was a number
  • 1 = Last counter data received was not a number
Counter00.DataA
BOOL
Indicates the current Input A value.
If O.OverrideDataAEn = 1, this tag reflects O.OverrideDataAValue.
  • 0 = Input A is Off
  • 1 = Input A is On
Counter00.DataB
BOOL
Indicates the current Input B value.
If O.OverrideDataBEn = 1, this tag reflects O.OverrideDataBValue.
  • 0 = Input B is Off
  • 1 = Input B is On
Counter00.DataZ
BOOL
Indicates the current Input Z value.
If O.OverrideDataZEn = 1, this tag reflects O.OverrideDataZValue.
  • 0 = Input Z is Off
  • 1 = Input Z is On
Counter00.DataAOverridden
BOOL
Input A data is overridden with O.OverrideDataAValue.
  • 0 = Input A data is not overridden
  • 1 = Input A data is overridden
Counter00.DataBOverridden
BOOL
Input B data is overridden with the O.OverrideDataBValue.
  • 0 = Input B data is not overridden
  • 1 = Input B data is overridden
Counter00.DataZOverridden
BOOL
Input Z data is overridden with the O.OverrideDataZValue.
  • 0 = Input Z data is not overridden
  • 1 = Input Z data is overridden
Counter00.DataTrigger
BOOL
Indicates the current data value of the standard digital input, which is used as a trigger for counter functions.
If O.OverrideDataTriggerEn = 1, this tag reflects the O.OverrideDataTriggerValue.
  • 0 = Input trigger is Off
  • 1 = Input trigger is On
Counter00.DataTriggerOverridden
BOOL
DataTrigger data is overridden with O.OverrideDataTriggerValue.
  • 0 = Input trigger data was not overridden
  • 1 = Input trigger data was overridden
Counter00.QuadratureErrorCount
SINT
Indicates the number of times that a quadrature counter error occurred.
Any value
Counter00.CountChangeIndicator
SINT
At every RPI, if the count value changes, the CountChangeIndicator value is incremented and reported.
Any value
SSI00.Fault
BOOL
Indicates that SSI 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
SSI00.Uncertain
BOOL
Indicates that the SSI 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
SSI00.Data
DINT
Indicates the value of the data that is received from the SSI encoder, which is processed by the WordBitLength and TrailingBitLength tags.
Any value
SSI00.StoredData
DINT
Indicates the value of the data when the last Store function is triggered.
Any value
SSI00.RawData
DINT
Indicates the value of the raw data that is received from the SSI encoder.
Any value
SSI00.StoredRawData
DINT
Indicates the value of the raw data when the last Store function is triggered.
Any value
SSI00.Direction
BOOL
Indicates the direction of the encoder.
  • 0 = Moving up
  • 1 = Moving down
SSI00.StoredDirection
BOOL
Indicates the direction of the encoder that is stored together with the data.
  • 0 = Moving up
  • 1 = Moving down
SSI00.StoreInputData
BOOL
Indicates the current data of the digital input when it is used as a Store function trigger.
When no digital input is used as a Store function trigger, this member is always 0.
  • 0 = Off
  • 1 = On
SSI00.StoreInputOverridden
BOOL
Indicates the override status of the digital input when it is used as a Store function trigger.
When no digital input is used as a Store function trigger, this member is always 0.
  • 0 = Not overridden
  • 1 = Overridden
Input00.Data
BOOL
Indicates the current Input00 value.
  • 0 = On
  • 1 = Off
Input00.Fault
BOOL
Indicates that input 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
    Typically, this tag is set when SA power loss is detected.
Input00.Uncertain
BOOL
Indicates that the input 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
Outputxx.Data
BOOL
Echo of the current output value
  • 0 = On
  • 1 = Off
Outputxx.Fault
BOOL
Indicates that output 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
Outputxx.Uncertain
BOOL
Indicates that the output 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
Outputxx.TriggerMissed
BOOL
Indicates that at least one trigger is missed.
  • 0 = No trigger is missed.
  • 1 = At least one trigger is missed because the delay and pulse of the previous trigger are not yet completed.
    The output is not possible due to invalid PulseDelay or PulseActiveTime.
EventStatus[x].EventDropped
BOOL
Indicates when an event has been discarded because events are occurring faster than they are being acknowledged.
  • 0 = An event status has not been dropped
  • 1 = An event status has been dropped
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.
  • 0 = CIP Sync is not available.
  • 1 = CIP Sync is available.
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.
  • 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.
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.
  • 0 = Do not reset
  • 1 = Reset
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.
  • 0 = The output is not generating pulses
  • 1 = The output is generating pulses
Pwmxx.Error
BOOL
Indicates whether there is an error with generating the PWM pulse.
  • 0 = There is no error present
  • 1 = One of the following errors is present:
    • O.Pwmxx.CycleTime < minimum cycle time
    • O.Pwmxx.CycleTime > maximum cycle time
    • O.Pwmxx.DutyCycle * cycle time < minimum pulse width
    • (100% - O.Pwmxx.DutyCycle) * cycle time < minimum pulse width
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal