In addition to the usual data fields that you would expect to find on a Geo SCADA Expert Scanner, a FloBoss Scanner object also has the following data fields, which are listed in the Geo SCADA Expert Database Schema (see Schema View). The name in bold at the start of each entry is also the OPC tag name.
- AlarmLogPointer. This is the index of the newest alarm in the FloBoss’s alarm log. On creation of a new FloBoss Scanner object, this is set to 0. The driver uses this pointer to determine if any new alarms have occurred since the last scan. You should not need to manipulate this value directly.
- AlarmScanComplete. When a new FloBoss Scanner object is created, the index of the newest alarm in the FloBoss’s alarm log, which is normally stored in AlarmLogPointer, is unknown. To indicate that the value in AlarmLogPointer is invalid, the FloBoss Scanner object is created with AlarmScanComplete set to FALSE. After the first scan of the alarm log, in which the driver retrieves the entire alarm log, the value in AlarmLogPointer is valid and AlarmScanComplete is set to TRUE.
To repopulate an alarm data table, set the value of AlarmScanComplete to FALSE and call the GetAlarms method on the FloBoss Scanner, or wait for the next scan.
This might result in duplicate entries if you don’t delete the existing entries in the alarm data table.
- ClockOffsetToHostSecs. This field indicates the difference between the Geo SCADA Expert clock and the clock in the FloBoss in seconds. The difference is determined by taking the time from the FloBoss, applying the offset in the FloBoss Time Zone field, if any, and then comparing that value to the Geo SCADA Expert clock plus any offset for daylight savings time. The daylight savings time offset is required because the driver will not adjust the clock in the FloBoss for daylight savings time.
- CommBadRequests. This field contains the number of requests from the driver that were rejected by the FloBoss. This counter is only incremented if the FloBoss actively rejects the request. This typically happens because the request from the driver to the FloBoss is for an invalid TLP or history point. This value is reset when the ResetCommCounters method is called on the FloBoss Scanner object.
- CommCountersTime. This is the time that the ResetCommCounters method was called and the counters were reset.
- CommErrors. This field contains the total number of communications errors. The value is typically incremented when a timeout occurs, but can also be incremented on a bad CRC or other communications failure. This value is reset when the ResetCommCounters method is called on the FloBoss Scanner object.
- CommTotalRequests. This field contains the total number of requests sent from the driver to the FloBoss. This value is reset when the ResetCommCounters method is called on the FloBoss Scanner object.
- EventLogPointer. This is the index of the newest event in the FloBoss’s event log. On creation of a new FloBoss Scanner object, this is set to 0. The driver uses this pointer to determine if any new events have occurred since the last scan. You should not need to manipulate this value directly.
- EventScanComplete. When a new FloBoss Scanner object is created, the index of the newest event in the FloBoss’s event log, which is normally stored in EventLogPointer, is unknown. To indicate that the value in EventLogPointer is invalid, the FloBoss Scanner object is created with EventScanComplete set to FALSE. After the first scan of the event log, in which the driver retrieves the entire event log, the value in EventLogPointer is valid and EventScanComplete is set to TRUE.
To repopulate an event data table, set the value to EventScanComplete to FALSE and call the GetEvents method on the FloBoss Scanner, or wait for the next scan.
This might result in duplicate entries if you don’t delete the existing entries in the event data table.
- PromotedScanningEnabled. This is true when promoted scanning is enabled and false when scanning at the normally configured scan rate. To enable promoted scanning, call the Enable Promoted Scanning method on the Scanner object.
- TimeLocal. This is the time that was read from the FloBoss. The ‘Local’ part comes from the fact that this value is not UTC, but is the value of the clock in the FloBoss with the offset in the FloBoss Time Zone field applied.
- TimeZoneString. This is the value of the FloBoss Time Zone field decoded as a string. This is done as a convenience.