Device-defined data types (DF1 Point to Point)

Device-defined data type names vary for each serial protocol depending on the
Channel
selection in
Device definition
. These tables describe the device-defined data types created for the DF1 Point to Point protocol. The tables include information for input (as indicated by an "I") and information for output (as indicated by an "O").
Device-defined data type: AB:5000_DF1_PointToPoint:I:0
Name
Type
Definition
Valid Values
DF1
AB:5000_DF1_Channel:I:0
DF1 point to point specific produce data.
DF1Modem
AB:5000_DF1_Modem_Channel:O:0
DF1 common produce data.
Device-defined data type: AB:5000_DF1_Channel:I:0
Name
Type
Definition
Valid Values
RunMode
BOOL
Channel operating state.
0 = Idle
1 = Run Mode
ConnectionFaulted
BOOL
Indicates if the connection is running. The device sets value to 0 when connected and then changes value to 1 when not connected.
0 = Connection running
1 = Connection is not running
DiagnosticActive
BOOL
Indicates if any diagnostics are active or if the prognostics threshold is reached.
0 = No diagnostics active
1 = One or more diagnostics are active or the prognostics threshold is reached.
DiagnosticSequenceCount
SINT
Diagnostic counter. The value increments each time a distinct diagnostic condition is detected, and again when the condition transitions from detected to not detected.
Set to zero by product reset or power cycle. Wraps from 255 (-1) to 1 skipping 0.
-128 to +127
The value of 0 is skipped except during device power-up.
CTS
BOOL
Clear to send line of serial port.
0, 1
RTS
BOOL
Request to send line of serial port.
0, 1
DSR
BOOL
Data Set Ready line of serial port.
0, 1
DCD
BOOL
Data Carrier Detect line of serial port.
0, 1
DTR
BOOL
Data Terminal Ready line of serial port.
0, 1
MsgProcessing
BOOL
Indicates firmware processing of MSG instruction.
Device-defined data type: AB:5000_DF1_Modem_Channel:I:0
Name
Type
Definition
Valid Values
TxAck
SINT
Feedback from the latest Transmit Transaction ID.
RxId
SINT
Received Transaction ID. If this value changes, Receive characters are new and ready for processing.
0x00 - 0xff
RxDataLength
INT
The number of bytes to read from a serial transmission.
1 - 256
RxData
SINT [128]
Characters received form the serial port.
1 - 128
Device-defined data type: AB:5000_DF1_PointToPoint:O:0
Name
Type
Definition
Valid Values
DF1Modem
AB:5000_DF1_PointToPoint:O:0
Device-defined data type: AB:5000_DF1_Modem_Channel:O:0
Name
Type
Definition
Valid Values
TxID
SINT
If set to 0, number of bytes equals C:BufferLength.
0x00 - 0xff
DTR
BOOL
Data Terminal Ready line of serial port.
0, 1
RTS
BOOL
Request to send line of serial port.
0, 1
EXEC
BOOL
On a transition from 0 to 1, the DTR and RTS values are sent to the serial interface.
0, 1
TxDataLength
INT
Channel array configurations.
TxData
SINT [128]
Characters to send to the serial port.
All
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal