106 #include <QmathLib.h> 107 #include <IQmathLib.h> 121 #define USS_UUPS_PWR_REQ_IGN_INTERRUPT BIT0 126 #define USS_UUPS_PWR_UP_TM_OUT_INTERRUPT BIT1 131 #define USS_SAPH_DATA_ERR_ABORT_INTERRUPT BIT2 136 #define USS_SAPH_TMF_TM_OUT_INTERRUPT BIT3 142 #define USS_SAPH_SEQ_ACQ_DN_INTERRUPT BIT4 148 #define USS_SAPH_PING_DN_INTERRUPT BIT5 153 #define USS_HSPLL_PLL_UNLOCK_INTERRUPT BIT6 154 #define USS_SDHS_WINLO_INTERRUPT BIT7 162 #define USS_SDHS_WINHI_INTERRUPT BIT8 167 #define USS_SDHS_DTRDY_INTERRUPT BIT9 172 #define USS_SDHS_SSTRG_INTERRUPT BITA 177 #define USS_SDHS_ACQDONE_INTERRUPT BITB 182 #define USS_SDHS_OVF_INTERRUPT BITC 188 #define USS_TIMER_EXPIRED_INTERRUPT BITD 193 #define USS_SAPH_SEQUENCE_STOPPED BITE 198 #define USS_UUPS_STOPPED_BY_DEBUGGER BITF 202 #define USS_TIMER_EXPIRED_EVENT1_INTERRUPT 0x10000 206 #define USS_SAPH_DMA_ACK_VIOLATION (0x00010000) 208 #define HARDWAREWREG16(x) (*((volatile uint16_t *)((uint16_t)x))) 214 #define USS_Alg_dToF_Calculation_Option_gas USS_Alg_dToF_Calculation_Option_estimate 1561 const int16_t (*pInterpCorrectionTablePtr)[2];
1644 #ifdef USS_CALIBRATE_SIGNAL_GAIN_TEST 1645 extern int16_t ussMaxSignal[5];
1803 USS_low_power_mode_option lpmMode,
2454 void function(
void));
2468 void function(
void));
2481 void function(
void));
2493 void function(
void));
2554 #endif // extern "C" 2556 #endif // end of _USSSWLIB_H_ definition _USS_measurement_end_of_sequence_state_
This is the USS state after capture is done.
Definition: ussSwLib.h:616
int16_t posSearchRange
Positive search range for tracking envelope maximum.
Definition: ussSwLib.h:1524
Definition: ussSwLib.h:382
USS channel remains in low state.
Definition: ussSwLib.h:498
float signalValueThresholdCheck
Definition: ussSwLib.h:1435
Generate a dual tone pulse.
Definition: ussSwLib.h:573
_USS_Alg_volume_flow_Calculation_Option_
Enumerated type for volume flow rate algorithm selection.
Definition: ussSwLib.h:966
float cycleSlipThreshold
Definition: ussSwLib.h:1480
Definition: ussSwLib.h:339
_USS_measurement_ULP_bias_delay_
Allows user to select the ULP bias delay during USS Power up. sequence. The ULP bias allows a faster ...
Definition: ussSwLib.h:518
Definition: ussSwLib.h:968
Definition: ussSwLib.h:386
uint16_t * pNumOfEPulsArray
Definition: ussSwLib.h:1010
_USS_HSPLL_output_clk_freq_
Selects USS HSPLL output clock frequency.
Definition: ussSwLib.h:782
Contains USS SW Lib Meter Configuration.
Definition: ussSwLib.h:1123
USS_message_code USS_initAlgorithms(USS_SW_Library_configuration *config)
The following API initializes USS_Algorithms_Handle based on user USS_Algorithms_User_Configuration, USS_System_Configuration, USS_Meter_Configuration and USS_Measurement_Configuration structs. Currently this API does not perform any parameter checks.
Interrupt for data error pending.
Definition: ussSwLib.h:838
uint16_t * pRAMPulseConfigArray
Definition: ussSwLib.h:1058
void USS_generateLPMDelay(USS_SW_Library_configuration *config, USS_low_power_mode_option lpmMode, uint16_t count)
The following API can be used to generate a Low Power Mode Delay. The API allows to select the desire...
Definition: ussSwLibMeasurement.c:251
Definition: ussSwLib.h:877
USS_HSPLL_Interrupt
Used to configure USS HSPLL interrupt callback.
Definition: ussSwLib.h:863
USS_message_code USS_generateMonoDualToneBinaryPattern(USS_SW_Library_configuration *config)
The following API is used to generate the binary pattern used by USS_Alg_AbsToF_Calculation_Option_lo...
This error is returned if startPPGCount is invalid.
Definition: ussSwLib.h:245
int16_t * USS_getDNSPtr(USS_SW_Library_configuration *config)
The following API allows to obtain the address were DNS capture starts. IMPORTANT: USS_configureUltra...
USS_measurement_pulse_polarity pulsePolarity
Allows user to control pulse polarity.
Definition: ussSwLib.h:1095
USS_message_code USS_startUltrasonicMeasurement(USS_SW_Library_configuration *config, USS_capture_power_mode_option powerMode)
The following API can be used to trigger a USS Capture via software trigger. NOTE: User must call...
Definition: ussSwLibMeasurement.c:88
_USS_capture_power_mode_
Selects the desired power mode while USS capture is done, API will remain in this mode until capture ...
Definition: ussSwLib.h:461
USS_Capture_Configuration * captureConfig
Pointer to USS_Capture_Configuration struct.
Definition: ussSwLib.h:1621
USS_SAPH_Interrupt
Selects appropiate USS SAPH interrupt (Used to register interrupt callback functions) ...
Definition: ussSwLib.h:836
uint32_t transducerFreq
Transducer Frequency in Hz.
Definition: ussSwLib.h:1134
USS HSPLL output frequency of 72 MHz.
Definition: ussSwLib.h:800
USS_Meter_Configuration * meterConfig
Pointer to USS_Meter_Configuration struct.
Definition: ussSwLib.h:1615
USS_Pulse_Additional_End_of_Sequence_Configuration * pEOFSeqConfig
Definition: ussSwLib.h:1065
Definition: ussSwLib.h:429
Configure PGA range to 25.8 dB.
Definition: ussSwLib.h:726
Definition: ussSwLib.h:611
USS_measurement_pause_state pauseState
Specifies the line state during the acquisition sequence.
Definition: ussSwLib.h:1093
Definition: ussSwLib.h:871
void USS_registerSAPHInterruptCallback(USS_SAPH_Interrupt interruptNum, void function(void))
The following API registers a function callback to the desired SAPH interrupt vector.
Definition: ussSwLibISR.c:72
Definition: ussSwLib.h:969
Definition: ussSwLib.h:261
Start pulse generation with high pulse.
Definition: ussSwLib.h:508
bool isInitAlgorithms
This flag is used to indicate if the algorithms have been initialized.
Definition: ussSwLib.h:1463
uint16_t binaryPatternLength
Definition: ussSwLib.h:1534
Configure PGA range to 14.9 dB.
Definition: ussSwLib.h:698
uint16_t agcConstant
Definition: ussSwLib.h:1355
Definition: ussSwLib.h:359
int16_t windowHighThreshold
Definition: ussSwLib.h:1345
uint8_t winStartIndexBackOffNumCycles
Definition: ussSwLib.h:1447
USS_message_code USS_updateClockRelativeError(USS_SW_Library_configuration *config)
The following API allows user to update clockRelativeError parameter during runtime. The clockRelativeError parameter is used to by USS_runAlgorithms and USS_runAlgorithmsFixedPoint APIs. The clockRelativeError parameter is used to correct the UPS and DNS AbsTOF calculations. Refere to clockRelativeError description for for guidance on how to estimate this parameter using USS_verifyHSPLLFrequency API.
Definition: ussSwLib.h:746
USS_measurement_ULP_bias_delay ulpBiasDelay
Definition: ussSwLib.h:1210
Configure PGA range to 12.2 dB.
Definition: ussSwLib.h:692
USS HSPLL output frequency of 73 MHz.
Definition: ussSwLib.h:798
Definition: ussSwLib.h:355
void USS_registerHSPLLInterruptCallback(USS_HSPLL_Interrupt interruptNum, void function(void))
The following API registers a function callback to the desired HSPLL interrupt vector.
Definition: ussSwLibISR.c:150
Contains USS SW Lib Algorithms Results.
Definition: ussSwLib.h:1580
enum _USS_stop_measurement_state_ USS_stop_measurement_state
Selects USS state after capture has been stopped.
uint_least16_t restartCaptureCount
Definition: ussSwLib.h:1187
bool isCalculateDnsAbsTofOffset
Definition: ussSwLib.h:1275
Configure PGA range to 21.5 dB.
Definition: ussSwLib.h:714
Definition: ussSwLib.h:934
Configure PGA range to -1.4 dB.
Definition: ussSwLib.h:658
USS_message_code USS_verifyHSPLLFrequency(USS_SW_Library_configuration *config, USS_calibration_hspll_results *testResults)
The following API allows to verify the HSPLL frequency is set at the user selected pllOutputFreq_inHz...
Definition: ussSwLibCalibration.c:18
uint16_t * pXPulsHPerArray
Definition: ussSwLib.h:1054
USS_Alg_dToF_Calculation_Option dtoFCalcOption
Specifies Delta ToF Calculation option.
Definition: ussSwLib.h:1553
This error is returned if sample size is invalid.
Definition: ussSwLib.h:295
int32_t iq40TotalTOF_UPS
Upstream total Time Of Flight calculation result.
Definition: ussSwLib.h:1600
Interrupt for SDHS Data Ready.
Definition: ussSwLib.h:824
USS_message_code USS_testSDHSconversion(USS_SW_Library_configuration *config, USS_test_channel SDHSChannel, USS_capture_power_mode_option mode)
The following trigger manual SDHS conversion with current SDHS configuration. SDHS configuration is c...
Definition: ussSwLibAppDebug.c:58
struct _USS_Algorithms_Results_ USS_Algorithms_Results
Contains USS SW Lib Algorithms Results.
USS_HSPLL_input_clock_type HSPLLInputCLKType
Definition: ussSwLib.h:1228
enum _USS_measurement_ULP_bias_delay_ USS_measurement_ULP_bias_delay
Allows user to select the ULP bias delay during USS Power up. sequence. The ULP bias allows a faster ...
Allows user to specify the pulse configuration.
Definition: ussSwLib.h:1089
USS_message_code USS_calibrateSignalGain(USS_SW_Library_configuration *config)
The following API runs the SDHS Signal Gain calibration routine if no errors are encountered during S...
Definition: ussSwLibCalibration.c:318
Configure PGA range to 23.6 dB.
Definition: ussSwLib.h:720
Max drive strength will be applied.
Definition: ussSwLib.h:487
void USS_unregisterHSPLLInterruptCallback(USS_HSPLL_Interrupt interruptNum)
The following API unregisters a function callback to the desired HSPLL interrupt vector.
Definition: ussSwLibISR.c:162
USS_Alg_volume_flow_Calculation_Option volumeCalOption
Specifies Volume Flow Rate Calculation option.
Definition: ussSwLib.h:1555
MSP remains in LPM0 power mode until USS capture is done.
Definition: ussSwLib.h:465
Definition: ussSwLib.h:300
float totalTOF_UPS
Upstream total Time Of Flight calculation result.
Definition: ussSwLib.h:1585
int16_t calibratedDCOffsetUPS
Definition: ussSwLib.h:1455
Configure PGA range to 8.7 dB.
Definition: ussSwLib.h:682
int16_t * USS_getUPSPtr(USS_SW_Library_configuration *config)
The following API allows to obtain the address were UPS capture starts. IMPORTANT: USS_configureUltra...
Configures ASQ for double channel capture.
Definition: ussSwLib.h:597
Pre-trimmed drive strength will be applied.
Definition: ussSwLib.h:485
_USS_Alg_AbsToF_Calculation_Option_
Enumerated type for absTOF algorithm selection.
Definition: ussSwLib.h:946
uint16_t * pEPulsHPerArray
Definition: ussSwLib.h:1042
USS_Capture_Over_Sample_Rate overSampleRate
Definition: ussSwLib.h:1325
Definition: ussSwLib.h:600
struct _USS_Capture_Configuration_ USS_Capture_Configuration
Contains USS SW Lib Capture Configuration.
USS_message_code USS_generateMultiToneBinaryPattern(USS_SW_Library_configuration *config)
The following API is used to generate the binary pattern used by USS_Alg_AbsToF_Calculation_Option_lo...
_USS_Trigger_Configuration_Trigger_
Selects USS trigger option.
Definition: ussSwLib.h:752
bool isCalculateUpsAbsTofOffset
Definition: ussSwLib.h:1270
uint16_t numOfTrillcycles
Definition: ussSwLib.h:1033
MSP remains in ACTIVE power mode until USS capture is done.
Definition: ussSwLib.h:463
uint8_t numOfStopPulses
Definition: ussSwLib.h:1114
uint16_t LFXTFrequency
Low Frequency Crystal (LFXT) frequency in Hz.
Definition: ussSwLib.h:991
struct _USS_Meter_Configuration_ USS_Meter_Configuration
Contains USS SW Lib Meter Configuration.
This mode will allow to achieve lowest power consumption.
Definition: ussSwLib.h:450
bool isCalculateDToFOffset
Definition: ussSwLib.h:1280
Definition: ussSwLib.h:292
uint8_t numCycleSearchCorrPeak
Definition: ussSwLib.h:1438
Configure PGA range to 5.2 dB.
Definition: ussSwLib.h:674
USS goes to STANDBY state after capture is done.
Definition: ussSwLib.h:618
USS HSPLL output frequency of 68 MHz.
Definition: ussSwLib.h:808
float upsAbsToFOffset
Definition: ussSwLib.h:1290
_USS_highFlow_option_
Defines high flow computation options.
Definition: ussSwLib.h:870
USS HSPLL output frequency of 77 MHz.
Definition: ussSwLib.h:790
USS_message_code USS_updateUSSInterruptsConfiguration(USS_SW_Library_configuration *config)
The following function updates the UUPS module interrupt configuration based on user defined USS_Inte...
Definition: ussSwLibConfiguration.c:529
This error is returned if a UUPS Power up time out is detected.
Definition: ussSwLib.h:314
Configure PGA range to 24.6 dB.
Definition: ussSwLib.h:722
bool enableFilter
Definition: ussSwLib.h:1503
USS_HSPLL_input_clock_freq ussXtalFreq
Definition: ussSwLib.h:1227
Interrupt for SDHS Window High.
Definition: ussSwLib.h:826
This error is returned if an ASQ time out occurs.
Definition: ussSwLib.h:325
uint16_t * pNumOfXPulsArray
Definition: ussSwLib.h:1046
int16_t negSearchRange
Negative search range for tracking envelope maximum.
Definition: ussSwLib.h:1522
int32_t iq16VolumeFlowRate
Volume flow rate calculation result.
Definition: ussSwLib.h:1604
Definition: ussSwLib.h:227
bool isCapAccumulationEnabled
Definition: ussSwLib.h:1377
int32_t iq44DeltaTOF
Delta Time Of Flight calculation result.
Definition: ussSwLib.h:1598
float volumeFlowRate
Volume flow rate calculation result.
Definition: ussSwLib.h:1589
enum _USS_highFlow_option_ USS_highFlow_option
Defines high flow computation options.
float corrValueThresholdCheckFactor
Definition: ussSwLib.h:1452
struct _USS_Algorithms_User_Configuration_ USS_Algorithms_User_Configuration
Contains USS SW Lib Algorithms User Configuration.
This error is returned if startPGAandINBiasCount is invalid.
Definition: ussSwLib.h:255
Contains USS SW Lib configuration.
Definition: ussSwLib.h:1611
MSP remains in LPM0 power mode until timer expires.
Definition: ussSwLib.h:887
Configure PGA range to 7.7 dB.
Definition: ussSwLib.h:680
This error is returned if an invalid charge pump configuration is selected.
Definition: ussSwLib.h:259
Interrupt for UUPS to indicate USS has been interrupted by debug.
Definition: ussSwLib.h:856
int32_t iq40TotalTOF_DNS
Downstream total Time Of Flight calculation result.
Definition: ussSwLib.h:1602
Configure PGA range to 30.8 dB.
Definition: ussSwLib.h:738
USS_Measurement_Configuration * measurementConfig
Pointer to USS_Measurement_Configuration struct.
Definition: ussSwLib.h:1617
This error is returned if a USS sequence is stopped by the debugger.
Definition: ussSwLib.h:331
USS_message_code USS_startLowPowerUltrasonicCapture(USS_SW_Library_configuration *config)
The following API has been power optimized for ultrasonic capture. The API controls the capture seque...
Definition: ussSwLibMeasurement.c:467
USS_message_code USS_updateUUPSConfiguration(USS_SW_Library_configuration *config)
The following function updates the UUPS module configuration based on user defined USS_Trigger_Config...
Definition: ussSwLibConfiguration.c:513
uint8_t winTrapzRampOverNumCycles
The number of cycles over which the trapezoid window should ramp.
Definition: ussSwLib.h:1450
Definition: ussSwLib.h:606
Configure PGA range to 11.7 dB.
Definition: ussSwLib.h:690
Definition: ussSwLib.h:347
Definition: ussSwLib.h:609
void * pToneConfig
Definition: ussSwLib.h:1105
USS_message_code USS_updateABSTOFCalculationIteration(USS_SW_Library_configuration *config)
The following API allows user to update the frequency at which the Absolute Time of Flight is calcula...
USS channel remains in high state.
Definition: ussSwLib.h:500
uint8_t F1DutyCycle
Definition: ussSwLib.h:1074
uint16_t validationKey
Definition: ussSwLib.h:1631
USS_measurement_pulse_generation_mode pulseGenMode
Determines the type of pulse to be generated.
Definition: ussSwLib.h:1091
USS_message_code USS_getResultsInFloat(USS_Algorithms_Results_fixed_point *pFixedResults, USS_Algorithms_Results *pFloatResults)
The following API allows user to convert the fixed point Algorithm results to floating point represen...
uint32_t F2Frequency
Definition: ussSwLib.h:1101
Definition: ussSwLib.h:242
struct _USS_Algorithms_Results_fixed_point_ USS_Algorithms_Results_fixed_point
Contains USS SW Lib Algorithms Results.
float maxRatioPeak2PeakVariation
Definition: ussSwLib.h:1444
void USS_registerSDHSInterruptCallback(USS_SDHS_Interrupt interruptNum, void function(void))
The following API registers a function callback to the desired SAPH interrupt vector.
Definition: ussSwLibISR.c:19
float dToFOffset
Definition: ussSwLib.h:1300
This error is returned if an invalid bias impedance value is selected.
Definition: ussSwLib.h:257
enum _USS_Alg_dToF_Calculation_Option_ USS_Alg_dToF_Calculation_Option
Enumerated type for dToF algorithm selection.
This structure is passed to USS_calculateOffsets API and calibration test result will be returned in ...
Definition: ussSwLib.h:1288
Disables ULP bias delay functionality.
Definition: ussSwLib.h:520
void USS_unregisterSDHSInterruptCallback(USS_SDHS_Interrupt interruptNum)
The following API registers a function callback to the desired SAPH interrupt vector.
Definition: ussSwLibISR.c:46
float volumeScaleFactor
Definition: ussSwLib.h:1125
Definition: ussSwLib.h:910
USS HSPLL output frequency of 69 MHz.
Definition: ussSwLib.h:806
The mux charge pump remains ON during the firing/capture sequence.
Definition: ussSwLib.h:560
enum _USS_measurement_drive_strength_ USS_measurement_drive_strength
Allows user to select USS channel drive strength. User can select between max strength and pre-trimme...
USS_message_code USS_runAlgorithms(USS_SW_Library_configuration *config, USS_Algorithms_Results *results)
The following API calculates Absolute ToF Upstream, Absolute ToF Downstream, Delta ToF...
enum _USS_measurement_pulse_polarity_ USS_measurement_pulse_polarity
Allows user to select starting pulse state.
This error is returned if ussXTALsettlelingCount is 0.
Definition: ussSwLib.h:285
enum _USS_low_power_mode_option_ USS_low_power_mode_option
Selects the desired power mode while USS capture is done.
enum _USS_dcOffEst_Calc_Mode_ USS_dcOffEst_Calc_Mode
Selects the UPS/DNS DC offset estimation mode used by USS_estimateDCoffset API.
Definition: ussSwLib.h:610
Definition: ussSwLib.h:366
This error is returned if there is an error locking the PLL.
Definition: ussSwLib.h:275
Definition: ussSwLib.h:363
uint_least16_t startADCsamplingCount
Definition: ussSwLib.h:1177
uint16_t absTOFInterval
Definition: ussSwLib.h:1410
uint16_t * pXPulsLPerArray
Definition: ussSwLib.h:1014
Configure PGA range to 22.8 dB.
Definition: ussSwLib.h:718
uint_least16_t startPGAandINBiasCount
Definition: ussSwLib.h:1167
bool isUseLPMCapture
Definition: ussSwLib.h:1266
Configures SDHS Over Sample Rate to 160.
Definition: ussSwLib.h:638
Contains USS SW Lib System Configuration.
Definition: ussSwLib.h:987
Configure PGA range to 6.0 dB.
Definition: ussSwLib.h:676
Configure PGA range to 26.7 dB.
Definition: ussSwLib.h:728
USS_measurement_capture_sequence sequenceSelection
Definition: ussSwLib.h:1143
USS HSPLL output frequency of 80 MHz.
Definition: ussSwLib.h:784
Configure PGA range to -4.6 dB.
Definition: ussSwLib.h:650
Definition: ussSwLib.h:351
USS_Trigger_Configuration_Trigger triggerConfig
Definition: ussSwLib.h:1390
uint32_t actualTestCount
Contains the average SAPH timer counts in 1 ACLK period.
Definition: ussSwLib.h:1315
Configure PGA range to -2.3 dB.
Definition: ussSwLib.h:656
Interrupt for SDHS Window Low.
Definition: ussSwLib.h:828
_USS_Capture_Over_Sample_Rate_
Configures SDHS Over Sample Rate Registers modified: SDHS.CTL0.OBR
Definition: ussSwLib.h:628
USS_UUPS_Interrupt
Used to configure USS UUPS interrupt callback.
Definition: ussSwLib.h:850
Configure PGA range to -0.8 dB.
Definition: ussSwLib.h:660
Definition: ussSwLib.h:901
USS_message_code USS_startPPGToneGeneration(USS_SW_Library_configuration *config, USS_test_channel PPGChannel)
The following API will the tone generation output in the SAPH module. Tone generation is controll...
Definition: ussSwLibAppDebug.c:196
MSP remains in LPM2 power mode until timer expires.
Definition: ussSwLib.h:891
Interrupt for SDHS Data Overflow.
Definition: ussSwLib.h:818
enum _USS_Capture_Gain_Range_ USS_Capture_Gain_Range
Selects Programmable Gain Amplifier (PGA) range.
USS_message_code USS_stopUltrasonicMeasurement(USS_SW_Library_configuration *config, USS_stop_measurement_state stopMeasurementState)
The following API can be used to stop any active USS capture. The user has the option to select USS s...
Definition: ussSwLibMeasurement.c:167
Interrupt for SDHS Over Input Level.
Definition: ussSwLib.h:820
USS_message_code USS_updateSAPHConfiguration(USS_SW_Library_configuration *config)
The following function updates the SAPH module configuration based on user defined USS_Measurement_Co...
Definition: ussSwLibConfiguration.c:215
uint16_t additionalPatternLength
Length of additional binary pattern the length.
Definition: ussSwLib.h:1547
bool enableWindowing
The flag to enable or disable windowing.
Definition: ussSwLib.h:1433
Definition: ussSwLib.h:605
USS_SDHS_Interrupt
Selects appropiate USS SDHS interrupt (Used to register interrupt callback functions) ...
Definition: ussSwLib.h:816
Configure PGA range to 9.0 dB.
Definition: ussSwLib.h:684
int16_t windowLowThreshold
Definition: ussSwLib.h:1350
enum _USS_Trigger_Configuration_Trigger_ USS_Trigger_Configuration_Trigger
Selects USS trigger option.
Definition: ussSwLib.h:342
Interrupt for SDHS Start conversion Trigger.
Definition: ussSwLib.h:822
This error is returned when conversion was interrupted.
Definition: ussSwLib.h:405
Configure PGA range to 1.0 dB.
Definition: ussSwLib.h:664
USS_diagnostics_mode diagMode
Used to USS SW Library diagnostic mode.
Definition: ussSwLib.h:1001
Definition: ussSwLib.h:927
_USS_HSPLL_input_clock_type_
Selects USS HSPLL input clock Type.
Definition: ussSwLib.h:771
USS_dtof_volume_flow_calculation_interval dtofVolInterval
Definition: ussSwLib.h:1465
struct _USS_Measurement_Configuration_ USS_Measurement_Configuration
Contains USS SW Lib Measurement Configuration.
USS_message_code USS_swapCaptureChannels(USS_SW_Library_configuration *config)
This function allows user to swap capture channels. This functionality is only available when USS_mea...
Definition: ussSwLibMeasurement.c:699
MSP remains in LPM1 power mode until timer expires.
Definition: ussSwLib.h:889
enum _USS_measurement_pulse_generation_mode_ USS_measurement_pulse_generation_mode
Lists pulse generation options.
Indicates an error during DCO calibration routine.
Definition: ussSwLib.h:413
Indicates a timeout occurred during signal gain calibration routine.
Definition: ussSwLib.h:415
USS_measurement_drive_strength ch1DriveStrength
Definition: ussSwLib.h:1146
Definition: ussSwLib.h:960
Definition: ussSwLib.h:436
Definition: ussSwLib.h:418
Definition: ussSwLib.h:525
uint16_t maxCapture
Specifies the maximum capture size.
Definition: ussSwLib.h:1375
USS_HSPLL_output_clk_freq pllOutputFreq
Definition: ussSwLib.h:1229
Definition: ussSwLib.h:904
Definition: ussSwLib.h:433
This structure is passed to USS_verifyHSPLLFrequency API and test result will be returned using this ...
Definition: ussSwLib.h:1310
Indicates an error during Gain calibration routine.
Definition: ussSwLib.h:411
Configure PGA range to 4.4 dB.
Definition: ussSwLib.h:672
Indicates a timeout occurred during DAC calibration.
Definition: ussSwLib.h:422
struct _USS_Trigger_Configuration_ USS_Trigger_Configuration
Contains USS SW Lib Trigger Configuration.
Definition: ussSwLib.h:477
int16_t * pCapturesBuffer
then numberOfAcquisitions = 4.
Definition: ussSwLib.h:1362
Configure PGA range to 17.2 dB.
Definition: ussSwLib.h:704
uint_least16_t turnOnADCCount
Definition: ussSwLib.h:1157
USS goes to OFF state.
Definition: ussSwLib.h:475
Contains USS SW Lib HSPLL Configuration.
Definition: ussSwLib.h:1225
Definition: ussSwLib.h:747
Definition: ussSwLib.h:907
Configure PGA range to 10.7 dB.
Definition: ussSwLib.h:688
struct _USS_calibration_hspll_results_ USS_calibration_hspll_results
This structure is passed to USS_verifyHSPLLFrequency API and test result will be returned using this ...
struct _USS_Pulse_Additional_End_of_Sequence_Configuration_ USS_Pulse_Additional_End_of_Sequence_Configuration
Structure to configure additional multi tone pulse generation.
Configure PGA range to 13.9 dB.
Definition: ussSwLib.h:696
Configure PGA range to 18.2 dB.
Definition: ussSwLib.h:706
This error is returned if input frequency for HSPLL module is invalid.
Definition: ussSwLib.h:271
USS_message_code USS_updateAdditionalCaptureDelay(USS_SW_Library_configuration *config, float additionalCaptureDelay)
This function allows users to update Additional Capture Delay with with minimal algorithm reconfigura...
float dnsAbsToFOffset
Definition: ussSwLib.h:1295
uint16_t numOfTrillcycles
En e-pulse followed by an x-pulse sequence is considered a trill cycle.
Definition: ussSwLib.h:1008
uint16_t maxBinaryPatternLenght
Definition: ussSwLib.h:1539
Definition: ussSwLib.h:596
Contains USS SW Lib Algorithms User Configuration.
Definition: ussSwLib.h:1408
This error is returned if HSPLL detects pll has unlocked.
Definition: ussSwLib.h:277
Definition: ussSwLib.h:279
Select this option if USS Crystal is 8 MHz.
Definition: ussSwLib.h:765
Configure PGA range to 2.6 dB.
Definition: ussSwLib.h:668
Definition: ussSwLib.h:522
USS_Pulse_Configuration * pulseConfig
Definition: ussSwLib.h:1147
Definition: ussSwLib.h:601
enum _USS_message_code_ USS_message_code
The following enumeration contain all possible USS SW Library return message codes.
float ratioOfTrackLobeToPeak
The ratio of side lobe closest to threshold and peak lobe amplitudes.
Definition: ussSwLib.h:1429
int16_t * pAccCaptureBuffer
(sampleSize*numberOfAcquisitions * 2) bytes and 32 bit aligned.
Definition: ussSwLib.h:1380
float crossThreshold
Threshold for tracking crossing point of envelope relative to envelope maximum.
Definition: ussSwLib.h:1526
USS_measurement_drive_strength ch0DriveStrength
Definition: ussSwLib.h:1145
Definition: ussSwLib.h:369
uint16_t filterLength
This parameter is used to specify the filter length.
Definition: ussSwLib.h:1506
This error is returned if restartCaptureCount is invalid.
Definition: ussSwLib.h:251
USS_System_Configuration * systemConfig
Pointer to USS_System_Configuration struct.
Definition: ussSwLib.h:1613
Definition: ussSwLib.h:453
Calculates absTOF using Hilbert method.
Definition: ussSwLib.h:949
USS_Algorithms_User_Configuration * algorithmsConfig
Pointer to USS_Algorithms_Configuration struct.
Definition: ussSwLib.h:1625
enum _USS_Alg_volume_flow_Calculation_Option_ USS_Alg_volume_flow_Calculation_Option
Enumerated type for volume flow rate algorithm selection.
uint16_t sampleSize
Definition: ussSwLib.h:1328
Contains USS SW Lib Trigger Configuration.
Definition: ussSwLib.h:1388
USS HSPLL output frequency of 74 MHz.
Definition: ussSwLib.h:796
Definition: ussSwLib.h:452
Select this option if HSPLL input clock is a high accuracy crystal.
Definition: ussSwLib.h:773
Interrupt for Power Request Ignored.
Definition: ussSwLib.h:852
USS_message_code USS_configureUltrasonicMeasurement(USS_SW_Library_configuration *config)
The following API configures USS module based on user configuration files "ussSwLib_userConfig.c" and "ussSwLib_userConfig.h". This API will internally invoke all USS Configuration APIs. In addition, this API will initialize the timer which will be used to generate delays such as the delay to stabilize PLL XTAL.
Definition: ussSwLibMeasurement.c:28
enum _USS_measurement_pause_state_ USS_measurement_pause_state
Allows user to select pause state. Pause state is considered to be time before and after USS Channel ...
Configure PGA range to 6.8 dB.
Definition: ussSwLib.h:678
Calculate absTOF using lobe wide method.
Definition: ussSwLib.h:951
This error is returned if a data error is triggered during sequence.
Definition: ussSwLib.h:323
USS_message_code USS_swapAlgorithmsCaptureBuffers(USS_SW_Library_configuration *config)
This function allows user to swap capture buffers. It is highly recommended to call this function aft...
This error is returned when SAPH number of excitation pulses is invalid.
Definition: ussSwLib.h:238
USS HSPLL output frequency of 71 MHz.
Definition: ussSwLib.h:802
enum _USS_test_channel_ USS_test_channel
Selects USS channel to be used for test (Used for Application Debug API)
struct _USS_dTof_absTof_offset_results_ USS_dTof_absTof_offset_results
This structure is passed to USS_calculateOffsets API and calibration test result will be returned in ...
enum _USS_Alg_AbsToF_Calculation_Option_ USS_Alg_AbsToF_Calculation_Option
Enumerated type for absTOF algorithm selection.
float acousticLength
Acoustic length in usec at room temperature.
Definition: ussSwLib.h:1132
uint16_t hilbertTransformCoeffsLength
Length of hilbert coefficients.
Definition: ussSwLib.h:1520
Configure PGA range to 28.9 dB.
Definition: ussSwLib.h:734
The following structure allows user to specify single and dual tone configuration.
Definition: ussSwLib.h:1072
Indicates an error during DAC calibration routine.
Definition: ussSwLib.h:409
USS_message_code messageCode
Definition: ussSwLib.h:1582
Interrupt for Time Mark F time out.
Definition: ussSwLib.h:840
Interrupt for UUPS Power Up Time Out.
Definition: ussSwLib.h:854
_USS_HSPLL_input_clock_freq_
Selects USS Crystal Frequency.
Definition: ussSwLib.h:761
Definition: ussSwLib.h:599
_USS_Alg_dToF_Calculation_Option_
Enumerated type for dToF algorithm selection.
Definition: ussSwLib.h:959
uint32_t expectedResult
Definition: ussSwLib.h:1312
The mux charge pump remains OFF during the firing/capture sequence.
Definition: ussSwLib.h:562
Interrupt for PLL Unlock.
Definition: ussSwLib.h:865
uint8_t numPulsesBeforeThreshold
The number of pulses/cycles before selected threshold value.
Definition: ussSwLib.h:1431
_USS_measurement_capture_sequence_
Allows user to select USS capture sequence.
Definition: ussSwLib.h:592
uint16_t origNumOfThrillCycles
Definition: ussSwLib.h:1021
Calculates absTOF using lobe method.
Definition: ussSwLib.h:947
enum _USS_HSPLL_output_clk_freq_ USS_HSPLL_output_clk_freq
Selects USS HSPLL output clock frequency.
Configure PGA range to 15.5 dB.
Definition: ussSwLib.h:700
uint16_t * pRAMDMAConfigArray
Definition: ussSwLib.h:1062
Indicates signal gain calibration completed successfully.
Definition: ussSwLib.h:420
Configures SDHS Over Sample Rate to 40.
Definition: ussSwLib.h:634
void USS_unregisterUUPSInterruptCallback(USS_UUPS_Interrupt interruptNum)
The following API unregisters a function callback to the desired UUPS interrupt vector.
Definition: ussSwLibISR.c:132
Configure PGA range to 19.6 dB.
Definition: ussSwLib.h:710
This error is returned if a USS power up error is detected.
Definition: ussSwLib.h:316
int32_t * pNvMemBuffer
Definition: ussSwLib.h:1473
int16_t * filterCoeffs
Definition: ussSwLib.h:1508
int16_t * pLEAMemBuffer2
Definition: ussSwLib.h:1513
uint16_t startRxEnCount
Definition: ussSwLib.h:1218
This error is returned if a USS power down error is detected.
Definition: ussSwLib.h:318
Configures ASQ for triple channel capture.
Definition: ussSwLib.h:602
Configure PGA range to 18.8 dB.
Definition: ussSwLib.h:708
Calculate absTOF using hilbert wide method.
Definition: ussSwLib.h:953
Configure PGA range to 3.5 dB.
Definition: ussSwLib.h:670
uint16_t * pXPulsLPerArray
Definition: ussSwLib.h:1050
_USS_diagnostics_mode_
Selects diagnostic mode to be used by the library. For optimal power consumption it is recommended to...
Definition: ussSwLib.h:448
Configure PGA range to 13.0 dB.
Definition: ussSwLib.h:694
MSP remains in LPM3 power mode until timer expires.
Definition: ussSwLib.h:893
Definition: ussSwLib.h:967
Configure PGA range to -6.5 dB.
Definition: ussSwLib.h:646
struct _USS_Pulse_Multitone_Configuration_ USS_Pulse_Multitone_Configuration
structure to configure multi tone pulse generation
_USS_dcOffEst_Calc_Mode_
Selects the UPS/DNS DC offset estimation mode used by USS_estimateDCoffset API.
Definition: ussSwLib.h:918
int16_t calibratedDCOffsetDNS
Definition: ussSwLib.h:1459
struct _USS_Algorithms_Meter_Constant_Calib_ USS_Algorithms_Meter_Constant_Calib
Contain meter constant calibration data.
Definition: ussSwLib.h:961
float totalTOF_DNS
Downstream total Time Of Flight calculation result.
Definition: ussSwLib.h:1587
USS_Algorithms_Meter_Constant_Calib * pMeterConfiguration
Pointer to USS_Meter_Configuration array.
Definition: ussSwLib.h:1568
Definition: ussSwLib.h:303
struct _USS_Interrupt_Configuration_ USS_Interrupt_Configuration
Contains USS SW Lib Capture Configuration.
Select USS Channel 0.
Definition: ussSwLib.h:584
USS channel remains in high impedance state.
Definition: ussSwLib.h:496
_USS_measurement_pause_state_
Allows user to select pause state. Pause state is considered to be time before and after USS Channel ...
Definition: ussSwLib.h:494
struct _USS_HSPLL_Configuration_ USS_HSPLL_Configuration
Contains USS SW Lib HSPLL Configuration.
enum _USS_measurement_mux_charge_pump_ USS_measurement_mux_charge_pump
The following parameter allow application to turn on/off the PGA input multiplexer during the whole f...
_USS_measurement_pulse_generation_mode_
Lists pulse generation options.
Definition: ussSwLib.h:569
USS_measurement_mux_charge_pump muxChargePumpMode
Allows user to control multiplexer charge pump during capture.
Definition: ussSwLib.h:1216
Generate a multi tone pulse.
Definition: ussSwLib.h:575
struct _USS_SW_Library_configuration_ USS_SW_Library_configuration
Contains USS SW Lib configuration.
Indicates a error has occurred during Abs ToF and DToF calculation.
Definition: ussSwLib.h:424
bool enableWindowLoComp
true = enables Window Comparator, false = disables Window Comparator
Definition: ussSwLib.h:1343
enum _USS_HSPLL_input_clock_freq_ USS_HSPLL_input_clock_freq
Selects USS Crystal Frequency.
struct _USS_Pulse_Configuration_ USS_Pulse_Configuration
Allows user to specify the pulse configuration.
_USS_Capture_Gain_Range_
Selects Programmable Gain Amplifier (PGA) range.
Definition: ussSwLib.h:644
void USS_registerUUPSInterruptCallback(USS_UUPS_Interrupt interruptNum, void function(void))
The following API registers a function callback to the desired UUPS interrupt vector.
Definition: ussSwLibISR.c:114
_USS_measurement_drive_strength_
Allows user to select USS channel drive strength. User can select between max strength and pre-trimme...
Definition: ussSwLib.h:483
struct _USS_System_Configuration_ USS_System_Configuration
Contains USS SW Lib System Configuration.
USS_measurement_end_of_sequence_state eofSequenceState
Definition: ussSwLib.h:1144
USS HSPLL output frequency of 70 MHz.
Definition: ussSwLib.h:804
This structure is passed to USS_calculateOffsets API and define the test calibration configuration...
Definition: ussSwLib.h:1258
USS_message_code messageCode
Definition: ussSwLib.h:1597
Configure PGA range to 28.1 dB.
Definition: ussSwLib.h:732
This error is returned if startADCsamplingCount is invalid.
Definition: ussSwLib.h:249
uint32_t mCLKFrequency
System Clock (MCLK) Frequency in Hz.
Definition: ussSwLib.h:989
_USS_low_power_mode_option_
Selects the desired power mode while USS capture is done.
Definition: ussSwLib.h:884
This error is returned when SAPH number of stop pulses is invalid.
Definition: ussSwLib.h:240
uint16_t searchLobeSampleSteps
Definition: ussSwLib.h:1441
USS_message_code USS_updateSDHSConfiguration(USS_SW_Library_configuration *config)
The following function updates the SDHS module configuration based on user defined USS_Capture_Config...
Definition: ussSwLibConfiguration.c:19
Generates a 1200 Ohms bias impedance.
Definition: ussSwLib.h:545
uint16_t maxAdditionalBinaryPatternLength
Definition: ussSwLib.h:1549
Definition: ussSwLib.h:297
Definition: ussSwLib.h:439
Indicates DAC calibration completed successfully.
Definition: ussSwLib.h:407
uint_least16_t captureTimeOutCount
Definition: ussSwLib.h:1197
enum _USS_diagnostics_mode_ USS_diagnostics_mode
Selects diagnostic mode to be used by the library. For optimal power consumption it is recommended to...
int16_t interpCorrectionTableLenght
Definition: ussSwLib.h:1565
Definition: ussSwLib.h:373
Structure to configure additional multi tone pulse generation.
Definition: ussSwLib.h:1006
_USS_Capture_Calibration_
Selects Programmable Gain Amplifier (PGA) range.
Definition: ussSwLib.h:744
float slope
meter calibration constant
Definition: ussSwLib.h:978
enum _USS_Capture_Calibration_ USS_Capture_Calibration
Selects Programmable Gain Amplifier (PGA) range.
enum _USS_measurement_end_of_sequence_state_ USS_measurement_end_of_sequence_state
This is the USS state after capture is done.
USS_Alg_AbsToF_Calculation_Option absToFOption
User selection for Absolute Time of Flight calculation option.
Definition: ussSwLib.h:1511
USS_Capture_Gain_Range gainRange
Configures the internal gain amplifier.
Definition: ussSwLib.h:1339
Definition: ussSwLib.h:528
_USS_measurement_pulse_polarity_
Allows user to select starting pulse state.
Definition: ussSwLib.h:506
float dcOffset
The constant value calibrated by Zero flow drift (sec)
Definition: ussSwLib.h:1427
Definition: ussSwLib.h:390
int16_t * pAdditionalBinaryPattern
Definition: ussSwLib.h:1543
USS_message_code USS_resetUSSModule(USS_SW_Library_configuration *config, bool reconfigUSSModule)
This function allows application to reset the USS module. It is recommended that this API is used whe...
Definition: ussSwLibConfiguration.c:569
Configure PGA range to 1.9 dB.
Definition: ussSwLib.h:666
Start pulse generation with low pulse.
Definition: ussSwLib.h:510
enum _USS_Capture_Over_Sample_Rate_ USS_Capture_Over_Sample_Rate
Configures SDHS Over Sample Rate Registers modified: SDHS.CTL0.OBR
USS HSPLL output frequency of 75 MHz.
Definition: ussSwLib.h:794
Interrupt for ping transmit done.
Definition: ussSwLib.h:844
Contains USS SW Lib Capture Configuration.
Definition: ussSwLib.h:1395
Definition: ussSwLib.h:235
USS HSPLL output frequency of 76 MHz.
Definition: ussSwLib.h:792
uint8_t numOfF1Cycles
Definition: ussSwLib.h:1080
uint16_t * pNumOfEPulsArray
Definition: ussSwLib.h:1036
Configure PGA range to 0.1 dB.
Definition: ussSwLib.h:662
uint16_t ussXTALsettlingCount
Definition: ussSwLib.h:1243
Definition: ussSwLib.h:920
_USS_measurement_mux_charge_pump_
The following parameter allow application to turn on/off the PGA input multiplexer during the whole f...
Definition: ussSwLib.h:558
USS ISTOP messages.
Definition: ussSwLib.h:401
Configure PGA range to 25.0 dB.
Definition: ussSwLib.h:724
Configure PGA range to 20.5 dB.
Definition: ussSwLib.h:712
_USS_stop_measurement_state_
Selects USS state after capture has been stopped.
Definition: ussSwLib.h:472
Configure PGA range to 22.0 dB.
Definition: ussSwLib.h:716
USS_highFlow_option highFlowOption
Definition: ussSwLib.h:1476
This error is returned if captureTimeOutCount is invalid.
Definition: ussSwLib.h:253
int32_t thresholdX1X3
Definition: ussSwLib.h:1483
Select this option if USS Crystal is 4 MHz.
Definition: ussSwLib.h:763
Interrupt for sequence acquisition done.
Definition: ussSwLib.h:842
bool enableWindowHiComp
true = enables Window Comparator, false = disables Window Comparator
Definition: ussSwLib.h:1341
uint16_t numOfTestIterations
Definition: ussSwLib.h:1260
enum _USS_dtof_volume_flow_calculation_interval_ USS_dtof_volume_flow_calculation_interval
Selects the interval to calculate Delta ToF and Volume Flow.
This error is returned if turnOnADCCount is invalid.
Definition: ussSwLib.h:247
Configures SDHS Over Sample Rate to 80.
Definition: ussSwLib.h:636
uint16_t * pEPulsLPerArray
Definition: ussSwLib.h:1039
Contain meter constant calibration data.
Definition: ussSwLib.h:974
struct _USS_Pulse_Single_Dual_Tone_Configuration_ USS_Pulse_Single_Dual_Tone_Configuration
The following structure allows user to specify single and dual tone configuration.
_iq27 clockRelativeError
Definition: ussSwLib.h:1484
Contains USS SW Lib Capture Configuration.
Definition: ussSwLib.h:1323
Definition: ussSwLib.h:232
USS goes to POWER OFF state after capture is done.
Definition: ussSwLib.h:620
Configure PGA range to -5.5 dB.
Definition: ussSwLib.h:648
Configures ASQ for four channel capture.
Definition: ussSwLib.h:607
USS_message_code USS_updateDtoFOffset(USS_SW_Library_configuration *config, float dTofOffset)
This function allows users to update Delta Time Of Flight Offset with with minimal algorithm reconfig...
_USS_dtof_volume_flow_calculation_interval_
Selects the interval to calculate Delta ToF and Volume Flow.
Definition: ussSwLib.h:899
Configures SDHS Over Sample Rate to 20.
Definition: ussSwLib.h:632
structure to configure multi tone pulse generation
Definition: ussSwLib.h:1019
enum _USS_measurement_capture_sequence_ USS_measurement_capture_sequence
Allows user to select USS capture sequence.
enum _USS_capture_power_mode_ USS_capture_power_mode_option
Selects the desired power mode while USS capture is done, API will remain in this mode until capture ...
USS_Trigger_Configuration * triggerConfig
Pointer to USS_Trigger_Configuration struct.
Definition: ussSwLib.h:1623
UUPS messages.
Definition: ussSwLib.h:311
uint32_t F1Frequency
Definition: ussSwLib.h:1097
Configure PGA range to 29.8 dB.
Definition: ussSwLib.h:736
Configure PGA range to 27.7 dB.
Definition: ussSwLib.h:730
USS HSPLL output frequency of 78 MHz.
Definition: ussSwLib.h:788
Contains USS SW Lib Algorithms Results.
Definition: ussSwLib.h:1595
This error is returned to indicate an ongoing measurement was stopped.
Definition: ussSwLib.h:329
USS_message_code USS_calculateOffsets(USS_SW_Library_configuration *config, USS_dTof_absTof_offset_results *testResults, USS_dTof_absTof_offset_test_config *testConfig)
This API allows the user to estimate the DC offset generated by the SDHS module.
Definition: ussSwLibCalibration.c:508
uint32_t winNumCycles
Definition: ussSwLib.h:1496
int32_t difference
Contains the difference between expected and actualTestCount SAPH.
Definition: ussSwLib.h:1317
enum _USS_HSPLL_input_clock_type_ USS_HSPLL_input_clock_type
Selects USS HSPLL input clock Type.
Definition: ussSwLib.h:282
USS_message_code USS_runAlgorithmsFixedPoint(USS_SW_Library_configuration *config, USS_Algorithms_Results_fixed_point *results)
The following API calculates Absolute ToF Upstream, Absolute ToF Downstream, Delta ToF...
Generates a 2800 Ohms bias impedance.
Definition: ussSwLib.h:547
struct _USS_dTof_absTof_offset_test_config_ USS_dTof_absTof_offset_test_config
This structure is passed to USS_calculateOffsets API and define the test calibration configuration...
int16_t * hilbertTransformCoeffs
Pointer to hilbert coefficients, coefficients must 32-bit aligned.
Definition: ussSwLib.h:1518
float alphaMin
specifies range limit
Definition: ussSwLib.h:976
USS_message_code USS_testPPGconfiguration(USS_SW_Library_configuration *config, USS_test_channel PPGChannel)
The following API will output current PPG configuration. PPG configuration is controlled via the ...
Definition: ussSwLibAppDebug.c:19
Generate a single tone pulse.
Definition: ussSwLib.h:571
float deltaTOF
Delta Time Of Flight calculation result.
Definition: ussSwLib.h:1583
uint16_t hspllTolerance
Definition: ussSwLib.h:1240
USS_message_code USS_updateHSPLLConfiguration(USS_SW_Library_configuration *config)
The following function updates the HSPLL module configuration based on user defined USS_HSPLL_Configu...
Definition: ussSwLibConfiguration.c:88
Generates a 200 Ohms bias impedance.
Definition: ussSwLib.h:541
USS Algorithms message codes.
Definition: ussSwLib.h:336
Configure PGA range to -4.1 dB.
Definition: ussSwLib.h:652
bool USS_isAlgorithmChannelsSwapped(void)
This function allows users to query current status Algorithm Capture buffers.
Configure PGA range to 9.8 dB.
Definition: ussSwLib.h:686
USS_message_code USS_stopPPGToneGeneration(USS_SW_Library_configuration *config)
The following API will stop the tone generation output in the SAPH module.
Definition: ussSwLibAppDebug.c:257
enum _USS_measurement_bias_impedance_ USS_measurement_bias_impedance
The following parameter allows the application to control the RX/TX bias during the acquisition seque...
uint16_t * pXPulsHPerArray
Definition: ussSwLib.h:1015
bool enableSAPHPingTransmitDoneInterrupt
Definition: ussSwLib.h:1400
int16_t maxSampleShift
Definition: ussSwLib.h:1557
volatile uint32_t USSSWLIB_USS_interrupt_status
The following variable is used to monitor USS interrupt status this variable combines SAPH...
Definition: ussSwLibISR.c:16
_USS_measurement_bias_impedance_
The following parameter allows the application to control the RX/TX bias during the acquisition seque...
Definition: ussSwLib.h:539
Definition: ussSwLib.h:395
uint_least16_t restartLowPowerCaptureCount
Definition: ussSwLib.h:1207
Configures ASQ for single channel capture.
Definition: ussSwLib.h:594
Definition: ussSwLib.h:754
This error is returned if the output frequency of the HSPLL is invalid.
Definition: ussSwLib.h:273
Contains USS SW Lib Measurement Configuration.
Definition: ussSwLib.h:1141
_USS_test_channel_
Selects USS channel to be used for test (Used for Application Debug API)
Definition: ussSwLib.h:582
USS_Interrupt_Configuration * interruptConfig
Pointer to USS_Interrupt_Configuration struct.
Definition: ussSwLib.h:1627
void USS_unregisterSAPHInterruptCallback(USS_SAPH_Interrupt interruptNum)
The following API unregisters a function callback to the desired SAPH interrupt vector.
Definition: ussSwLibISR.c:94
Generates a 600 Ohms bias impedance.
Definition: ussSwLib.h:543
int16_t * pLEAMemBuffer1
Definition: ussSwLib.h:1469
bool enableUUPSPREQIGInterrupt
Definition: ussSwLib.h:1397
float offset
delta time of flight calibration constant
Definition: ussSwLib.h:980
Select this option if HSPLL input clock is a ceramic resonator.
Definition: ussSwLib.h:775
Definition: ussSwLib.h:604
uint16_t * pNumOfXPulsArray
Definition: ussSwLib.h:1013
This error is returned if max sample size is entered.
Definition: ussSwLib.h:306
uint16_t * pEPulsHPerArray
Definition: ussSwLib.h:1012
uint_least16_t startPPGCount
Definition: ussSwLib.h:1148
Configure PGA range to 16.3 dB.
Definition: ussSwLib.h:702
USS_message_code USS_estimateDCoffset(USS_SW_Library_configuration *config, USS_dcOffEst_Calc_Mode mode)
This API allows the user to estimate the DC offset generated by the SDHS module.
Definition: ussSwLibCalibration.c:452
Configures SDHS Over Sample Rate to 10.
Definition: ussSwLib.h:630
USS stays in READY state after capture is done.
Definition: ussSwLib.h:622
_USS_message_code_
The following enumeration contain all possible USS SW Library return message codes.
Definition: ussSwLib.h:224
bool outputPLLXtal
Definition: ussSwLib.h:1237
float ADCAdditionalCaptureDelay
Definition: ussSwLib.h:1424
int16_t * pBinaryPattern
Definition: ussSwLib.h:1528
Configure PGA range to -3.3 dB.
Definition: ussSwLib.h:654
USS_HSPLL_Configuration * pllConfiguration
Pointer to USS_HSPLL_Configuration struct.
Definition: ussSwLib.h:1619
SDHS messages.
Definition: ussSwLib.h:290
Select USS Channel 1.
Definition: ussSwLib.h:586
USS HSPLL output frequency of 79 MHz.
Definition: ussSwLib.h:786
Definition: ussSwLib.h:874
uint16_t timerBaseAddress
Definition: ussSwLib.h:993
uint8_t F2DutyCycle
Definition: ussSwLib.h:1077
uint8_t numOfMeterCalibrationRanges
Definition: ussSwLib.h:1570
USS_measurement_bias_impedance biasImpedance
Allows user to control bias channel bias impedance.
Definition: ussSwLib.h:1214
uint16_t * pEPulsLPerArray
Definition: ussSwLib.h:1011
uint8_t numOfF2Cycles
Definition: ussSwLib.h:1083