Device-defined data types (Modbus Master)

Device-defined data type names vary for each serial protocol depending on the
Channel
 selection in
Device definition
. The tables below list and describe the device-defined data types created for the Modbus Master 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_ModbusMaster_Status_<XXXXXXXX>: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 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 diagnostic 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...+127
The value of 0 is skipped except during device power-up.
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.
LastExecutedCommand
SINT
The number of the latest executed command. The Update Counter indicates the status for command level. If this value is updated, either a new command is executed, not changed, command has not executed, or is not finished yet.
-1 = only at initial startup before 1st command is executed
0...49 = valid value once command is executed
Command
AB:5000_Modbus_W_Response_Struct:I:1
Write command response
—
Command
AB:5000_Modbus_R_<t><n><address>_<size>_Struct:I:1
Read command response
—
Device-defined data type: AB:5000_ModbusMaster_<XXXXXXXX>: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 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 diagnostic 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...+127
The value of 0 is skipped except during device power-up.
Command
AB:5000_Modbus_W_Response_Struct:I:1
Write command response
—
Command
AB:5000_Modbus_R_<t><n><address>_<size>_Struct:I:1
Read command response
—
Device-defined data type: AB:5000_Modbus_W_Response_Struct: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.
Disabled
BOOL
Indicates if command is enabled or disabled.
0 = Command is enabled
1 = Command is disabled
ParityError
BOOL
Indicates if a parity error occurred.
0 = Non-occurrence
1 = Occurrence
ResponseTimeout
BOOL
Indicates if a response timeout occurred.
0 = Non-occurrence
1 = Occurrence
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
SlaveErrorCode
SINT
Modbus Exception Error Code from the slave.
01 Illegal Function
02 Illegal Data Address
03 Illegal Data Value
04 Server Device Failure
06 Server Device Busy
ExecutionCount
SINT
The number of times the command is executed.
-128..+127
Device-defined data type: AB:5000_Modbus_R_<t><n><address>_<size>_Struct: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.
Disabled
BOOL
Indicates if command is enabled or disabled.
0 = Command is enabled
1 = Command is disabled
ParityError
BOOL
Indicates if a parity error occurred.
0 = Non-occurrence
1 = Occurrence
ResponseTimeout
BOOL
Indicates if a response timeout occurred.
0 = Non-occurrence
1 = Occurrence
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
SlaveErrorCode
SINT
Modbus Exception Error Code from the slave.
01 Illegal Function
02 Illegal Data Address
03 Illegal Data Value
04 Server Device Failure
06 Server Device Busy
ExecutionCount
SINT
The number of times the command is executed.
-128..+127
Data
INT, SINT, REAL
Command read response data.
-128...+127
-32768...+32767
-3.402823E38...-1.1754944E-38 (negative values)
and
0
and
1.1754944E-38...3.402823E38 (positive values)
Device-defined data type: AB:5000_ModbusMaster_Run_<XXXXXXXX>:O:1
Name
Type
Definition
Valid Values
Run
BOOL
Channel operating state.
0 = Idle
1 = Run Mode
Tip:
 The Run bit must be set to Run in order for the Modbus Master command to execute.
CommandxxDisable
BOOL
Indicates if command 0...49 is enabled or disabled.
0 = Command is enabled
1 = Command is disabled
Command
AB:5000_Modbus_W_<t><n><address>_<size>_Struct:O:0
Write command response
-128...+127
-32768...+32767
-3.402823E38...-1.1754944E-38 (negative values)
and
0
and
1.1754944E-38...3.402823E38 (positive values)
Device-defined data type: AB:5000_ModbusMaster_<XXXXXXXX>:O:0
Name
Type
Definition
Valid Values
Command
AB:5000_Modbus_W_<t><n><address>_<size>_Struct:O:0
Write command response data.
-128...+127
-32768...+32767
-3.402823E38...-1.1754944E-38 (negative values)
and
0
and
1.1754944E-38...3.402823E38 (positive values)
Device-defined Data Type: AB:5000_Modbus_W_<t><n><address>_<size>_Struct:O:0
Name
Type
Definition
Valid Values
Data
INT, SINT, REAL
Command write data.
-128...+127
-32768...+32767
-3.402823E38...-1.1754944E-38 (negative values)
and
0
and
1.1754944E-38...3.402823E38 (positive values)
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal