Skip to end of metadata
Go to start of metadata
You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 2
Next »
Standard Items
See Device Standard Items.
Protocol Items
The FBNET protocol implementation supports the item names listed below for use by client applications.
APC Control
| Item | Data Type | FBNet Version | Description |
|---|
| CASINGOPMODE | UI1 | V1, V2 | Current casing valve operating mode. Valid values are:
• 0 = CASING_OFF_MODE
• 1 = CASING_DELAY_MODE
• 2 = CASING_ON_MODE |
| CASINGOPMODETIME | UI4 | V1, V2 | Casing valve time in seconds. |
| CONTROLLERMODE | UI2 | V1, V2 | Contains controller mode for well
Valid values are:
• 2 = CTRL_AC_PLUNGER
• 3 = CTRL_AC_TANK
• 4 = CTRL_AC_INJECTION
• 7 = CTRL_AC_ECL |
| CURRENTHGHLINEDELAYTIME | UI4 | V1, V2 | High line delay time in seconds. |
| ERRORTIME | UI4 | V1, V2 | Error time in seconds - active when AC Err Status contains other than AC NO ERROR. |
| EXTCONTACT/1 | UI1 | V1, V2 |
|
| FASTRETURN | UI2 | V1, V2 | History of fast plunger arrival counts. |
| GOODRETURN | UI2 | V1, V2 | History of good plunger arrival counts. |
| HIGHLINECLEARMODE | UI1 | V1, V2 |
|
| NORETURN | UI2 | V1, V2 | History of no plunger arrival count. |
| NUMCYCLES | UI2 | V1, V2 | Number of off cycle starts since last clear totals. |
| OPMODE | UI1 | V1, V2 | Current PECL and Injection operating mode. Valid values are:
• 0 = INJECT_OFF
• 1 = INJECT_PRECHARGE
• 2 = INJECT_BOOST
• 3 = INJECT_BOOST_DELAY Current tank valve operating mode. Valid values are:
• 0 = TANK_OFF_MODE
• 1 = TANK_ON_MODE
• 2 = TANK_DELAY_MODE |
| OPMODETIME | UI4 | V1, V2 | Auxiliary valve time in seconds. |
| PLUNGERCOUNT | UI2 | V1, V2 | Number of plunger arrivals logged since last clear Totals. |
| PLUNGERRUN/0 | UI4 | V1, V2 | Most recent 9 plunger run times in second. Index 0 is the most recent plunger run. This array is not updated on a no arrival. |
| SALESMODE | UI1 | V1, V2 | Contains current operating mode. This pertains mainly to sales valve. Undefined if the well is in Manual Mode. Valid values are:
• 0 = SALES_OFF_MODE
• 1 = SALES_ON_MODE
• 2 = AFTERFLOW_MODE
• 3 = SYNC_MODE
• 4 = TPURGE_ON_MODE
• 5 = TPURGE_OFF_MODE
• 6 = ON_DP_WAIT_MODE |
| SLOWRETURN | UI2 | V1, V2 | History of slow plunger arrival counts. |
| SMODETIME | UI4 | V1, V2 | Sales valve time in seconds. |
| TANKCYCLES | UI2 | V1, V2 | Number of tanks valve open cycles since last clear totals. |
| TTLINJTIME | I4 | V1, V2 | Contains total injection valve open time in seconds since RTU was reset or the value rolled over. |
| TTLOFFTIME | UI4 | V1, V2 | Contains total sales valve close time in seconds since RTU was reset or the value rolled over. |
| TTLONTIME | UI4 | V1, V2 | Contains total sales valve open time in seconds since RTU was reset or the value rolled over. |
| TTLTANKTIME | I4 | V1, V2 | Contains total tank valve open time in seconds since RTU was reset or the value rolled over. |
| TANKCYCLES | UI2 | V1, V2 | Number of tanks valve open cycles since last clear totals. |
| TTLINJTIME | I4 | V1, V2 | Contains total injection valve open time in seconds since RTU was reset or the value rolled over. |
| TTLOFFTIME | UI4 | V1, V2 | Contains total sales valve close time in seconds since RTU was reset or the value rolled over. |
| TTLONTIME | UI4 | V1, V2 | Contains total sales valve open time in seconds since RTU was reset or the value rolled over. |
| TTLTANKTIME | I4 | V1, V2 | Contains total tank valve open time in seconds since RTU was reset or the value rolled over. |
| TANKCYCLES | UI2 | V1, V2 | Number of tanks valve open cycles since last clear totals. |
| VENTOPMODE | UI1 | V1, V2 | Current vent valve operating mode. Valid values are:
• 0 = TANK_OFF_MODE
• 1 = TANK_ON_MODE
• 2 = TANK_DELAY_MODE |
| VENTOPMODETIME | UI4 | V1, V2 | Vent valve time in seconds. |
| WELLSTATUS | UI1 | V1, V2 | Contains 2 if in automatic control mode, 4 if in manual control mode. |
APC Control Parameters
| Item | Data Type | FBNet Version | Description |
|---|
| AFTERFLOW | UI4 | V1, V2 | Current afterflow time in seconds. Maximum value is 99:59:59. |
| AFTERFLOWADD | UI4 | V1, V2 | Adjustment added to afterflow time on fast arrival in seconds. Maximum value is 99:59:59. |
| AFTERFLOWENABLE | UI1 | V1, V2 | Writing 1 to coil enables afterflow on a slow arrival during the on cycle. Writing 0 to the coil disables this feature. |
| AFTERFLOWSLOW | UI4 | V1, V2 | Adjustment subtracted from afterflow time on slow arrival in seconds. Maximum value is 99:59:59. |
| AUTOPERMITSALESVALVEENABLE | UI1 | V1, V2 | Writing 1 to coil directs RTU to automatically "permit" the well after a safety valve close. This value remains until the host turns it off. |
| AUTORESTART | UI1 | V1, V2 | Writing 1 to coil directs RTU to restart the control module in the last set mode - manual or automatic - on power-fail or hardware reset |
| CATCHMODE | UI1 | V1, V2 | Writing 1 to coil directs RTU to enter the plunger catch mode at next plunger arrival. |
| CLICKTIME/1 | UI1 | V1, V2 |
|
| CONTROLOPMODE | UI1 | V1, V2 | Contains control operating mode directing RTU to perform the requested control algorithm. Valid values are:
• 0 = PLG_ECL
• 0 = PLG_INJECT
• 0 = TANK
• 1 = PLG_ONLY
• 2 = TIMER_ONLY
• 3 = PLG_GAS_LIFT
• 4 = INTR_GAS
• 6 = PLG_3VLV |
| CURREARLYCOUNTER | UI2 | V1, V2 | Clears the early arrival counter. |
| CURRFAST | UI2 | V1, V2 | Current fast plunger arrival count. |
| CURRGOOD | UI2 | V1, V2 | Current good plunger arrival count. |
| CURRNONE | UI2 | V1, V2 | Current no plunger arrival count. |
| CURRRECOVERYARRIVAL | UI2 | V1, V2 | Current recovery counter. When 0, the RTU will use the Recovery off time value if enabled. Ignored in shared flow controller. |
| CURRSLOW | UI2 | V1, V2 | Current slow plunger arrival count. |
| ENABLEEARLYARRIVALTIME | UI4 | V1, V2 | Enable or disable early plunger arrival. |
| FLOWTIME | UI4 | V1, V2 | Sync mode flow time in seconds. Maximum value is 99:59:59. Ignored in shared flow controller. |
| HIGHTIME | UI4 | V1, V2 | Time in when the RTU determines the difference between a good and slow arrival time. Anything less than or equal this value is considered a good arrival. |
| INITFAST | UI2 | V1, V2 | Initial fast plunger arrival count. |
| INITGOOD | UI2 | V1, V2 | Initial good plunger arrival count. |
| INITNONE | UI2 | V1, V2 | Initial no plunger arrival count. |
| ININRECOVERYARRIVAL | UI2 | V1, V2 | Indicates if the mode is in plunger recovery. |
| INITSLOW | UI2 | V1, V2 | Initial slow plunger arrival count. |
| LLTANKMODE | UI1 | V1, V2 | Set by the host to enable (TRUE) or disable (FALSE) the liquid-lift tank mode of operation. |
| LOWTIME | UI4 | V1, V2 | Time in when the RTU determines the difference between a fast and good arrival time. Anything less than or equal this value is considered a fast or early arrival. |
| MANUALPERMITSALESVALVEENABLE | UI1 | V1, V2 | This Boolean field manually permits sales valve open when off inputs are gone. |
| MAXAFTERFLOW | UI4 | V1, V2 | Maximum afterflow time in seconds. Maximum value is 99:59:59. |
| MAXOFFTIME | UI4 | V1, V2 | Maximum time to allow off-time to be adjusted to. |
| MINAFTERFLOW | UI4 | V1, V2 | Minimum time to allow afterflow to be adjusted to |
| MINOFFTIME | UI4 | V1, V2 | The minimum time the RTU will adjust the off time to. |
| OFFDURINGAFTERFLOW/1 | UI2 | V1, V2 | Off Input Only During Afterflow selection bit map. If the bit is 1, the equivalent "Of" input is only honored during afterflow. Valid values are:
• LOW_CP_OFF_MASK 0x0001
• LOW_TP_OFF_MASK 0x0002
• LOW_DP_OFF_MASK 0x0004
• HIGH_LINE_OFF_MASK 0x0008 |
| OFFTIME | UI4 | V1, V2 | Current off time in seconds. Maximum value is 999:59:59. |
| OFFTIMENONE | UI4 | V1, V2 | Off time to use in the case of a non-plunger arrival. |
| OFFTIMESLOW | UI4 | V1, V2 | Off time to use in the case of a slow arrival. |
| ONTIME | UI4 | V1, V2 | Time where RTU determines difference between good and slow arrival time. Anything less than or equal this value is considered a slow arrival. |
| PLGERARRIVALADNDISABLE | UI1 | V1, V2 | Writing 1 to coil disables plunger arrival adjustments. Writing 0 to the coil enabled this feature. |
| PROPORTIONALADJENABLE | UI1 | V1, V2 | Writing 1 to coil enables proportional adjustments. Writing 0 to the coil disables this feature. |
| RESETAFTERFLOWTOMIN | UI1 | V1, V2 | Resets afterflow time back to minimum. |
| SHAREDFLOWMODE | UI1 | V1, V2 | Writing 1 to coil directs RTU to enter the shared flow mode. This mode is mutually exclusive with Sync mode. Ignored in the shared flow controller. |
| SHUTINDEDUCT | UI4 | V1, V2 |
|
| STATE | UI1 | V1, V2 |
|
| SYNCMODEENABLE | UI1 | V1, V2 |
|
| USETRENDEDANALOGS/1 | UI2 | V1, V2 | Bit map to indicate to the control code to use trended analogs for control decisions. Values are:
• 0x01 - casing pressure
• 0x02 - tubing pressure
• 0x04 - not used
• 0x08 - differential pressure
• 0x10 - line pressure
• 0x20 - line temperature
• 0x40 - unit temperature or alternate line pressure |
|
|
|
|
|
|
|
|
ACP Demand
| Item | Data Type | FBNet Version | Description |
|---|
| CLEARTOTALSFLAG | UI1 | V1, V2 | Writing 1 to coil directs RTU clear totals. |
| DOTRIGGER/1 | UI1 | V1, V2 |
|
| OFFBUTTON | UI1 | V1, V2 | Writing 1 to coil directs RTU to start an AutoCycle Plus "Off" cycle. |
| ONBUTTON | UI1 | V1, V2 | Writing 1 to coil directs RTU to start an AutoCycle Plus "On" cycle. |
| TUBINGCLOSEBUTTON | UI1 | V1, V2 | Writing 1 to coil directs RTU to close sales valve. |
| TUBINGOPENBUTTON | UI1 | V1, V2 | Writing 1 to coil directs RTU to open sales valve. |
Alarm
| Item | Data Type | FBNet Version | Description |
|---|
| ANALOGALARMACTIVE/1 | UI1 | V1, V2 | Enables alarm. |
| ANALOGALARMLEVEL/1 | R4 | V1, V2 | Enables alarm. |
| BATTERYAALARMACTIVE | UI1 | V1, V2 | Enables alarm. |
| BATTERYALARMLEVEL | R4 | V1, V2 | Enables alarm. |
| BOARDTEMPAACTIVE | UI1 | V1, V2 | Enables alarm. |
| BOARDTEMPALARMLEVEL | R4 | V1, V2 | Enables alarm. |
| DIGITALALARMACTIVE/1 | UI2 | V1, V2 | Enables alarm. |
| DIGITALALARMLEVEL/1 | UI2 | V1, V2 | Enables alarm. |
| SOFTALARMACTIVE/1 | UI2 | V1, V2 | Enables alarm. |
Alarm Notify
| Item | Data Type | FBNet Version | Description |
|---|
| AANOTIFY/1 | UI2 | V1, V2 | Enable auto notify. |
| DINOTIFY/1 | UI2 | V1, V2 | Enable DI notify. |
| FCUAANOTIFY/1 | UI2 | V1, V2 | Enable Flow Computer notify. |
| SOFTNOTIFY/1 | UI2 | V1, V2 | Enable Soft Point notify. |
Alarm Parameters
| Item | Data Type | FBNet Version | Description |
|---|
|
| V1, V2 |
|
FCU
| Item | Data Type | FBNet Version | Description |
|---|
| CURVOL | R4 | V1, V2 | Current volume from FCU if last read succeeded, -10,000.0 otherwise. |
| DP | R4 | V1, V2 | DP from FCU if last read succeeded, -10,000.0 otherwise. |
| LP | R4 | V1, V2 | LP from FCU if last read succeeded, -10,000.0 otherwise. |
| LT | R4 | V1, V2 | LT from FCU if last read succeeded, -10,000.0 otherwise. |
| MBSTATUS | I4 | V1, V2 |
|
| PREVVOL | R4 | V1, V2 | Previous volume from FCUif last read succeeded, -10,000.0 otherwise. |
| RATE | R4 | V1, V2 | Instantaneous rate from FCU if last read succeeded, -10,000.0 otherwise. |
FCU Alarm
| Item | Data Type | FBNet Version | Description |
|---|
| ALARMACTIVE/1 | BOOL | V1, V2 |
|
| ALARMLEVEL/1 | R4 | V1, V2 |
|
FCU Alarm Parameters
| Item | Data Type | FBNet Version | Description |
|---|
|
| V1, V2 |
|
FCU Parameters
| Item | Data Type | FBNet Version | Description |
|---|
|
| V1, V2 |
|
FCU Previous Volume
| Item | Data Type | FBNet Version | Description |
|---|
|
| V1, V2 |
|
Find Address
| Item | Data Type | FBNet Version | Description |
|---|
| ADDRESS | UI2 | V1, V2 | RTU Address |
Firmware
| Item | Data Type | FBNet Version | Description |
|---|
| VERSION | I2 | V1, V2 | Contains the RTU code revision number |
| FEATURES | UI2 | V1, V2 | Contains a bit map of RTU capabilities |
Gas Parameters
| Item | Data Type | FBNet Version | Description |
|---|
| CPRIME | R4 | V1, V2 | C Prime set point. |
| CURPRODVOL | R4 | V1, V2 | Current production Volume |
| DPCUTOFF | R4 | V1, V2 | Differential Pressure cut off set point. |
| INJGASMETERFLAG | I1 | V1, V2 | Injection gas meter flag. |
| INTERNATIONAL | I1 | V1, V2 |
|
| LOCATMPRES | R4 | V1, V2 |
|
| PREVPRODVOL | R4 | V1, V2 | Previous production Volume |
Meter Parameter Calibration
| Item | Data Type | FBNet Version | Description |
|---|
|
| V1, V2 |
|
Pressure Overrides
| Item | Data Type | FBNet Version | Description |
|---|
|
| V1, V2 |
|
Remote Shutin
| Item | Data Type | FBNet Version | Description |
|---|
| PERMITTED | UI2 | V1, V2 | Enable remote shut in |
| REVISION | UI2 | V1, V2 |
|
| STATUS | UI2 | V1, V2 | Status |
| STRUCTSIZE | UI2 | V1, V2 |
|
RTU
| Item | Data Type | FBNet Version | Description |
|---|
|
| V1, V2 |
|
RTU Meter Parameters
| Item | Data Type | FBNet Version | Description |
|---|
|
| V1, V2 |
|
RTU Parameters
| Item | Data Type | FBNet Version | Description |
|---|
|
| V1, V2 |
|
RTU Reset
| Item | Data Type | FBNet Version | Description |
|---|
| RTUANDBUFFERS | BOOL | V1, V2 | Reset RTU and buffers. |
| RTUONLY | BOOL | V1, V2 | Reset RTU only. |
Time
| Item | Data Type | FBNet Version | Description |
|---|
| TIMESTAMP | UI4 | V1, V2 | Time Stamp |
Timer
| Item | Data Type | FBNet Version | Description |
|---|
|
| V1, V2 |
|
Well Comm
| Item | Data Type | FBNet Version | Description |
|---|
|
| V1, V2 |
|
Extended Items
| Item | Data Type | Description |
|---|
| GCWrite/Txn | Variant Array | Used for automated gas quality download. |
| LastAlarmRecord/1 | Date | Timestamp of the last alarm record retrieved from meter number 1. |
| LastDailyRecord/1 | Date | Timestamp of the last daily record retrieved from meter number 1. |
| LastEventRecord/1 | Date | Timestamp of the last event record retrieved from meter number 1. |
| LastHourlyRecord/1 | Date | Timestamp of the last hourly record retrieved from meter number 1. |
| LastTimeSync | Date | Timestamp of the last time synchronization attempt. |
| LastTimeSyncResult | I4 | Result of the last time synchronization attempt. |
| LastTrendRecord/1 | Date | Timestamp of the last trend record retrieved from meter number 1. |
| MoveDaily/1 | I2 | Move the daily history retrieval pointer for meter run 1. Write a positive number to move the pointer back in time, a negative number to move the pointer forward in time. The written value represents the number of days to move. |
| MoveLogPeriod/1 | I2 | Move the log period pointer for meter run 1. Write a positive number to move the pointer back in time, a negative number to move the pointer forward in time. The written value represents the number of periods to move. |
| ResetDaily/1 | BOOL | Erase the daily history retrieval pointer for meter 1 (and re-collect all daily history during the next retrieval). |
| ResetEvent/1 | BOOL | Erase the event history retrieval pointer for meter 1 (and re-collect all event history during the next retrieval). |
| ResetLogPeriod/1 | BOOL | Erase the log period history retrieval pointer for meter 1 (and re-collect all log period history during the next retrieval). |
| ResetTrend/1 | BOOL | Erase the trend retrieval pointer for meter 1 (and re-collect all trends during the next retrieval). |
| RetrieveHistory | I2 | Retrieve enabled history. |
| RetrieveTrend | I2 | Retrieve enabled trends. |
| TimeSync | I2 | Perform time synchronization. |