Device-defined data types (HART Output)

Device-defined data type names vary for each device depending on selections made when the device was created.
These tables include information for these data types:
  • input (as indicated by an "I")
  • output (as indicated by an "O")
  • configuration (as indicated by a "C")
Device-defined data type: AB:1718_19_AOn_HART:C:0
Connection Type: Data
Member Name
Type
Style
Valid Values
Ch0x.Range
SINT
Decimal
4 = 0...20 mA
5 = 4...20 mA
Ch0x.AlarmDisable
BOOL
Decimal
0 = Alarms are enabled
1 = Alarms are disabled
Ch0x.DiagEn
BOOL
Decimal
0 = Diagnostics are disabled
1 = Diagnostics are enabled
Ch0x.RampToProg
BOOL
Decimal
0 = Ramping is disabled
1 = Ramping to Program Mode is enabled
Ch0x.RampToFault
BOOL
Decimal
0 = Ramping is disabled
1 = Ramping to Fault Mode is enabled
Ch0x.HoldForInit
BOOL
Decimal
0 = Disabled
1 = Enabled
Ch0x.FaultMode
BOOL
Decimal
0 = Transition to user-defined value
1 = Hold Last State
Ch0x.ProgMode
BOOL
Decimal
0 = Transition to user-defined value
1 = Hold Last State
Ch0x.ProgramToFaultEn
BOOL
Decimal
0 = Channel remains in Program mode
1 = Channel remains in Fault mode
Ch0x.RampInRun
BOOL
Decimal
0 = Ramping is disabled
1 = Ramp in Run Mode is enabled
Ch0x.HARTEn
BOOL
Decimal
0 = HART is disabled
1 = HART is enabled
Ch0x.PVDampingConfigEn
BOOL
Decimal
0 = HART PV Damping is disabled
1 = HART PV Damping is enabled
Ch0x.PVRangeConfigEn
BOOL
Decimal
0 = HART PV Range is disabled
1 = HART PV Range is enabled
Ch0x.PassthroughOnlyEn
BOOL
Decimal
Reserved
Ch0x.PVUnits
SINT
Decimal
PV units code for PV range.
Ch0x.PVTransferFunction
SINT
Decimal
0...255
Ch0x.FaultValueStateDuration
SINT
Decimal
0 = Forever
1 = 1 second
2 = 2 seconds
5 = 5 seconds
10 = 10 seconds
Ch0x.LowSignal
REAL
Float
-1.0E+11...+1.0E+11
A combination of LowSignal, HighSignal, LowEngineering, and HighEngineering are used to scale the input data returned by the device.
Ch0x.HighSignal
REAL
Float
-1.0E+11...+1.0E+11
A combination of LowSignal, HighSignal, LowEngineering, and HighEngineering are used to scale the input data returned by the device.
Ch0x.LowEngineering
REAL
Float
-1.0E+11...+1.0E+11
A combination of LowSignal, HighSignal, LowEngineering, and HighEngineering are used to scale the input data returned by the device.
Ch0x.HighEngineering
REAL
Float
-1.0E+11...+1.0E+11
A combination of LowSignal, HighSignal, LowEngineering, and HighEngineering are used to scale the input data returned by the device.
Ch0x.LowLimit
REAL
Float
-1.0E+11...+1.0E+11
Ch0x.HighLimit
REAL
Float
-1.0E+11...+1.0E+11
Ch0x.MaxRampRate
REAL
Float
-1.0E+11...+1.0E+11
Configures the maximum rate that the output value may change when transitioning to either FaultValue or ProgValue if either RampToFault or RampToProg bits are set, respectively, or in Run Mode if RampToRun is set.
Ch0x.Offset
REAL
Float
-1.0E+11...+1.0E+11
This value is used to correct for actuator inaccuracy in the output actuator. The value is configured per channel and is added to the data before scaling is performed.
Ch0x.FaultValue
REAL
Float
-1.0E+11...+1.0E+11
Defines the value for the analog output in case of a communication fault if FaultMode equals zero.
Ch0x.ProgValue
REAL
Float
-1.0E+11...+1.0E+11
Defines the value for the analog output when the connection is in Program mode if the ProgMode bit is set to "User-defined Value".
Ch0x.FaultFinalState
REAL
Float
-1.0E+11...+1.0E+11
Ch0x.PVDamping
REAL
Float
-1.0E+11...+1.0E+11
Ch0x.PVUpperRange
REAL
Float
-1.0E+11...+1.0E+11
Ch0x.PVLowerRange
REAL
Float
-1.0E+11...+1.0E+11
Device-defined data type: AB:1718_19_AOn:I:0
Connection Type: Data
Member Name
Type
Style
Valid Values
RunMode
BOOL
Decimal
0 = Idle
1 = Run
ConnectionFaulted
BOOL
Decimal
0 = A connection exists between the device and the controller
1 = Bad
DiagnosticActive
BOOL
Decimal
0 = No diagnostics active
1 = One or more diagnostics are active or the prognostics threshold is reached
DiagnosticSequenceCount
SINT
Decimal
-128...127
The value of 0 is skipped except during device power-up.
Ch0x.Fault
BOOL
Decimal
0 = A fault does not exist
1 = A fault exists
Ch0x.Uncertain
BOOL
Decimal
0 = Data is valid
1 = Validity of data is 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.
Ch0x.ShortCircuit
BOOL
Decimal
0 = Short Circuit or Overcurrent condition does not exist
1 = Short Circuit or Overcurrent condition exists
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 = 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.Data
REAL
Float
-1.0E+11...+1.0E+11
Ch0x.RollingTimestamp
INT
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:1718_19_AOn_HART:I:0
Connection Type: Data
Member Name
Type
Style
Valid Values
RunMode
BOOL
Decimal
0 = Idle
1 = Run
ConnectionFaulted
BOOL
Decimal
0 = A connection exists between the device and the controller
1 = Bad
DiagnosticActive
BOOL
Decimal
0 = No diagnostics active
1 = One or more diagnostics are active or the prognostics threshold is reached
DiagnosticSequenceCount
SINT
Decimal
-128...127
The value of 0 is skipped except during device power-up.
Ch0x.Fault
BOOL
Decimal
0 = A fault does not exist
1 = A fault exists
Ch0x.Uncertain
BOOL
Decimal
0 = Data is valid
1 = Validity of data is 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.
Ch0x.ShortCircuit
BOOL
Decimal
0 = Short Circuit or Overcurrent condition does not exist
1 = Short Circuit or Overcurrent condition exists
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 = 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.Data
REAL
Float
-1.0E+11...+1.0E+11
Ch0x.RollingTimeStamp
INT
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.
Ch0x.DeviceStatus.GeneralStatus
SINT
Decimal
HART device status information.
Ch0x.DeviceStatus.HARTInit
BOOL
Decimal
GeneralStatus bit 0
0 = If Ch0x.DeviceStatus.HARTCommFail is 1, then HART is not enabled on this channel.
1 = If Ch0x.DeviceStatus.HARTCommFail is 1, then this device is sending out HART messages to attempt to establish communication with a HART device.
Ch0x.DeviceStatus.HARTCommFail
BOOL
Decimal
GeneralStatus bit 1
HART communication failure, device not found, or HART not enabled.
If this bit is 1, none of the other data in the HART part of the input tag are valid.
Ch0x.DeviceStatus.MsgReady
BOOL
Decimal
GeneralStatus bit 2
0 = Passthrough message reply is not ready for query service.
1 = Passthrough message reply is ready for query service.
Ch0x.DeviceStatus.CurrentFault
BOOL
Decimal
GeneralStatus bit 3
0 = Analog current measurement matches the current value reported by the field device over the HART network.
1 = Analog current measurement does not match the current value reported by the field device over the HART network.
Ch0x.DeviceStatus.ConfigurationChanged
BOOL
Decimal
GeneralStatus bit 4
If this bit is 1, it indicates that the field device configuration changed and new configuration information can be obtained from the 1718/1719 HART device. Use CIP MSG GetDeviceInfo to retrieve the new configuration information and clear this bit.
Ch0x.DeviceStatus.MaintenanceRequired
BOOL
Decimal
GeneralStatus bit 5
0 = No maintenance required.
1 = Maintenance required.
Bit 0 of extended device statuu (if using command 9, or from command 48, if supported).
Ch0x.DeviceStatus.UpdatedStatusReady
BOOL
Decimal
GeneralStatus bit 6
If this bit is 1, it indicates that new device diagnostic information is available. Use a CIP Message with Service 4C to retrieve the new diagnostic information.
Ch0x.DeviceStatus.HARTFault
BOOL
Decimal
GeneralStatus bit 7
0 = Good
1 = An issue with HART data from the field device on this channel exists.
Examples that can cause this issue include, HART not enabled, HART device not connected, and HART communication failure due to noise.
Examples of field device status conditions that can cause this issue include, device malfunction, PV out of limits, loop current saturated, and loop current fixed.
Ch0x.DeviceStatus.ResponseCode
SINT
Decimal
HART communication status byte or Response code from a recent HART reply.
For more information, see the Response Codes and Field Device Status table in the 1719 Ex I/O User Manual, publication 1719-UM001.
Ch0x.DeviceStatus.FieldDeviceStatus
SINT
Decimal
HART device status byte from a recent HART reply. This value indicates the health of the HART field device.
For more information, see the Field Device Status Bit Mask Definitions table in the 1719 Ex I/O User Manual, publication 1719-UM001.
Ch0x.DeviceStatus.PVOutOfLimits
BOOL
Decimal
FieldDeviceStatus bit 0
0 = Good
1 = The primary variable is beyond its operating limit.
Ch0x.DeviceStatus.VariableOutOfLimits
BOOL
Decimal
FieldDeviceStatus bit 1
0 = Good
1 = A device variable that is not mapped to the PV is beyond its operating limit.
Ch0x.DeviceStatus.CurrentSaturated
BOOL
Decimal
FieldDeviceStatus bit 2
0 = Good
1 = The loop current reached its upper or lower endpoint limit and cannot increase or decrease any further.
Ch0x.DeviceStatus.CurrentFixed
BOOL
Decimal
FieldDeviceStatus bit 3
0 = Good
1 = The loop current is being held at a fixed value and is not responding to process variations.
Ch0x.DeviceStatus.MoreStatus
BOOL
Decimal
FieldDeviceStatus bit 4
0 = Good
1 = More status information is available, which can be retrieved using command 48, "Read additional device status".
Ch0x.DeviceStatus.ColdStart
BOOL
Decimal
FieldDeviceStatus bit 5
0 = Good
1 = A power failure or device reset occurred.
Ch0x.DeviceStatus.Changed
BOOL
Decimal
FieldDeviceStatus bit 6
0 = Good
1 = An operation was performed that changed the device configuration.
Ch0x.DeviceStatus.Malfunction
BOOL
Decimal
FieldDeviceStatus bit 7
0 = Good
1 = The device detected a serious error or failure that compromises device operation.
Ch0x.DeviceStatus.PVConfigFailed
BOOL
Decimal
0 = Good
1 = PV auto-configuration failed
Ch0x.PV
REAL
Float
Dynamic variable used for mapping a HART device variable.
Ch0x.SV
REAL
Float
Dynamic variable used for mapping a HART device variable.
Ch0x.TV
REAL
Float
Dynamic variable used for mapping a HART device variable.
Ch0x.FV
REAL
Float
Dynamic variable used for mapping a HART device variable.
Ch0x.PVStatus
SINT
Decimal
Device variable status value that indicates the quality of the associated device variable.
For more information, see the HART PV, SV, TV, and FV Status Values table in the 1719 Ex I/O User Manual, publication 1719-UM001.
Ch0x.SVStatus
SINT
Decimal
Device variable status value that indicates the quality of the associated device variable.
For more information, see the HART PV, SV, TV, and FV Status Values table in the 1719 Ex I/O User Manual, publication 1719-UM001.
Ch0x.TVStatus
SINT
Decimal
Device variable status value that indicates the quality of the associated device variable.
For more information, see the HART PV, SV, TV, and FV Status Values table in the 1719 Ex I/O User Manual, publication 1719-UM001.
Ch0x.FVStatus
SINT
Decimal
Device variable status value that indicates the quality of the associated device variable.
For more information, see the HART PV, SV, TV, and FV Status Values table in the 1719 Ex I/O User Manual, publication 1719-UM001.
Ch0x.PVUnitsCode
SINT
Decimal
Engineering units for the HART PV.
Ch0x.SVUnitscode
SINT
Decimal
Engineering units for the HART PV.
Ch0x.TVUnitsCode
SINT
Decimal
Engineering units for the HART PV.
Ch0x.FVUnitsCode
SINT
Decimal
Engineering units for the HART PV.
Device-defined data type: AB:1718_19_AOn:O:0
Connection Type: Data
Member Name
Type
Style
Valid Values
Ch0x.Data
REAL
Float
-1.0E+11...+1.0E+11
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal