Versions Compared

Old Version 1

changes.mady.by.user Michael Standal

Saved on

compared with

New Version 2

changes.mady.by.user Michael Standal

Saved on

Key

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

...

The FBNET protocol implementation supports the item names listed below for use by client applications.

APC Control

ItemData TypeFBNet VersionDescription
CASINGOPMODEUI1V1, V2Current casing valve operating mode. Valid values are:
• 0 = CASING_OFF_MODE
• 1 = CASING_DELAY_MODE
• 2 = CASING_ON_MODE
CASINGOPMODETIMEUI4V1, V2Casing valve time in seconds.
CONTROLLERMODEUI2V1, V2Contains controller mode for well
Valid values are:
• 2 = CTRL_AC_PLUNGER
• 3 = CTRL_AC_TANK
• 4 = CTRL_AC_INJECTION
• 7 = CTRL_AC_ECL
CURRENTHGHLINEDELAYTIMEUI4V1, V2High line delay time in seconds.
ERRORTIMEUI4V1, V2Error time in seconds - active when AC Err Status contains other than AC NO ERROR.
EXTCONTACT/1UI1V1, V2
FASTRETURNUI2V1, V2History of fast plunger arrival counts.
GOODRETURNUI2V1, V2History of good plunger arrival counts.
HIGHLINECLEARMODEUI1V1, V2
NORETURNUI2V1, V2History of no plunger arrival count.
NUMCYCLESUI2V1, V2Number of off cycle starts since last clear totals.
OPMODEUI1V1, 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

OPMODETIMEUI4V1, V2Auxiliary valve time in seconds.
PLUNGERCOUNTUI2V1, V2Number of plunger arrivals logged since last clear Totals.
PLUNGERRUN/0UI4V1, V2Most recent 9 plunger run times in second. Index 0 is the most recent plunger run. This array is not updated on a no arrival.
SALESMODEUI1V1, 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

SLOWRETURNUI2V1, V2History of slow plunger arrival counts.
SMODETIMEUI4V1, V2Sales valve time in seconds.
TANKCYCLESUI2V1, V2Number of tanks valve open cycles since last clear totals.
TTLINJTIMEI4V1, V2Contains total injection valve open time in seconds since RTU was reset or the value rolled over.
TTLOFFTIMEUI4V1, V2Contains total sales valve close time in seconds since RTU was reset or the value rolled over.
TTLONTIMEUI4V1, V2Contains total sales valve open time in seconds since RTU was reset or the value rolled over.
TTLTANKTIMEI4V1, V2Contains total tank valve open time in seconds since RTU was reset or the value rolled over.
TANKCYCLESUI2V1, V2Number of tanks valve open cycles since last clear totals.
TTLINJTIMEI4V1, V2Contains total injection valve open time in seconds since RTU was reset or the value rolled over.
TTLOFFTIMEUI4V1, V2Contains total sales valve close time in seconds since RTU was reset or the value rolled over.
TTLONTIMEUI4V1, V2Contains total sales valve open time in seconds since RTU was reset or the value rolled over.
TTLTANKTIMEI4V1, V2Contains total tank valve open time in seconds since RTU was reset or the value rolled over.
TANKCYCLESUI2V1, V2Number of tanks valve open cycles since last clear totals.
VENTOPMODEUI1V1, V2

Current vent valve operating mode.

Valid values are:
• 0 = TANK_OFF_MODE
• 1 = TANK_ON_MODE
• 2 = TANK_DELAY_MODE

VENTOPMODETIMEUI4V1, V2Vent valve time in seconds.
WELLSTATUSUI1V1, V2Contains 2 if in automatic control mode, 4 if in manual control mode.

APC Control Parameters

ItemData TypeFBNet VersionDescription
AFTERFLOWUI4V1, V2Current afterflow time in seconds. Maximum value is 99:59:59.
AFTERFLOWADDUI4V1, V2Adjustment added to afterflow time on fast arrival in seconds. Maximum value is 99:59:59.
AFTERFLOWENABLEUI1V1, V2Writing 1 to coil enables afterflow on a slow arrival during the on cycle. Writing 0 to the coil disables this feature.
AFTERFLOWSLOWUI4V1, V2Adjustment subtracted from afterflow time on slow arrival in seconds. Maximum value is 99:59:59.
AUTOPERMITSALESVALVEENABLEUI1V1, V2Writing 1 to coil directs RTU to automatically "permit" the well after a safety valve close. This value remains until the host turns it off.
AUTORESTARTUI1V1, V2Writing 1 to coil directs RTU to restart the control module in the last set mode - manual or automatic - on power-fail or hardware reset
CATCHMODEUI1V1, V2Writing 1 to coil directs RTU to enter the plunger catch mode at next plunger arrival.
CLICKTIME/1UI1V1, V2
CONTROLOPMODEUI1V1, 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

