Device-defined data types (Generic ASCII)

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 Generic ASCII 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_ASCII: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.
ASCII	AB:5000_ASCII_Channel:I:0	Channel array configurations.

Device-defined data type: AB:5000_ASCII_Channel:I:0
Name	Type	Definition	Valid Values
Fault	BOOL	Indicates that channel data is inaccurate and is not trusted for use in the application.	0 = Good 1 = Bad, causing fault Tip: If set to 1, troubleshoot the device to correct the cause of the inaccuracy. Once the condition is removed, this is automatically reset to 0.
Uncertain	BOOL	Indicates that the channel data may be inaccurate, but the degree of inaccuracy is unknown.	0 = Good data 1 = Uncertain data Tip: If set to 1, troubleshoot the device to correct the cause of the inaccuracy. Once the condition is removed, this is automatically reset to 0.
TxDataLost	BOOL	The transmitted data lost due to Transmit Buffer Overflow. The bit remains set until Clear Buffer value changes from 0 to 1.	0 = Non-occurrence 1 = Occurrence
RxDataLost	BOOL	The received data lost due to Receive Buffer Overflow. The bit remains set until Clear Buffer value changes from 0 to 1.	0 = Non-occurrence 1 = Occurrence
ParityError	BOOL	Indicates if a parity error occurred.	0 = Non-occurrence 1 = Occurrence
TxFIFOEmpty	BOOL	Indicates if data is in transmit FIFO. The output FIFO has not sent all of its data to the ASCII device.	0 = Not Empty 1 = Empty
RxFIFOEmpty	BOOL	Indicates if data is in the receive FIFO. The input FIFO did not send all of its data to the interface.	0 = Not Empty 1 = Empty
NonDelimitedRecord	BOOL	An input record is received and sent to the interface that was not triggered by receiving a delimiter character. This event occurs when either the buffer is filled to its maximum receive size or a Message Timeout has occurred.	0 = Not Produced 1 = Produced
HandshakeError	BOOL	Handshake error. Used for Handshake mode only.	0 = Non-occurrence 1 = Occurrence
NewData	BOOL	New data exists in the device. Used for Handshake mode only.	0 = None 1 = New Data
TxDataSent	BOOL	Indicates that the device sent data to serial port indicated by the Transmit Transaction ID and can accept more transmit data.	0 = Not Complete 1 = Complete
TxDataLengthInvalid	BOOL	Indicates if the TxDataLength is valid.	0 = Correct 1 = Length of TxDataLength is illegal
RxDataLengthInvalid	BOOL	Indicates if the RxDataLength is valid.	0 = Correct 1 = Length of RxDataLength is illegal¹
FramingError	BOOL	Indicates if a framing error occurred.	0 = Non-occurrence 1 = Occurrence
BufferOverRun	BOOL	Indicates if a buffer overrun occurred.	0 = Non-occurrence 1 = Occurrence
CTS	BOOL	Indicates if the CTS is active.	0 = Inactive 1 = Active
RTS	BOOL	Indicates if the RTS is active.	0 = Inactive 1 = Active
DSR	BOOL	Indicates if the DSR is active.	0 = Inactive 1 = Active
DCD	BOOL	Indicates if the DCD is active.	0 = Inactive 1 = Active
DTR	BOOL	Indicates if the DTR is active.	0 = Inactive 1 = Active
XOFF	BOOL	Indicates that the device stop sending data (Xoff) or not (Xon).	0 = On 1 = Off
BREAK	BOOL	Shows if a Break Interrupt occurred. If a Break Interrupt is detected, the device keeps receiving binary data from the serial port. The Receive data includes null Data (0x00).	0 = Not Detected 1 = Detected
TxACK	SINT	Feedback from the latest Transmit Transaction ID acknowledged by the serial device.	-128 to +127
RxID	SINT	Notification of receiving by updating number.	-128 to +127
RxDataLength	INT	Data length in RXData.	1 to 256
RxData	SINT[256]	Received data from modem.	-128 to +127

Device-defined data type: AB:5000_ASCII:I:1
Name	Type	Definition	Valid Values
RunMode	BOOL	Channel operating state.	0 = Idle 1 = Run Mode
ConnectionFaulted	BOOL	Indicates if the connection is running. The module sets this value to 0 when connected and then changes the 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.
ASCII	AB:5000_ASCII_Channel:I:1	Generic ASCII produce data.

