SIDirect Communication Driver diagnostic info items
- Last UpdatedSep 16, 2024
- 4 minute read
The SIDirect Communication Driver provides Diagnostic System items specific to the Symbolic object. Diagnostic Info Items are the group of items that provide statistics information to reflect the performance of the driver.
Diagnostic Info Item names start with “$SYS$” to differentiate them from PLC tags.
|
Item Name |
Data Type |
Item Description |
Access |
Range/ Format |
|
$SYS$ItemUpdateRate |
VT_UI4 |
Returns the instantaneous updates per second for subscribed items. To reset the value, set system item $SYS$ResetStatistics to 1. |
Read only |
Range: 0 to 4294967295 |
|
$SYS$Load |
VT_R4 |
Returns the load of the connection to the PLC. The load is the rate of item updates over the last 15 minutes, and is expressed as a multiplier of the Load Factor. To reset the value, set system item $SYS$ResetStatistics to 1. A load factor of 1 indicates that the rate of item updates is 1000 values/second; a load factor of 2 indicates that the rate of item updates is 2000 values/second. |
Read only |
|
|
$SYS$TagsResolved |
VT_UI4 |
Returns the number of unique tags that have been sent successfully to the PLC for update. |
Read only |
Range: 0 to 4294967295 |
|
$SYS$ReadCount |
VT_UI4 |
Returns the cumulative number of values that have been received successfully from the PLC. To reset the value, set system item $SYS$ResetStatistics to 1. |
Read only |
Range: 0 to 4294967295 |
|
$SYS$WriteCount |
VT_UI4 |
Returns the cumulative number of values that have been written successfully to the PLC. To reset the value, set system item $SYS$ResetStatistics to 1. |
Read only |
Range: 0 to 4294967295 |
|
$SYS$ReadCountFailed |
VT_UI4 |
Returns the cumulative number of failed read requests sent from the server to the PLC. To reset the value, set system item $SYS$ResetStatistics to 1. |
Read only |
Range: 0 to 4294967295 |
|
$SYS$WriteCountFailed |
VT_UI4 |
Returns the cumulative number of failed write requests sent from the server to the PLC. To reset the value, set system item $SYS$ResetStatistics to 1. |
Read only |
Range: 0 to 4294967295 |
|
$SYS$LastReadDuration |
VT_UI4 |
Returns the elapsed time in milliseconds for the most recent read request to the PLC. Quality is set to 0x08 if a read has not occurred since the server started up. |
Read only |
Range: 0 to 4294967295 |
|
$SYS$LastWriteDuration |
VT_UI4 |
Returns the elapsed time in milliseconds for the most recent write request to the PLC. Quality is set to 0x08 if a write has not occurred since the server started up. |
Read only |
Range: 0 to 4294967295 |
|
$SYS$LastReadCount |
VT_UI4 |
Returns the total number of tags that were involved in the most recent read request to the PLC. |
Read only |
Range: 0 to 4294967295 |
|
$SYS$LastWriteCount |
VT_UI4 |
Returns the total number of tags that were involved in the most recent write request to the PLC. |
Read only |
Range: 0 to 4294967295 |
|
$SYS$HostName |
VT_BSTR |
Returns the configured host name or IP address of PLC. |
Read only |
|
|
$SYS$LastReadTime |
VT_DATE |
Returns the system time of the most recent read request to the PLC. Quality is set to 0x08 if a read has not occurred since the server started up. |
Read only |
System time is returned as UTC |
|
$SYS$LastWriteTime |
VT_DATE |
Returns the system time of the most recent write request to the PLC. Quality is set to 0x08 if a write has not occurred since the server started up. |
Read only |
System time is returned as UTC |
|
$SYS$StartTime |
VT_DATE |
Returns the startup time of the server. |
Read only |
System time is returned as UTC |
|
$SYS$ConnStatus |
VT_UI4 |
Returns the current known connection status to the PLC. |
Read only |
0 = Disconnected 1 = Connecting 2 = Connected |
|
$SYS$LastConnTime |
VT_DATE |
Returns the system time of the most recent connection attempt to the PLC. |
Read only |
System time is returned as UTC |
|
$SYS$LastDisconnTime |
VT_DATE |
Returns the system time of the most recent disconnection attempt to the PLC. Quality is set to 0x08 if a disconnection has not occurred since the server started up. |
Read only |
System time is returned as UTC |
|
$SYS$PLCType |
VT_BSTR |
Returns the PLC model number. |
Read only |
|
|
$SYS$PLCFirmware |
VT_BSTR |
Returns the PLC firmware version. |
Read only |
|
|
$SYS$ResetStatistics |
VT_BOOL |
To reset system item statistics, set this item to 1. The server returns the value of this item to 0 when the reset operation finishes. |
Read/Write |
1 = True (reset statistics) 0 = False |
|
$SYS$SyncDb |
VT_BOOL |
To force an upload of the tag database from the PLC to server, set this item to 1. The tag database will be uploaded, even if it is up to date. The server automatically returns the value of this item to 0 when the upload operation finishes. |
Read/Write |
1 = True (force upload) 0 = False The server automatically syncs up the tag database from the PLC. This system item can be used to ensure that the tag database in the server is synchronized to that in the PLC. |
|
$SYS$PLCAccessLevel |
VT_UI4 |
Returns the CPU Protection Level configured in the PLC. Refer to the Siemens TIA documentation for descriptions of each access level. |
Read only |
0 = Full Access including Fail Safe Access 1 = Full Access 2 = Read Access 3 = HMI Access 4 = No Access |
|
$SYS$DiagnosticLogging |
VT_UI4 |
Enable logger flags at protocol level. Example: All flags can be enabled by writing 15(0x0F) to this system item. The logger output folder is the same aacfg file. The file name is the same name as the PLC hierarchy node name. For more information see Using the OI SIDirect Diagnostic Log |
Read/Write |
0x01 = Info 0x02 = Warning 0x04 = Error 0x08 = Trace |