Versions Compared

Key

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

...

Expand
titleTable Of Contents

Table of Contents
printablefalse

Overview

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

Common Object 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. Each poll message that is sent that does not receive a response causes the barometer to increase by two (2), with a maximum value of 100. Each poll message that is sent that does receive a valid response causes the barometer to decrease 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) of the last poll.
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.
StatusI2

An integer value indicating the result of the last poll.
1 = Complete
2 = Incomplete
3 = Interrupted
4 = Communication error
5 = Failed

6 = Poll was not initiated
7 = Port is Closed or Disabled

StatusDescStringDescriptive result of the last poll.
"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:

...