Input Tag definitions

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.
Axisxx.Enabled
BOOL
Indicates whether the axis is enabled.
  • 0 = Disabled (Powered off)
  • 1 = Enabled (Powered on)
Axisxx.Fault
BOOL
Indicates that axis 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:
Some faults are latched and do not automatically reset to 0. See O.Axisxx.ResetFault for more information.
For faults that are not latched, once the condition that causes the fault is cleared, the tag automatically resets to 0.
  • 0 = Good
  • 1 = Bad, causing fault
Axisxx.Uncertain
BOOL
Indicates that the axis 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
Axisxx.CommandAccepted
BOOL
Indicates whether the new command is loaded successfully. The module loads the command and all relevant parameters in the Output data when O.Axisxx.Execute transitions from 0 to 1.
This bit is set to 1 when a new command is successfully loaded.
This bit is cleared when O.Axisxx.Execute is cleared.
Axisxx.CommandError
BOOL
Indicates whether the new command is discarded due to invalid parameters or invalid command sequence. The module loads the command and all relevant parameters in the Output data when O.Axisxx.Execute transitions from 0 to 1.
This bit is set to 1 when a new command is discarded.
This bit is cleared when O.Axisxx.Execute is cleared.
Axisxx.CommandActive
BOOL
Indicates whether the axis is still performing the last command accepted.
  • 0 = The axis has completed the last command accepted.
  • 1 = The axis is still performing the last command accepted.
Axisxx.OnTarget
BOOL
For Move Position command, indicates whether the axis has reached the target position.
For Move Velocity and Jog commands, indicates whether the axis has reached the target speed.
  • 0 = Axis has not reached the target position/speed.
  • 1 = Axis has reached the target position/speed.
Axisxx.PositionValid
BOOL
Indicates whether the current axis position is valid for motion operations.
When the module powers up, position is invalid. If you use the absolute Move Position command, perform a Home or Set Home Position command first. Otherwise, the absolute Move Position command is rejected.
When the axis is disabled (powered off), this tag is cleared.
  • 0 = Axis position is not valid.
  • 1 = Axis position is valid.
Axisxx.BrakeReleased
BOOL
Indicates whether to apply or release the external brake.
The ladder program uses this bit to control an external digital output that is connected to the brake.
  • 0 = Apply the brake.
  • 1 = Release the brake.
Axisxx.Command
UINT
Echo of the last command that the axis accepted.
  • 1 = Move Position
  • 2 = Move Velocity
  • 4 = Jog
  • 8 = Stop
  • 16 = Set Home Position
  • 32 = Home
Axisxx.Command_MovePosition
BOOL
Indicates that Move Position is the last command that the axis accepted.
  • 0 = Move Position is not the last command accepted.
  • 1 = Move Position is the last command accepted.
Axisxx.Command_MoveVelocity
BOOL
Indicates that Move Velocity is the last command that the axis accepted.
  • 0 = Move Velocity is not the last command accepted.
  • 1 = Move Velocity is the last command accepted.
Axisxx.Command_Jog
BOOL
Indicates that Jog is the last command that the axis accepted.
  • 0 = Jog is not the last command accepted.
  • 1 = Jog is the last command accepted.
Axisxx.Command_Stop
BOOL
Indicates that Stop is the last command that the axis accepted.
  • 0 = Stop is not the last command accepted.
  • 1 = Stop is the last command accepted.
Axisxx.Command_SetHomePosition
BOOL
Indicates that Set Home Position is the last command that the axis accepted.
  • 0 = Set Home Position is not the last command accepted.
  • 1 = Set Home Position is the last command accepted.
Axisxx.Command_Home
BOOL
Indicates that Home is the last command that the axis accepted.
  • 0 = Home is not the last command accepted.
  • 1 = Home is the last command accepted.
Axisxx.ActualPosition
REAL
Indicates the current estimated position of the axis.
This is only valid when I:PositionValid is 1.
The value is in Engineering Units.
Any value
Axisxx.ActualVelocity
REAL
Indicates the current estimated velocity of the axis.
The value is in Engineering Units per second.
Any value
Axisxx.NoLoad
BOOL
Not applicable for this module.
—
Axisxx.ShortCircuit
BOOL
Indicates whether the axis has a Short Circuit fault.
  • 0 = A Short Circuit fault does not exist.
  • 1 = A Short Circuit fault exists.
Axisxx.FieldPowerOff
BOOL
Indicates whether the axis has a field power off fault.
  • 0 = Field power is On.
  • 1 = Field power is Off.
Axisxx.OverTemperature
BOOL
Indicates whether the axis has an overtemperature condition.
This condition indicates drive temperature and not motor temperature.
  • 0 = An overtemperature condition does not exist.
  • 1 = An overtemperature condition exists.
Axisxx.CriticalTemperature
BOOL
Indicates whether the axis has a critical temperature condition.
This condition indicates drive temperature and not motor temperature.
  • 0 = A critical temperature condition does not exist.
  • 1 = A critical temperature condition exists.
Axisxx.StallDetected
BOOL
Not applicable for this module.
—
Axisxx.MotorTorqueDisabled
BOOL
Indicates whether the Motor Torque Off condition is active.
  • 0 = Motor Torque Off condition is not active.
  • 1 = Motor Torque Off condition is active.
Axisxx.BrakeFaulted
BOOL
Indicates whether the external brake control has a fault, as defined by O.Axisxx.BrakeFaulted.
  • 0 = The external brake fault does not exist.
  • 1 = The external brake fault exists.
Axisxx.PositiveOvertravel
BOOL
Indicates whether the positive overtravel condition is active.
  • 0 = Positive overtravel condition is not active.
  • 1 = Positive overtravel condition is active.
Axisxx.NegativeOvertravel
BOOL
Indicates whether the negative overtravel condition is active.
  • 0 = Negative overtravel condition is not active.
  • 1 = Negative overtravel condition is active.
Axisxx.OverspeedAlarm
BOOL
Indicates whether the commanded velocity (O.Axisxx.TargetVelocity or O.Axisxx.JogSpeed) exceeds the maximum speed.
If the commanded velocity exceeds maximum speed, the actual velocity is limited to maximum speed and this tag is set to 1.
  • 0 = Commanded velocity is below the maximum speed.
  • 1 = Commanded velocity is above the maximum speed.
Axisxx.InternalFault
BOOL
Indicates whether the axis has an internal fault.
  • 0 = An internal fault does not exist.
  • 1 = An internal fault exists.
Inputxx.Data
BOOL
Indicates the current input value.
  • 0 = Off
  • 1 = On
Inputxx.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
Inputxx.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
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal