Device-defined data types (5069-OF4)

Device-defined data types (5069-OF4)

Device-defined data type names vary for each device depending on selections made when the device was created.
These tables list and describe device-defined data types for the 5069-OF4 devices.
These tables include information for:
  • input (as indicated by an "I")
  • output (as indicated by an "O")
  • configuration (as indicated by a "C")
Device-defined data type: AB:5000_AO4:I:0
Connection Type: Data and Listen Only
Member Name
Type
Style
Valid Values
RunMode
BOOL
Decimal
0 = Idle
1 = Run
  • Output products follow the Run mode of the owning connection.
  • Input-only products are always in Run mode.
ConnectionFaulted
BOOL
Decimal
0 = A connection exists between the device and the controller.
1 = Not connected
DiagnosticActive
BOOL
Decimal
0 = No diagnostics active
1 = One or more diagnostics are active or the prognostics threshold is reached
DiagnosticSequenceCount
SINT
Decimal
0 to 255
Increments each time a distinct diagnostic condition is detected, and each time a distinct diagnostic condition transitions from detected to not detected.
Ch0x.Fault
BOOL
Decimal
0 = No fault exists
1 = Fault exists
A fault is a roll-up of all of the diagnostic conditions that the device can detect and indicates bad data. If there is a detailed data type member that indicates a given detected condition, this fault member does not affect the DiagnosticActive or DiagnosticSequenceCount members. However, if there is no detailed data type for a given detected condition, this fault member triggers both the DiagnosticActive member and increments/decrements the Diagnostic Sequence Count.
Ch0x.Uncertain
BOOL
Decimal
0 = Valid data
1 = Data validity uncertain. Device is operating outside its designed operating range, or data is under manual or override control.
Ch0x.NoLoad
BOOL
Decimal
0 = No Load condition does not exist
1 = No Load condition exists, meaning a signal wire is disconnected from the channel or the RTB is removed from the device.
Ch0x.ShortCircuit
BOOL
Decimal
0 = No Short Circuit or Overcurrent condition exists
1 = Short Circuit or Overcurrent exists
Ch0x.OverTemperature
BOOL
Decimal
0 = Device temperature is not over the operating limits
1 = Device temperature is over the operating limits
Ch0x.FieldPowerOff
BOOL
Decimal
0 = Field Power is present
1 = Field Power is not present
Ch0x.InHold
BOOL
Decimal
0 = Channel is not holding
1 = Channel is holding
Ch0x.NotANumber
BOOL
Decimal
0 = Last channel data received was a number
1 = Output value received from the originator is NotANumber (the IEEE NAN value). The output channel will hold its last state
Ch0x.Underrange
BOOL
Decimal
0 = The input signal at the channel is greater than the minimum detectable signal.
1 = The input signal at the channel is less than or equal to the minimum detectable signal.
Ch0x.Overrange
BOOL
Decimal
0 = The input signal at the channel is less than the maximum detectable signal.
1 = The input signal at the channel is greater than or equal to the maximum detectable signal.
Ch0x.LLimitAlarm
BOOL
Decimal
0 = Alarm is not triggered
1 = Alarm is triggered
Ch0x.HLimitAlarm
BOOL
Decimal
0 = Alarm is not triggered
1 = Alarm is triggered
Ch0x.RampAlarm
BOOL
Decimal
0 = Alarm is not triggered
1 = Alarm is triggered
Ch0x.CalFault
BOOL
Decimal
0 = Calibration did not fail
1 = A calibration session for a channel was interrupted or failed. CalFault is reset by product reset or power cycle.
Ch0x.Calibrating
BOOL
Decimal
0 = Channel is not being calibrated
1 = Channel is being calibrated
Ch0x.Data
REAL
Float
-1.0E11 to 1.0E11
Ch0x.RollingTimestamp
BOOL
Decimal
Any positive value.
RollingTimestamp is a continuously running timer that counts in milliseconds. When an input device scans its channels, it also records the RollingTimestamp value.
Device-defined data type: AB:5000_AO4:O:0
Connection Type: Data
Member Name
Type
Style
Valid Values
Ch0x.LLimitAlarmUnlatch
BOOL
Decimal
Transition from low to high unlatches alarm.
Ch0x.HLimitAlarmUnlatch
BOOL
Decimal
Transition from high to low unlatches alarm.
Ch0x.RampAlarmUnlatch
BOOL
Decimal
Transition from low to high unlatches alarm
Ch0x.Data
REAL
Float
-1.0E11 to 1.0E11
Device-defined data type: AB:5000_AO4:C:0
Connection Type: Data and Data with Calibration
Member Name
Type
Style
Valid Values
Ch0x.Range
BOOL
Decimal
0 = -10…10V
1 = 0…5V
2 = 0…10V
4 = 0…20 mA
5 = 4…20 mA
Ch0x.AlarmDisable
BOOL
Decimal
0 = Alarms are enabled
1 = Alarms are disabled (default) for the channel
Ch0x.LimitAlarmLatchEn
BOOL
Decimal
0 = Latching disabled (default)
1 = Latching enabled
Ch0x.RampAlarmLatchEn
BOOL
Decimal
0 = Latching disabled (default)
1 = Latching enabled
Ch0x.NoLoadEn
BOOL
Decimal
0 = Disabled (default)
1 = Enabled
Ch0x.Disable
BOOL
Decimal
0 = Channel is enabled (default)
1 = Channel is disabled
Ch0x.FaultMode
BOOL
Decimal
0 = Transition to user-defined value
1 = Hold Last State (default)
Ch0x.ProgMode
BOOL
Decimal
0 = Transition to user-defined value
1 = Hold Last State (default)
Ch0x.ProgramToFaultEn
BOOL
Decimal
0 = Channel remains in Program mode
1 = Channel transitions to Fault mode
Ch0x.RampInRun
BOOL
Decimal
0 = Unchecked
1 = Checked
Enables ramping of the output value during Run mode between the current output level and a newly requested output. Ramping defines the maximum rate the output is allowed to transition based upon the configured RampRate.
Ch0x.RampToProg
BOOL
Decimal
0 = Unchecked
1 = Checked
Enables ramping of the output value to a user-defined program value, Ch0x.ProgValue, when set. Ramping defines the maximum rate the output is allowed to transition based upon the configured RampRate.
Ch0x.RampToFault
BOOL
Decimal
0 = Unchecked
1 = Checked
Enables ramping of the output value to a user-defined Fault value, Ch0xFaultValue, when set. Ramping defines the maximum rate the output is allowed to transition based upon the configured RampRate.
Ch0x.HoldForInt
BOOL
Decimal
0 = Unchecked
1 = Checked
When set configures the channel to hold, or not change, until initialized with a value within 0.1% of full scale of its current value when one of these conditions occurs:
  • Device initial connection (power up)
  • Device transition from Program mode back to Run mode
  • Device reestablishes communication after a fault
Ch0x.FaultValueStateDuration
SINT
Decimal
Determines the length of time the Fault mode state is held prior to the FaultFinalState being applied.
  • 0 = Forever
  • 1 = 1 second
  • 2 = 2 seconds
  • 5 = 5 seconds
  • 10 seconds
Ch0x.MaxRampRate
REAL
Float
-1.0E11 to 1.0E11
Maximum rate that the output value may change when transitioning to either the FaultValue or ProgValue if either the RampToFault or RampToProg bits are set, respectively, or in Run mode if RampToRun is set. In terms of Engineering Units per second.
Ch0x.LowSignal
REAL
Float
-1.0E11 to 1.0E11
A combination of LowSignal, HighSignal, LowEngineering, and HighEngineering are used to scale the input data returned by the device.
Ch0x.HighSignal
REAL
Float
-1.0E11 to 1.0E11
A combination of LowSignal, HighSignal, LowEngineering, and HighEngineering are used to scale the input data returned by the device.
Ch0x.LowEngineering
REAL
Float
-1.0E11 to 1.0E11
A combination of LowSignal, HighSignal, LowEngineering, and HighEngineering are used to scale the input data returned by the device.
Ch0x.HighEngineering
REAL
Float
-1.0E11 to 1.0E11
A combination of LowSignal, HighSignal, LowEngineering, and HighEngineering are used to scale the input data returned by the device.
Ch0x.LowLimit
REAL
Float
-1.0E11 to 1.0E11
Any value lower than the high limit
Ch0x.HighLimit
REAL
Float
-1.0E11 to 1.0E11
Any value higher than the low limit
Ch0x.Offset
REAL
Float
-1.0E11 to 1.0E11
Corrects for actuator inaccuracy in the Output Actuator itself providing a mechanism for the user to calibrate their system outside of the Output Device itself. Offset is configured per channel and in Engineering Units. The Offset is added to the Data before scaling from EU to Signal for output.
Ch0x.FaultValue
REAL
Float
-1.0E11 to 1.0E11
Value, in engineering units, the output should take if a communication fault occurs when the FaultMode bit it set.
Ch0x.ProgValue
REAL
Float
-1.0E11 to 1.0E11
Value, in engineering units, the output should take when the connection transitions to Program mode if the ProgMode bit is set to "User-Defined Value"
Ch0x.FaultFinalState
REAL
Float
-1.0E11 to 1.0E11
If FaultValueStateDuration is non-zero determines the final Output state after the configured FalueValueStateDuration time out occurs.
Device-defined data type: AB:5000_AO4:CAL:I:0
Connection Type: Data and Data with Calibration
Member Name
Type
Style
Valid Values
RunMode
BOOL
Decimal
0 = Idle
1 = Run
  • Output products follow the Run mode of the owning connection.
  • Input-only products are always in Run mode.
