Totalflow OPC Items

Standard Items

See Device Standard Items.

Protocol Items

OPCItem/x can be used to reference an OPC Item on specific meter runs. The "x" represents the zero-based meter run, so to access the CurrentDP on meter run 2, the item would be entered as CurrentDP/1.  The CurrentDP value for meter run 3 can be accessed by CurrentDP/2 and so on.

This only applies to items that are meter specific.  It does NOT apply to App:Array:Index tags.


ItemData TypeDescription
ACCUMMCFR4Accum. Volume (MCF)
APHIGHCALR4AP high cal
APHIGHLIMITR4AP hi limit
APLOWCALR4AP low calibration
APLOWLIMITR4AP lo limit
APMIDCALR4AP Mid High Calibration
APMIDHIGHCALR4AP mid high calibration
APMIDLOWCALR4AP mid low calibration
App:Array:Index:DataType/Bit

UI1, I1, UI2, I2, UI4, I4, R4, R8, String,

Time,

Timestamp,

TimestampUTC

App: Application number;

Array: Array number;

Index: Index number;

Data Type:

  • I1: 8-bit integer; (Ex: 2:7:0:I1)
  • I2: 16-bit integer; (Ex: 2:7:0:I2)
  • I4: 32-bit integer; (Ex: 2:7:0:I4)
  • UI1: 8-bit unsigned integer; (Ex: 2:7:0:UI1)
  • UI2: 16-bit unsigned integer; (Ex: 2:7:0:UI2)
  • UI4: 32-bit unsigned integer; (Ex: 2:7:0:UI4)
  • R4 (default): 32-bit single-precision floating point; (Ex: 2:7:0:R4)
  • R8: 64-bit double-precision floating point; (Ex: 2:7:0:R8)
  • String: String data type; (Ex: 2:7:0:String)
  • Time: DD/MM/YY HH:MM:SS string; (Ex: 2:7:0:Time)
  • Timestamp: Time value in 'variant' format (Ex: 2:7:0:Timestamp)
  • TimestampUTC: Time value in 'variant' format adjusted to UTC timezone (Ex: 2:7:0:TimestampUTC)
  • No presentation means float; (Ex: 2:7:0)
  • Adding "/bit" at the end of the item will allow the user to read an individual bit. The "bit" is a 0 based index and available for data type I1, UI1, I2, UI2, I4, and UI4.
