Select a version
USS-SWLIB-WATER
Ultrasonic sensing solution (USS) software library for water metering
Windows Installer for USSSWLib
Linux Installer for USSSWLib
macOS Installer for USSSWLib
Windows Installer for USS Water Demo for FR604x
Linux Installer for USS Water Demo for FR604x
macOS Installer for USS Water Demo for FR604x
Products
MSP430 microcontrollers
Hardware development
Documentation
USS Library User's Guide
USS Library API Guide
USS Design Center Users Guide
What's new
- Desing Center
- Added Configuration->Calibration tab
- Modified Calibration tab to include 3 new sub tabs:
- General (new)
- VFR Flow (updated xml file)
- VFR Flow + Temperatures (new)
- VFR Flow + Temperatures (new)
- Updated generation of USS_userConfig.h
- Fixed Volume flow rate plot y axis units in Waveform panel
- Updated accumulated Volume Flow in Waveform panel
- USS Desing Center Guide
- Updated the Getting Started section with Water / Gas Quick Start Guides
- Updated configuration section with new calibration configurations
- Updated calibration section with 3 new sub tabs:
- General
- VFR Flow
- VFR Flow + Temperatures
- USS Library
- Enhancements
- Updated absTOF_lobeWide to use the same search and tracking method as absTOF_lobe
- maximum lobe peak variation (gUssSWConfig.algorithmsConfig-maxRatioPeak2PeakVariation) is now used as part of absTOF_lobeWide configuration.
- Updated absTOF_lobeWide to allow same interpolation correction used in absTOF_lobe via look-up-tables
- gUssSWConfig.algorithmsConfig-pInterpCorrectionTablePtr and gUssSWConfig.algorithmsConfig-interpCorrectionTableLenght are now used as part of absTOF_lobeWide configuration
- Updated matlab code in User's Guide to generate Interpolation LUT to print the constants in a more legible format to a filename that is provided as an input to the function
- Added support for new API USS_getAbsTOFStatus. New API allows users to obtain the internal AbsTOF status.
- Added support for new API USS_setAbsTOFStatus. New API allows users to set the internal AbsTOF status.
- New USS_Algorithms_User_Configuration parameters:
- windowingMode: Parameter replacing gUssSWConfig.algorithmsConfig-enableWindowing parameter. Used to configure the windowing mode for Delta ToF estimate.
- Valid Inputs are: 0 (disable), 1 (estimate), 2 (dynamic), and 3 (static)
- For backwards compatibility,
- if previously enableWindowing = false, set windowingMode = 0 (disable)
- if previously enableWindowing = true, set windowingMode = 1 (estimate)
- For backwards compatibility,
- Valid Inputs are: 0 (disable), 1 (estimate), 2 (dynamic), and 3 (static)
- winPeakIndex2EdgeNumCyles: The number of cycles from peak of signal to edge (or start) of window down ramp (used for dynamic windowing)
- windowingMode: Parameter replacing gUssSWConfig.algorithmsConfig-enableWindowing parameter. Used to configure the windowing mode for Delta ToF estimate.
- Added new support for new API USS_getAlgorithmObjPtr. New API allow user to get access to the pointer of the internal library algorithm object.
- Added new support for new API USS_getAlgorithmObjLength. New API allow user to get access to the length in bytes of the internal library algorithm object.
- Abstracted Flow VFR calibration into USS_calibrateVFRFlow API
- Renamed algorithmsConfig->calibObject.linCalibObject->pMeterConfiguration.alphaMin to config->algorithmsConfig->calibObject.linCalibObject->pMeterConfiguration.iq16minimumVFR
- Updated Flow VFR calibration to fixed point implementation to reduce cycle count
- Added flow + temperature compensated volume flow rate calibration feature using USS_calibrateVFRFlowTemperature API
- Added temperature estimation API
- USS_computeTemperature used to estimate temperature using UPS and DNS
- USS_setTemperature used to input temperature based on external temperature sensor
- New USS_Algorithms_User_Configuration parameters:
- volumeCalibrationOption: parameter used to define volume flow calibration mode: USS_Alg_volume_flow_Calibration_Option_disabled USS_Alg_volume_flow_Calibration_Option_flow USS_Alg_volume_flow_Calibration_Option_flow_temperature
- calibObject: parameter used to initialize the calibration object based on volumeCalibrationOption configuration
- temperatureCalcOption: parameter used to define temperature estimation mode: USS_Alg_temperature_Calculation_Option_disabled USS_Alg_temperature_Calculation_Option_enabled
- tempCalcObject: parameter used to initialize the temperature estimation based on UPS and DNS object
- Improved memory optimzation compilation for Water & Gas application
- Removed USS_swapCaptureChannels API
- Optimized code based on config->measurementConfig->sequenceSelection
- Optimized code based on config->measurementConfig->pulseConfig->pulseGenMode
- Added additional scale factor (config->meterConfig->volumeAddlScaleFactor) for larger pipes to be used by the USS_scaleVolumeFlowRate API only required if volumeFlowRate is greater than 32768
- Added 2 new APIs to enable accurate measurement rate using background timer
- USS_configAppTimerPeriod - used to define period in ACLK cycles
- USS_waitForAppTimerElapse - used to wait for timer to elapse
- Updated absTOF_lobeWide to use the same search and tracking method as absTOF_lobe
- Bug fix
- Fixed initialization of gUssSWConfig.algorithmsConfig-posSearchRange and gUssSWConfig.algorithmsConfig-negSearchRange to be initialized based on number of samples per cycle (SignalSamplingFreqtransducer Freq)
- Removed error code USS_message_code_algorithm_error_meter_constant_calib, this message was returned if the minimum volume flow rate falls outside the lowest alphaMin calibration point. The Flow VFR will now calibrate volumeFlowRate if it is below the lowest minimumVFR without reporting an error.
- Fixed ADC capture USS Design Center packet bug
- Fixed USS_userConfig.c dependency on intrtplCorrLUT.h compilation bug
- Fixed tolerance used for USS_verifyHSPLLFrequency to estimate frequency error correctly
- Removed workaround to scale back hilbert cross threshold
- Fixed Delta TOF offset correction on DTOF value. Previously it would only impact volume flow rate calculation.
- Enhancements
- Library Example project
- Enhancements
- Updated while(1) loop to use new background timer synchronous measurement rate APIs
- Added UART debug to template project
- Updated memory allocation of gUSSLEARAMReservedBlock1 to be based on USS_ALG_DTOF_WINDOWING_MODE configruation.
- Bug Fix:
- None.
- Enhancements
- MSP430FR604X USS Water Demo
- Enhancements
- Updated USS_userConfig.h based on USS SW Library 2.30.00.
- Added support for temperature estimation using ATOF.
- Added support for Flow + Temperature VFR calibration. Debug Plots 1 - 4 used.
- Updated support for Flow VFR calibration. Debug Plots 4 used.
- Added support for additional scale factor for VFR used in cases of larger pipes.
- Updated application to use background timer for accurate periodic measurements.
- Changed Design Center timer configuration from TIMER_A1 to TIMER_A2.
- Bug Fix:
- Updated USS_userConfig.h to configure algorithmsConfig->volumeCalOption = USS_Alg_volume_flow_Calculation_Option_water.
- Enhancements
Release Information
The ultrasonic design center is a one stop resource for everything related to ultrasonic sensing technology using MSP430™ microcontrollers (MCUs). It includes tools, graphical user interface (GUI), documentation, software library and application examples for developers to get started with project developments. The ultrasonic design center GUI is a rapid development tool for configuring and customizing various parameters related to transducers, pipe size as well as analyzing and capturing waveforms.