CURREARLYCOUNTERUI2V1, V2Clears the early arrival counter.
CURRFASTUI2V1, V2Current fast plunger arrival count.
CURRGOODUI2V1, V2Current good plunger arrival count.
CURRNONEUI2V1, V2Current no plunger arrival count.
CURRRECOVERYARRIVALUI2V1, V2Current recovery counter. When 0, the RTU will use the Recovery off time value if enabled. Ignored in shared flow controller.
CURRSLOWUI2V1, V2Current slow plunger arrival count.
ENABLEEARLYARRIVALTIMEUI4V1, V2Enable or disable early plunger arrival.
FLOWTIMEUI4V1, V2Sync mode flow time in seconds. Maximum value is 99:59:59. Ignored in shared flow controller.
HIGHTIMEUI4V1, V2Time 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.
INITFASTUI2V1, V2Initial fast plunger arrival count.
INITGOODUI2V1, V2Initial good plunger arrival count.
INITNONEUI2V1, V2Initial no plunger arrival count.
ININRECOVERYARRIVALUI2V1, V2Indicates if the mode is in plunger recovery.
INITSLOWUI2V1, V2Initial slow plunger arrival count.
LLTANKMODEUI1V1, V2Set by the host to enable (TRUE) or disable (FALSE) the liquid-lift tank mode of operation.
LOWTIMEUI4V1, V2Time 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.
MANUALPERMITSALESVALVEENABLEUI1V1, V2This Boolean field manually permits sales valve open when off inputs are gone.
MAXAFTERFLOWUI4V1, V2Maximum afterflow time in seconds. Maximum value is 99:59:59.
MAXOFFTIMEUI4V1, V2Maximum time to allow off-time to be adjusted to.
MINAFTERFLOWUI4V1, V2Minimum time to allow afterflow to be adjusted to 
MINOFFTIMEUI4V1, V2The minimum time the RTU will adjust the off time to.
OFFDURINGAFTERFLOW/1UI2V1, 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

OFFTIMEUI4V1, V2Current off time in seconds. Maximum value is 999:59:59.
OFFTIMENONEUI4V1, V2Off time to use in the case of a non-plunger arrival.
OFFTIMESLOWUI4V1, V2Off time to use in the case of a slow arrival.
ONTIMEUI4V1, V2Time where RTU determines difference between good and slow arrival time. Anything less than or equal this value is considered a slow arrival.
PLGERARRIVALADNDISABLEUI1V1, V2Writing 1 to coil disables plunger arrival adjustments. Writing 0 to the coil enabled this feature.
PROPORTIONALADJENABLEUI1V1, V2Writing 1 to coil enables proportional adjustments. Writing 0 to the coil disables this feature.
RESETAFTERFLOWTOMINUI1V1, V2Resets afterflow time back to minimum.
SHAREDFLOWMODEUI1V1, V2Writing 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.
SHUTINDEDUCTUI4V1, V2
STATEUI1V1, V2
SYNCMODEENABLEUI1V1, V2
USETRENDEDANALOGS/1UI2V1, 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

ItemData TypeFBNet VersionDescription
CLEARTOTALSFLAGUI1V1, V2Writing 1 to coil directs RTU clear totals.
DOTRIGGER/1UI1V1, V2
OFFBUTTONUI1V1, V2Writing 1 to coil directs RTU to start an AutoCycle Plus "Off" cycle.
ONBUTTONUI1V1, V2Writing 1 to coil directs RTU to start an AutoCycle Plus "On" cycle.
TUBINGCLOSEBUTTONUI1V1, V2Writing 1 to coil directs RTU to close sales valve.
TUBINGOPENBUTTONUI1V1, V2Writing 1 to coil directs RTU to open sales valve.

Alarm

ItemData TypeFBNet VersionDescription
ANALOGALARMACTIVE/1UI1V1, V2Enables alarm.
ANALOGALARMLEVEL/1R4V1, V2Enables alarm.
BATTERYAALARMACTIVEUI1V1, V2Enables alarm.
BATTERYALARMLEVELR4V1, V2Enables alarm.
BOARDTEMPAACTIVEUI1V1, V2Enables alarm.
BOARDTEMPALARMLEVELR4V1, V2Enables alarm.
DIGITALALARMACTIVE/1UI2V1, V2Enables alarm.
DIGITALALARMLEVEL/1UI2V1, V2Enables alarm.
SOFTALARMACTIVE/1UI2V1, V2Enables alarm.

Alarm Notify

ItemData TypeFBNet VersionDescription
ANALOGALARMACTIVE
AANOTIFY/1UI2V1, V2Enable auto notify.
DINOTIFY/1UI2V1, V2Enable DI notify.
FCUAANOTIFY/1UI2V1, V2Enable Flow Computer notify.
SOFTNOTIFY/1
UI1
UI2V1, V2
Enables alarm
Enable Soft Point notify.

Alarm Parameters