BAROPRESSR4Barometric pressure
BATTVOLTSR4Current battery voltage
CALCMETHUI1FCU volume calc. method
CALCUNITSUI1FCU calculation units
CONTRACTHOURUI1Contract Hour
ControlValve.Alarm.1I2
ControlValve.Alarm.2I2
ControlValve.Alarm.3I2
ControlValve.Alarm.4I2
ControlValve.Alarm.5I2
ControlValve.Alarm.6I2
ControlValve.Alarm.7I2
ControlValve.Alarm.8I2
ControlValve.AnalogValveI2
ControlValve.Alarm.APBiasR4
ControlValve.Alarm.APOverrideI2
ControlValve.BatteryLowLimitR4
ControlValve.ClosePeriodUI2
ControlValve.CloseTimeUI2
ControlValve.CMD2UI2
ControlValve.CommandExtI2
ControlValve.CurrentAPR4
ControlValve.CurrentBVR4
ControlValve.CurrentCPR4
ControlValve.CurrentDPR4
ControlValve.CurrentExtR4
ControlValve.CurrentTFR4
ControlValve.CurrHour72FlagR4
ControlValve.CurrPercOnSchedR4
ControlValve.CurrSetupStartString
ControlValve.CurrSetupStopString
ControlValve.CurrStatusActualVolR4
ControlValve.CurSetupTargetVolumeR4
ControlValve.CurSetupTermModeUI1
ControlValve.DPDeadbandR4DP Deadband
ControlValve.DPGainI2DP Gain
ControlValve.DPHighLimitR4DP High Limit
ControlValve.DPLowLimitR4DP Low Limit
ControlValve.DPLowTimeI2
ControlValve.DPSetpointR4DP Setpoint
ControlValve.DPShutinModeI2
ControlValve.ExtendedModeI2
ControlValve.ExtEventModeI2
ControlValve.ExtFeatureFlagsI2Feature Flags 2
0x0001: On/Off timer
0x0002: External flow rate process variable
ControlValve.FeatureFlagsI2Feature Flags
0x0001: Valve control
0x0002: Nominations mode
0x0004: SP override for valve control and nominations
0x0008: Radio key delay supported
0x0010: Don’t send step or ramp commands twice
0x0020: SP override type available
0x0040: Turbine Meter
0x0080: Additional VCI commands available
0x0100: Nominations mode available
0x0200: KDT active
0x0400: PBUT active
0x0800: More features in Feature Flags 2
0x1000: VCI
0x2000: EXIO
0x4000: EXIO2
ControlValve.FRDeadbandR4Flow Rate Deadband
ControlValve.FRGainI2Flow Rate Gain
ControlValve.FRHighLimitR4Flow Rate High Limit
ControlValve.FRLowLimitR4Flow Rate Low Limit
ControlValve.FRSetpointR4Flow Rate Setpoint
ControlValve.LastHour72FlagR4
ControlValve.LastPercOnSchedR4
ControlValve.LastSetupStartString
ControlValve.LastSetupStopString
ControlValve.LastSetupTargetVolumeR4
ControlValve.LastSetupTermModeUI1
ControlValve.LastStatusActualVolR4
ControlValve.ModeI2Controller Mode
0 Manual
1 Step Open
2 Step Closed
3 Ramp Open
4 Ramp Closed
5 Auto Dp Control
6 Auto Flow Rate Control
7 Auto Sp Control
8 Auto Nominations Control
9 Auto Dp Control with shut-in
10 Auto Flow Rate Control with shut-in
11 Auto Sp Control with shut-in
12 Auto Nominations Control with shut-in
255 Invalid control mode
ControlValve.NextSetupStartString
ControlValve.NextSetupStopString
ControlValve.NextSetupTargetVolumeR4
ControlValve.NextSetupTermModeUI1
ControlValve.NominationActiveUI1
ControlValve.OpenPeriodUI2
ControlValve.OpenTimeUI2
ControlValve.PipeIDR4Pipe Inner Diameter
ControlValve.PulseWidthUI2
ControlValve.RadioPowerupDelayUI2
ControlValve.RadioXmitDelayUI2
ControlValve.RampClosedI2Ramp Closed
ControlValve.RampOpenI2Ramp Open
ControlValve.ShutinPeriodUI2
ControlValve.ShutinTImeUI2
ControlValve.SPDeadbandR4SP Deadband
ControlValve.SPGainI2SP Gain
ControlValve.SPHighLimitR4SP High Limit
ControlValve.SPLowLimitR4SP Low Limit
ControlValve.SPOverrLimitR4
ControlValve.SPRestartLimitR4
ControlValve.SPSetpointR4SP Setpoint
ControlValve.StepClosedI2Step Closed
ControlValve.StepOpenI2Step Open
ControlValve.TimerUnitsI2
ControlValve.ValveLocationI2
ControlValve.ValvePosLowBVUI1
ControlValve.ValveSetTimeI2
CURACCVOLR4Current Accumulated Volume
CURRENTAPR4Current AP
CURRENTDPR4Current DP
CURRENTMCFR4Current flow rate (MDF/Day)
CURRENTTFR4Current Temp
DateTimeDate
DateTime2String
DPHIGHCALR4DP high calibration
DPHIGHLIMITUI1DP hi limit
DPLOWCALR4DP lo calibration
DPLOWLIMITR4DP low limit
DPMIDCALR4DP mid calibration
DPMIDHIGHCALR4DP mid high calibration
DPMIDLOWCALR4DP mid low calibration
ELEMENTUI1Primary element
FIRSTRECEIVEDUI1First analysis received
FIXEDAPR4Fixed AP
FIXEDARR4Fixed Analysis Argon
FIXEDBTUR4Fixed Analysis BTU
FIXEDCDR4Fixed Cd
FIXEDCOR4Fixed Analysis Carbon Monoxide
FIXEDCO2R4Fixed Analysis CO2
FIXEDETHANER4Fixed Analysis Ethane
FIXEDFAUXR4Fixed F(aux)
FIXEDFBR4Fixed F(b)
FIXEDGRAVITYR4Fixed Analysis Gravity
FIXEDHR4Fixed Analysis Hydrogen
FIXEDH2OR4Fixed Analysis H2O
FIXEDH2SR4Fixed Analysis H2S
FIXEDHER4Fixed Analysis HE
FIXEDIBUTANER4Fixed Analysis IButane
FIXEDIPENTANER4Fixed Analysis Ipentane
FIXEDMETHANER4Fixed Analysis Methane
FIXEDN2R4Fixed Analysis N2
FIXEDNBUTANER4Fixed Analysis Nbutane
FIXEDNDECANER4Fixed Analysis Ndecane
FIXEDNHEPTANER4Fixed Analysis Nheptane
FIXEDNHEXANER4Fixed Analysis Nhexane
FIXEDNNONANER4Fixed Analysis Nnonane
FIXEDNOCTANER4Fixed Analysis Noctane
FIXEDNPENTANER4Fixed Analysis Npentane
FIXEDO2R4Fixed Analysis Oxygen
FIXEDPROPANER4Fixed Analysis Propane
FIXEDTEMPR4Fixed temperature
FLOWHIGHLIMITR4Flow Rate high limit (MCF/Day)
FLOWLOWLIMITR4Flow Rate low limit (MCF/Day)
FPR4F(p)
FPVMETHUI1Supercomp method
FTR4F(f)
LASTALARMSUI4Last Calculation Period Alarms
LASTAPR4Last Calculation Period abs. pressure
LASTARR4Last Calculation Period Argon
LASTBTUR4Last Calculation Period BTU
LASTC