Device-defined data type: AB:5000_ASCII_Channel:I:1
Name	Type	Definition	Valid Values
Fault	BOOL	Indicates that channel data is inaccurate and is not trusted for use in the application.	0 = Good 1 = Bad, causing fault Tip: If set to 1, troubleshoot the device to correct the cause of the inaccuracy. Once the condition is removed, this is automatically reset to 0.
Uncertain	BOOL	Indicates that the channel data may be inaccurate, but the degree of inaccuracy is unknown.	0 = Good data 1 = Uncertain data Tip: If set to 1, troubleshoot the device to correct the cause of the inaccuracy. Once the condition is removed, this is automatically reset to 0.
TxDataLost	BOOL	The transmitted data lost due to Transmit Buffer Overflow. The bit remains set until Clear Buffer value changes from 0 to 1.	0 = Non-occurrence 1 = Occurrence
RxDataLost	BOOL	The received data lost due to Receive Buffer Overflow. The bit remains set until Clear Buffer value changes from 0 to 1.	0 = Non-occurrence 1 = Occurrence
ParityError	BOOL	Indicates if a parity error occurred.	0 = Non-occurrence 1 = Occurrence
TxFIFOEmpty	BOOL	Indicates data is in transmit FIFO. The output FIFO did not send all of its data to the ASCII device.	0 = Not Empty 1 = Empty
RxFIFOEmpty	BOOL	Indicates data is in the receive FIFO. The input FIFO did not send all of its data to the interface.	0 = Not Empty 1 = Empty
NonDelimitedRecord	BOOL	An input record is received and sent to the interface that was not triggered by receiving a delimiter character. This event occurs when either the buffer is filled to its maximum receive size or a Message Timeout has occurred.	0 = Not Produced 1 = Produced
HandshakeError	BOOL	Handshake error. Used for Handshake mode only.	0 = Non-occurrence 1 = Occurrence
NewData	BOOL	New data exists in the device. Used for Handshake mode only.	0 = None 1 = New Data
TxDataSent	BOOL	Indicates that the device sent data to serial port indicated by the Transmit Transaction ID and can accept more transmit data.	0 = Not Complete 1 = Complete
TxDataLengthInvalid	BOOL	Indicates if the TxDataLength is valid.	0 = Correct 1 = Length of TxDataLength is illegal
RxDataLengthInvalid	BOOL	Indicates if the RxDataLength is valid.	0 = Correct 1 = Length of RxDataLength is illegal¹
FramingError	BOOL	Indicates if a framing error occurred.	0 = Non-occurrence 1 = Occurrence
BufferOverrun	BOOL	Indicates if a buffer overrun occurred.	0 = Non-occurrence 1 = Occurrence
CTS	BOOL	Indicates if the CTS is active.	0 = Inactive 1 = Active
RTS	BOOL	Indicates if the RTS is active.	0 = Inactive 1 = Active
DSR	BOOL	Indicates if the DSR is active.	0 = Inactive 1 = Active
DCD	BOOL	Indicates if the DCD is active.	0 = Inactive 1 = Active
DTR	BOOL	Indicates if the DTR is active.	0 = Inactive 1 = Active
XOFF	BOOL	Indicates that the device stop sending data (Xoff) or not (Xon).	0 = On 1 = Off
BREAK	BOOL	Shows if a Break Interrupt occurred. If a Break Interrupt is detected, the device keeps receiving binary data from the serial port. The Receive data includes null Data (0x00).	0 = Not Detected 1 = Detected
TxACK	SINT	Feedback from the latest Transmit Transaction ID acknowledged by the serial device.	-128 to +127
RxID	SINT	Notification of receiving by updating number.	-128 to +127
RxDataLength	INT	Data length in the RXData.	1 to 256
RxData	SINT[256]	Received data from modem.	-128 to +127

Length is greater than the Max buffer length defined in Device definition
.

Device-defined data type: AB:5000_ASCII:O:0
Name	Type	Definition	Valid Values
ASCII	AB:5000_ASCII_Channel:O:0	Channel array configurations.

Device-defined data type: AB:5000_ASCII_Channel:O:0
Name	Type	Definition	Valid Values
TxID	SINT	Transmit Transaction ID. Increment this value to transmit data from the serial port.	-128 to +127
RxID	SINT	Received Transaction ID. Increment this value to receive data from the serial port.	-128 to +127
TxDataLength	INT	Transmitted Data length of each channel.	1 to 255
ClearBuffer	BOOL	If Clear Buffer value changes from 0 to 1, the Receive and Transaction buffer is cleared.	0 = No Change 1 = Buffer Cleared
DTR	BOOL	DTR line signal level sent out when rising edge of EXEC bit is detected.	0 = Inactive 1 = Active
RTS	BOOL	RTS line Signal level sent out when rising edge of EXEC bit is detected.	0 = Inactive 1 = Active
EXEC	BOOL	If EXEC bit changes from 0 to 1, the device outputs a signal level which is set in the DTR/RTS tag.	0 = Inactive 1 = Active
RxDataLength	INT	Received Data length of each channel.	1 to 256
TxData	SINT[256]	Output data from the device.	-128 to +127

Device-defined data types

Provide Feedback

Have questions or feedback about this documentation? Please submit your feedback here.