ItemData TypeFBNet VersionDescription


V1, V2

FCU

ItemData TypeFBNet VersionDescription
V1, V2

...

CURVOLR4V1, V2Current volume from FCU if last read succeeded, -10,000.0 otherwise.
DPR4V1, V2DP from FCU if last read succeeded, -10,000.0 otherwise.
LPR4V1, V2LP from FCU if last read succeeded, -10,000.0 otherwise.
LTR4V1, V2LT from FCU if last read succeeded, -10,000.0 otherwise.
MBSTATUSI4V1, V2
PREVVOLR4V1, V2Previous volume from FCUif last read succeeded, -10,000.0 otherwise.
RATER4V1, V2Instantaneous rate from FCU if last read succeeded, -10,000.0 otherwise.

FCU Alarm

ItemData TypeFBNet VersionDescription
ALARMACTIVE/1BOOLV1, V2
ALARMLEVEL/1R4V1, V2

FCU Alarm Parameters

ItemData TypeFBNet VersionDescription


V1, V2

FCU Parameters

ItemData TypeFBNet VersionDescription


V1, V2

FCU Previous Volume

ItemData TypeFBNet VersionDescription


V1, V2

Find Address

ItemData TypeFBNet VersionDescription
ADDRESSUI2V1, V2RTU Address

Firmware

ItemData TypeFBNet VersionDescription
VERSIONI2V1, V2Contains the RTU code revision number
FEATURESUI2V1, V2Contains a bit map of RTU capabilities

Gas Parameters

ItemData TypeFBNet VersionDescription
ItemData TypeFBNet VersionDescription
CPRIMER4V1, V2

FCU Alarm Parameters

C Prime set point.
CURPRODVOLR4V1, V2Current production Volume
DPCUTOFFR4V1, V2

FCU Parameters

ItemData TypeFBNet VersionDescription
Differential Pressure cut off set point.
INJGASMETERFLAGI1V1, V2Injection gas meter flag.
INTERNATIONALI1V1, V2

...


LOCATMPRES
ItemData TypeFBNet VersionDescription
R4V1, V2
PREVPRODVOLR4V1, V2

...

Previous production Volume

Meter Parameter Calibration

ItemData TypeFBNet VersionDescription


V1, V2

...


Pressure Overrides

ItemData TypeFBNet VersionDescription


V1, V2

...


Remote Shutin

ItemData TypeFBNet VersionDescription
ItemData TypeFBNet VersionDescription
PERMITTEDUI2V1, V2

Meter Parameter Calibration

ItemData TypeFBNet VersionDescription
Enable remote shut in
REVISIONUI2V1, V2
STATUS

Pressure Overrides

UI2V1, V2Status
STRUCTSIZEUI2V1, V2

...


RTU

ItemData TypeFBNet VersionDescription


V1, V2

RTU Meter Parameters

ItemData TypeFBNet VersionDescription


V1, V2

RTU

...

Parameters

ItemData TypeFBNet VersionDescription


V1, V2

RTU

...

Reset

ItemData TypeFBNet VersionDescription
RTUANDBUFFERSBOOLV1, V2Reset RTU

...

and buffers.
ItemData TypeFBNet VersionDescription
RTUONLYBOOLV1, V2Reset RTU only.

Time

ItemData TypeFBNet VersionDescription
TIMESTAMPUI4V1, V2Time Stamp

Timer

ItemData TypeFBNet VersionDescription


V1, V2

Well Comm

ItemData TypeFBNet VersionDescription


V1, V2

Extended Items

ItemData TypeDescription
GCWrite/TxnVariant ArrayUsed for automated gas quality download.
LastAlarmRecord/1DateTimestamp of the last alarm record retrieved from meter number 1.
LastDailyRecord/1DateTimestamp of the last daily record retrieved from meter number 1.
LastEventRecord/1DateTimestamp of the last event record retrieved from meter number 1.
LastHourlyRecord/1DateTimestamp of the last hourly record retrieved from meter number 1.
LastTimeSyncDateTimestamp of the last time synchronization attempt.
LastTimeSyncResultI4Result of the last time synchronization attempt.
LastTrendRecord/1DateTimestamp of the last trend record retrieved from meter number 1.
MoveDaily/1I2Move 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/1I2Move 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/1BOOLErase the daily history retrieval pointer for meter 1 (and re-collect all daily history during the next retrieval).
ResetEvent/1BOOLErase the event history retrieval pointer for meter 1 (and re-collect all event history during the next retrieval).
ResetLogPeriod/1BOOLErase the log period history retrieval pointer for meter 1 (and re-collect all log period history during the next retrieval).
ResetTrend/1BOOLErase the trend retrieval pointer for meter 1 (and re-collect all trends during the next retrieval).
RetrieveHistoryI2Retrieve enabled history.
RetrieveTrendI2Retrieve enabled trends.
TimeSyncI2Perform time synchronization.