ConnectionFaulted
BOOL
Decimal
0 = A connection exists between the device and the controller.
1 = Not connected
DiagnosticActive
BOOL
Decimal
0 = No diagnostics active
1 = One or more diagnostics are active or the prognostics threshold is reached
DiagnosticSequenceCount
SINT
Decimal
0 to 255
Count that increments for each diagnostic.
Ch0x.Fault
BOOL
Decimal
0 = Good
1 = Bad
Ch0x.Uncertain
BOOL
Decimal
0 = Valid data
1 = Data validity uncertain. Device is operating outside its designed operating range, or data is under manual or override control.
Ch0x.NoLoad
BOOL
Decimal
0 = No Load condition does not exist
1 = No Load condition exists, meaning a signal wire is disconnected from the channel or the RTB is removed from the device.
Ch0x.ShortCircuit
BOOL
Decimal
0 = No Short Circuit or Overcurrent condition exists
1 = Short Circuit or Overcurrent exists
Ch0x.OverTemperature
BOOL
Decimal
0 = Device temperature is not over the operating limits
1 = Device temperature is over the operating limits
Ch0x.FieldPowerOff
BOOL
Decimal
0 = Field Power is present
1 = Field Power is not present
Ch0x.InHold
BOOL
Decimal
0 = Channel is not holding
1 = Channel is holding
Ch0x.NotANumber
BOOL
Decimal
0 = Last channel data received was a number
1 = Last channel data received was not a number
Ch0x.Underrange
BOOL
Decimal
0 = Channel data is not beneath the underrange threshold
1 = Input signal at the channel is less than or equal to the minimum detectable signal
Ch0x.Overrange
BOOL
Decimal
0 = Channel data is not above the overrange threshold
1 = Input signal at the channel is greater than or equal to the maximum detectable signal.
Ch0x.LLimitAlarm
BOOL
Decimal
0 = Alarm is not triggered
1 = Alarm is triggered
Ch0x.HLimitAlarm
BOOL
Decimal
0 = Alarm is not triggered
1 = Alarm is triggered
Ch0x.RampAlarm
BOOL
Decimal
0 = Alarm is not triggered
1 = Alarm is triggered
Ch0x.CalFault
BOOL
Decimal
0 = Calibration did not fail
1 = Calibration error occurred during calibration of the channel
Ch0x.Calibrating
BOOL
Decimal
0 = Channel is not being calibrated
1 = Channel is being calibrated
Ch0x.CalGoodLowRef
BOOL
Decimal
0 = Valid Low Reference signal has not been sampled on this channel.
1 = Valid Low Reference signal has been sampled on this channel.
Ch0x.CalBadLowRef
BOOL
Decimal
0= Invalid Low Reference signal has not been sampled on this channel.
1 = Invalid Low Reference signal has been sampled on this channel.
Ch0x.CalGoodHighRef
BOOL
Decimal
0 = Valid High Reference signal has not been sampled on this channel.
1 = Valid High Reference signal has been sampled on this channel.
Ch0x.CalBadHighRef
BOOL
Decimal
0 = Invalid High Reference signal has not been sampled on this channel.
1 = Invalid High Reference signal has been sampled on this channel.
Ch0x.CalSuccessful
BOOL
Decimal
0 = Calibration was not successful
1 = Calibration was successful and calibrating state has been exited.
Ch0x.Data
REAL
Float
-1.0E11 to 1.0E11
Ch0x.RollingTimestamp
INT
Decimal
Any positive value
A continuously running 15-bit timer that counts in milliseconds (unrelated to the Coordinated System Time).
Device-defined data type: AB:5000_AO4:CAL:O:0
Connection Type: Data and Data with Calibration
Member Name
Type
Style
Valid Values
Ch0x.LLimitAlarmUnlatch
BOOL
Decimal
Transition from low to high unlatches alarm.
Ch0x.HLimitAlarmUnlatch
BOOL
Decimal
Transition from high to low unlatches alarm.
Ch0x.RampAlarmUnlatch
BOOL
Decimal
Transition from low to high unlatches alarm
Ch0x.Calibrate
BOOL
Decimal
0 = Channel is not being calibrated.
1 = Channel is being calibrated.
Ch0x.CalOutputLowRef
BOOL
Decimal
0 = Do not output Cal Low Reference.
1 = Commands device to output Calibration Low Reference.
Ch0x.CalOutputHighRef
BOOL
Decimal
0 = Do not Output Cal High Reference.
1 = Commands device to output Calibration High Reference Signal
Ch0x.CalLowRefPassed
BOOL
Decimal
0 = Not sending Recorded Cal Low Ref.
1 = Sending Recorded Cal Low Reference in Output Data for Calibration Verification.
Rising edge indicates that the Data field contains the recorded Low Reference value for the Output which should be used by the device in Calibration.
Ch0x.CalHighRefPassed
BOOL
Decimal
0 = Not sending Cal High Reference
1 = Sending recorded Calibration High Reference Signal in Output Data for Calibration Verification.
Rising edge indicates that the Data field contains the recorded High Reference value for the Output which should be used by the device in Calibration.
Ch0x.CalFinished
BOOL
Decimal
0 = Channel not triggered to complete the calibration procedure.
1 = Channel triggered to complete the calibration -procedure.
Ch0x.Data
REAL
Float
-1.0E11 to 1.0E11
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.