LASTCDR4Last Calculation Period Cd. Specific to AGA31992
LASTCOR4Last Calculation Period Carbon Mon
LASTCO2R4Last Calculation Period CO2
LASTCOUNTSUI4Last Calculation Period Int. counts
LASTDPR4Last Calculation Period diff. pressure
LASTETHANER4Last Calculation Period Ethane
LASTEVR4Last Calculation Period Ev. Specific to AGA31992
LASTEXTR4Last Calculation Period Extension.
LASTFAR4Last Calculation Period F(a). Specific to AGA31985
LASTFAUXR4Last Calculation Period F(aux)
LASTFBR4Last Calculation Period F(b). Specific to AGA31985
LASTFGR4Last Calculation Period F(g). Specific to AGA31985
LASTFIPR4Last Calculation Period FIP. Specific to AGA31992
LASTFPBR4Last Calculation Period F(pb). Specific to AGA31985
LASTFPVR4Last Calculation Period F(pv)
LASTFRR4Last Calculation Period F®. Specific to AGA31985
LASTFTBR4Last Calculation Period F(tb). Specific to AGA31985
LASTFTFR4Last Calculation Period F(tf). Specific to AGA31985
LASTFTWR4Last Calculation Period F(tw). Specific to AGA31985
LASTGRAVITYR4Last Calculation Period Gravity
LASTHR4Last Calculation Period Hydrogen
LASTH2OR4Last Calculation Period H2O
LASTH2SR4Last Calculation Period H2S
LASTHER4Last Calculation Period Helium
LASTIBUTANER4Last Calculation Period IButane
LASTIPENTANER4Last Calculation Period IPentane
LASTMCFR4Last Calculation Period volume (MCF)
LASTMETHANER4Last Calculation Period Methane
LASTN2R4Last Calculation Period N2
LASTNBUTANER4Last Calculation Period NButane
LASTNDECANER4Last Calculation Period NDecane
LASTNHEPTANER4Last Calculation Period NHeptane
LASTNHEXANER4Last Calculation Period NHexane
LASTNNONANER4Last Calculation Period Nnonane
LASTNOCTANER4Last Calculation Period NOctane
LASTNPENTANER4Last Calculation Period NPentane
LASTO2R4Last Calculation Period Oxygen
LASTPROPANER4Last Calculation Period Propane
LASTQMR4Last Calculation Period qm. Specific to AGA31992
LASTQVR4Last Calculation Period Qv
LASTRANGEUI4Last Calculation Period Int. range 4
LASTRHOBR4Last Calculation Period Rhob. Specific to AGA31992
LASTTFR4Last Calculation Period flowing temp
LASTYR4Last Calculation Period Y
LIVESTREAMUI1Attach to stream
LOCATIONString
MONELORUI1Monel orifice
MTRIDString
ORDR4Orifice diameter
ORIFCOEFR4Orifice plate coef. of expansion
ORIFRETEMPR4Orifice reference temp
PARTNOString
PIACCUMUVOLR4Accumulated uncorrected volume. Specific to AGA7
PICURRENTPICR4Current Pulse Input Count. Specific to AGA7
PIPECOEFR4Pipe coef. of expansion
PIPEDR4Pipe diameter
PIPEREFTEMPR4Pipe reference temp
PIYESTHIACFR4Yesterday's HI ACF. Specific to AGA7
PIYESTLOACFR4Yesterday's LO ACF. Specific to AGA7
PIYESTUVOLR4Yesterday's uncorrected volume. Specific to AGA7
PRESSBASER4Pressure base
PWDENABLEDUI1Password mode enabled
RATIOR4Ratio of specific heats
RPTUNITSUI1FCU report units
RTDUI1RTD installed
SECCHECKUI1Check security code?
SOFTREVString
STREAMIDUI4Stream ID
TAPLOCUI1Tap Location
TAPPIPEUI1Tap type
TEMPBASER4Temperature base
TEMPBIASR4Temperature bias
TFHIGHLIMITR4Tf high limit
TFLOWLIMITR4Tf low limit
TRIP1ACFHIGHUI1Trip Contact on ACF high alarm
TRIP1ACFLOWUI1Trip Contact on ACF low alarm
TRIP1APHIGHUI1Trip contact on AP high alarm
TRIP1APLOWUI1Trip contact on AP low alarm
TRIP1DPHIGHUI1Trip contact on DP high alarm
TRIP1DPLOWUI1Trip contact on DP low alarm
TRIP1LCUI1Trip contact on LC alarm
TRIP1REMOTEUI1Trip contact on Remote
TRIP1RESETUI1Auto reset contact
TRIP1SETPTUI1Trip contact on volume set point
UFLOWHIGHLIMITR4Uncorrected Flow Rate High Limit
UFLOWLOWLIMITR4Uncorrected Flow Rate Low Limit
USECALCCDUI1Use calcedCd?
USEFAUI1Use F(a)
USEFAUXUI1Use F(aux)
USEFBUI1Use F(b)
USEFGUI1Use F(g)
USEFIXEDERRORUI1Use Fixed Analysis on error
USEFPBUI1USE F(pb)
USEFPVUI1Use F(pv)
USEFRUI1Use F(r)
USEFTBUI1Use F(tb)
USEFTFUI1Use F(tf)
USEFWUI1Use F(w)
USEMEASTEMPUI1Use measured temperature
USESQRTAVGUI1Use square root AP, DP avgs
USEYUI1Use Y
VISCOSITYR4Viscosity
VOL1SETPTR4Volume Set Point for contact
VOLCALCPRDUI2Volume calculation period
VOLLOGPRDUI4Volume Log period
YESTMCFR4Yesterday's volume (MCF)
ZBR4Zb
ZEROCUTOFFR4Zero cutoff

