Logo
MSP Gas Metering Library
GASMETERING_handle Struct Reference

This hanlde is initialized when calling GASMETERING_configureUltrasonicMeasurement and GASMETERING_intializeAlgorithm. More...

#include <gasMeteringLib.h>

Data Fields

float deltaTOF
 The computed deltaTOF.
 
float totalTOF_UPS
 The computed total time of flight upstream.
 
float totalTOF_DNS
 The computed total time of flight downstream.
 
float volumeFlowRate
 The computed volume flow rate.
 
float volumeScaleFactor
 The volume scale factor (Area x Length) length^3.
 
float dcOffset
 The constant value calibrated by Zero flow drift (sec)
 
float ADCSamplePeriod_sec
 The duration between two captured samples (1/Fs)
 
float ADCStartCaptureInstant_sec
 
float ADCAdditionalCaptureDelay_sec
 
uint8_t * arrayTXPtr
 The pointer to the transmit pulses.
 
int16_t arrayLengthTX
 The length of transmit pulses.
 
int16_t * arrayTXbPtr
 The pointer to the binary transmit pulses.
 
int16_t arrayLengthTXb
 The length of binary transmit pulses.
 
int16_t * arrayUPSPtr
 The pointer to the upstream data array.
 
int16_t * arrayDNSPtr
 The pointer to the downstream data array.
 
int16_t arrayLengthDNUP
 The length of data captured for upstream or downstream.
 
int16_t * pDMALEARAMADCArray
 Pointer to array in LEA RAM memory which holds DMA ADC samples.
 
uint16_t dMALEARAMADCArraySize
 
uint16_t aDCSamplePeriod
 
uint16_t fracDelay
 Decimation factor.
 
uint16_t upsampleFactor
 Upsample factor.
 
float negRngDeltaTOF
 
float posRngDeltaTOF
 
float negRngAbsTOF
 
float posRngAbsTOF
 
int16_t corrIdxUPS
 
int16_t corrIdxDNS
 
bool Flag_searchForCorrIdxDNS
 
bool Flag_searchForCorrIdxUPS
 
float envCrossThreshold
 
float fracIdxUPS
 
float fracIdxDNS
 
uint16_t burstDelay
 
uint16_t busrtStartDelay
 
GASMETERING_Algorithm_Computation_Mode computationMode
 
int16_t * arrayHFIRPtr
 
int16_t arrayLengthHFIR
 The length of hilbert co-efficients array.
 
uint8_t hFIRCoeffPower2Scale
 
uint8_t corrValPow2Scale
 
int32_t corrPeakSqValue
 The square of the correlation peak which is computed in absolute TOF.
 
int16_t firstThresCrossIdx
 The index location identified as the first threhold crossing value.
 
float firstThresCrossing_sec
 The actual first threhold crossing value in terms of time.
 
bool Flag_searchForFirstIdx
 The flag to enable search for the first correlation lobe threhold crossing value.
 
bool isLEAusedHE
 
bool isLEAusedFTC
 

Detailed Description

This hanlde is initialized when calling GASMETERING_configureUltrasonicMeasurement and GASMETERING_intializeAlgorithm.

Field Documentation

float GASMETERING_handle::ADCAdditionalCaptureDelay_sec

The additional time it takes during firing and capturing the data, which is not accounted for anywhere else.

float GASMETERING_handle::ADCStartCaptureInstant_sec

The time elapsed from the start of pulse excitation and start of ADC data capture. This relates to the propagation path length.

int16_t* GASMETERING_handle::arrayHFIRPtr

The pointer to the hilbert co-efficients array [coeffs = floor(HILBERT_FIR_COEFF_ARRAY*(2^HFF_COEFF_POW2SCALE)]

GASMETERING_Algorithm_Computation_Mode GASMETERING_handle::computationMode

The parameter to switch between different algorithms to compute deltaTOF and AbsTOF.

int16_t GASMETERING_handle::corrIdxDNS

The index location identified as the correlation peak of the received downstream.

int16_t GASMETERING_handle::corrIdxUPS

The index location identified as the correlation peak of the received upstream.

uint8_t GASMETERING_handle::corrValPow2Scale

The 2 power index scaling factor by which the correlation ouptut between DNS/UPS and TXbinary have been scaled down.

uint16_t GASMETERING_handle::dMALEARAMADCArraySize

ADC array size size is determined is dependent on ADC sampling frequency

float GASMETERING_handle::envCrossThreshold

The envelope crossing threshold of correlation output for absolute TOF.

bool GASMETERING_handle::Flag_searchForCorrIdxDNS

The flag to check if the peak correlation index has to be searched or it has to only be tracked for downstream.

bool GASMETERING_handle::Flag_searchForCorrIdxUPS

The flag to check if the peak correlation index has to be searched or it has to only be tracked for upstream.

float GASMETERING_handle::fracIdxDNS

The fractional index location identified as the envelope threshold crossing of the received downstream.

float GASMETERING_handle::fracIdxUPS

The fractional index location identified as the envelope threshold crossing of the received upstream.

uint8_t GASMETERING_handle::hFIRCoeffPower2Scale

The 2 power index scaling factor by which the hilbert FIR co-efficients have been scaled.

bool GASMETERING_handle::isLEAusedFTC

The following flag indicated if Absolute Time Of Flight First Threshold crossing operation was performed with LEA module

bool GASMETERING_handle::isLEAusedHE

The following flag indicate if Hilbert Envelope operation used LEA module

float GASMETERING_handle::negRngAbsTOF

The max negative index to search across correlation value of UPS/DNS and TX pulse for the matching signal.

float GASMETERING_handle::negRngDeltaTOF

The max negative index to search across correlation value of UPS and DNS for the matching signal.

float GASMETERING_handle::posRngAbsTOF

The max positive index to search across correlation value of UPS/DNS and TX pulse for the matching signal.

float GASMETERING_handle::posRngDeltaTOF

The max positive index to search across correlation value of UPS and DNS for the matching signal.


The documentation for this struct was generated from the following file: