Versions Compared

Old Version 4

changes.mady.by.user kristina schaeffer (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user ken Halprin

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

titleTable Of Contents

...

Table of Contents
maxLevel3
minLevel3
typeflat
printablefalse
separatorpipe

Overview

These object items are available for Devices and Connection Objects through OPC.

Common Object Items 

Note

To access these items you must click on the object itself and not the Protocol/Standard/Extended Items.


ItemData TypeDescription
ActiveItemsI4The total number of items active or advised to this device.
AllPollResetBoolClears all of the "Total" poll statistics items.
BarometerI4An indicator of the communication status on the primary and secondary connections
Note: The communications barometer represents the marginal success rate of communications. For each poll cycle that does not receive a response for one or more poll messages, the barometer will increase by two (2), with a maximum value of 100. For each poll cycle that does receive a valid response for all poll messages, the barometer to decreases by 1, with the lowest value being 0. These barometer changes cause failures in communications to show up quickly as the barometer rises. However, good communications must be maintained longer and more steadily for the barometer to fall back to 0.
CommStatusI2Represents the status of the communication link to the device. The value will be 1 if a communication link to the device can be established – even if the device does not respond to polls. The value will be 0 if a communication link cannot be established to the device.
IncompletePollBoolSet to false at the beginning of each poll. The value changes from false to true if the last poll attempt was incomplete.
ItemCountI4The number of items that have been added by OPC clients.
LastPollAttemptTimeDateThe date time stamp of the last poll attempt.
LastPollAttemptTimeUTCDateThe date time stamp of the last poll attempt in UTC (without time zone bias).
LastPollFailureCodeI4An integer value indicating the result of the last poll.
0 = Success
1 = No poll initiated
2 = Error opening connection
3 = Error during modem initialization
4 = Connection failed
5 = Line is busy
6 = No answer
7 = Connection was dropped
LastPollLengthI4The length of time (in seconds) between the beginning of
the last poll
a poll cycle and the successful completion of said poll cycle.
LastPollSuccessTimeDateThe date time stamp of the last successful poll.
LastPollSuccessTimeUTCDateThe date time stamp of the last successful poll in UTC (without time zone bias).
MinutesSinceCompleteI4Minutes since the last complete poll.
ScanIntervalsI4Bitmask of intervals that the device is currently polling.
ScanningBoolThis item is true when the object is scanning.
SecondsSinceCompleteI4Seconds since the last complete poll.
ServerVersionStringThe current server version.
StatusI2

An integer value indicating the result of the last poll.

0 = Starting
1 = Complete
2 = Incomplete
3 = Interrupted
4 = Communication error
5 = Failed
6 = Poll

was not initiated

Not Started
7 = Port is Closed or Disabled

StatusDescString

Descriptive result of the last poll.

"Starting"
"Complete Poll"
"Incomplete Poll"
"Interrupted Poll"
"Communication Error"
"Failed Poll"
"Poll Not Started"
"Port is Closed or Disabled"

TimeSinceCompleteI4Time (in minutes) since the last complete poll.

Timespan-Based Common Object Items

Substitute the appropriate available duration LastHour, ThisHour, Today, Total, or Yesterday for <Timespan> in each of the available items in the table below. Each of the items in the table below is available for five different time periods where <Timespan> is one of the following time periods:

...

Example 5: For the total number of Bad Responses, add the item ObjectName.TotalBadResponses where ObjectName is replaced with your actual device or port name.

ItemData TypeDescription
<Timespan>BadResponsesI4The number of bad responses.
<Timespan>CharReceivesI4The total number of bytes received on the primary and secondary connections. 
<Timespan>CharSendI4The total number of
times all connection tries were exhausted for a poll without establishing a connection.
bytes sent in poll messages on the primary and secondary connections. 
<Timespan>CommNoInitsI4For serial based connections, the total number of times the port could not be opened or setup. For socket based connections, the total number of times the socket could not opened or connected.
<Timespan>CommNoOpensI4The number of times a port could not be opened or a socket could not be created.
<Timespan>CommRetriesI4The total number of times poll messages were due to be sent on the primary and secondary connections, but the connection module could not access, or connect to, the required resource (such as a serial port) in the selected <timespan>.
Note: The CommRetries represent the number of times a connection module could not access or open the connection link. For serial connections, this is simply the specified serial port. For dialup connections, this is the specified serial port and/or the modem connection to the device. For connection modules that offer a 'connection retries' configuration parameter, the CommFail item is also used. This item represents the number of times a connection was attempted for each 'connection retry' and no connection could be made.
<Timespan>CRCsI4The total number of CRC, checksum, or other validation checks, that failed on the primary and secondary connections.
<Timespan>ErrorsI4The number of polls that resulted in a protocol error.
<Timespan>GoodResponsesI4The number of good responses.
<Timespan>InterruptionsI4The number of times a poll was interrupted by a higher priority task.
<Timespan>NoPollsI4The number of times a poll was not started when it was due (such as when a device is disabled or not licensed).
<Timespan>NoResponsesI4The total number of poll messages that did not receive a valid response to any of the poll attempts on the primary and secondary connections.
<Timespan>PartialPollsI4The number of times a device was polled but received good responses on only some of its requests.
<Timespan>PctBadTriesR4The percentage of polls that did not get a good response. PctBadTries = 100 * (Bad
Responses
Tries / (Queries + Retries))
<Timespan>PctErrorsR4The percentage of polls that resulted in a protocol error. PctErrors = 100 * (Error Responses / Queries)
<Timespan>PctFirstTriesR4The percentage of good responses to first tries. PctFirstTries = 100 * (First Try Responses / Queries)
<Timespan>PctGoodPollsR4The percentage of complete poll cycles. PctGoodPolls = 100 * (Complete Polls / Poll Attempts)
<Timespan>PctGoodResponsesR4The percentage of good responses without regard to whether the response came from a query (the first request) or a retry. PctGoodResponses = 100 * (GoodResponses / Queries)
<Timespan>PctGoodTriesR4The percentage of good responses
over
calculated from all tries (queries and retries).
 PctGoodResponses
PctGoodTries = 100 * (GoodResponses / (Queries + Retries))
<Timespan>PollAttemptsI4The number of polls that were initiated.
<Timespan>Poll ResetI4(Only available for: “This Hour” and “Today” Timespans)
<Timespan>PollSuccessesI4The number of polls that completed with good responses to all data requests.
<Timespan>QueriesI4The total number of poll messages sent, not including retries, on the primary and secondary connections. Only the first transmission of the message is a “Query”. If no response comes from the device within the allotted time, the message is sent again (up to a configured maximum number of times) – this re-send is a “Retry”.
<Timespan>RetriesI4The total number of times poll messages were re-sent (due to a reply time-out or other error) on the primary and secondary connections.
<Timespan>TimeoutsI4The total number of reply time-outs to poll messages on the primary and secondary connections.
<Timespan>TransmitsI4The number of messages sent through the port.
<Timespan>UnsolicitedsI4The number of times a device called in or initiated a poll request.