Extended Items

The Totalflow® protocol implementation supports the item names listed below for use by client applications. Item names can be specified as in the table below:

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.
LastHistoryCollectionDateTimestamp of the last history collection.
LastHistoryCollectionUTCDateTimestamp of the last history collection.
LastHistoryResultI4Result of the last history collection attempt.
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.
LastTrendCollectionDateTimestamp of the last trend collection.
LastTrendCollectionUTCDateTimestamp of the last trend collection.
LastTrendRecord/1DateTimestamp of the last trend record retrieved from meter number 1.
LastTrendResultI4Result of the last trend retrieval attempt.
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.
MoveEvent/1I2Move the event 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).
RetrieveDailyBOOLResult of retrieving daily records for all enabled meters. 
RetrieveDaily_AdhocBOOLResult of retrieving daily records for all enabled meters without changing the history position information. 
RetrieveEventBOOLResult of retrieving event records or all enabled meters. 
RetrieveEvent_AdhocBOOLResult of retrieving event records for all enabled meters without changing the history position information. 
RetrieveHistoryI2Retrieve enabled history.
RetrieveLogPeriodBOOLResult of retrieving log period and alarm records for all enabled meters. 
RetrieveLogPeriod_AdhocBOOLResult of retrieving log period and alarm records for all enabled meters without changing the history position information. 
RetrieveTrendI2Retrieve enabled trends. 
SetDaily/1DateSets the daily history retrieval position to a specified date and time for meter 1.
SetLogPeriod/1DateSets the log period and alarm history retrieval position to a specified date and time for meter 1.
SetTrend/1DateSets the trend history retrieval position to a specified date and time for meter 1.
TimeSyncI2Perform time synchronization.

For assistance, please submit a ticket via our Support Portal, email autosol.support@autosoln.com or call 281.286.6017 to speak to a support team member.