MSP430 USS Library  01_30_00_04

Release Notes 

Introduction

ADD MSP430 USS LIBRARY INTRODUCTION

This document is divided into the following sections:

• Documentation
• What's New
• Revision History
  
• Installation and Usage
• Device Support
  
• Peripheral Support
• Dependencies
• Validation Information
• Upgrade and Compatibility Information
• Examples
  
• Known Issues
  
• Versioning
• Technical Support and Product Updates

Documentation

What's New

• USS SW Library:
  • Bug Fix:
    • Fixed USS_calibrateIDAC API.
      • Enhanced API to allow API to timeout
      • Added new USS_message_code_Calibration_DAC_timeout_error error message
    • Fixed bug where SDHS DTCDA got corrupted after running USS_verifyHSPLLFrequency API
  • Enhancement:
    • Implemented FIR filtering of UPS and DNS samples which is controlled via enableFilter parameter
    • Added new configuration parameter to USS_Algorithms_User_Configuration structure
      • _iq27 clockRelativeError
      • uint32_t winNumCycles
      • bool enableFilter
      • uint16_t filterLength
      • int16_t *filterCoeffs
    • Added new API USS_updateClockRelativeError used to update clockRelativeError during runtime.
    • Added new USS_message_code:
      • "USS_message_code_algorithm_error_invalid_clock_relative_error"
      • "USS_message_code_algorithm_error_invalid_filter_length"
    • Updated volumeScaleFactor description to include expexted max and min values.
• USS GUI demo project:
  • Enhancement:
    • Added filter coefficients for four different sampling frequencies and an option to define custom filter
      • 3.4 MHz
      • 3.6 MHz
      • 3.8 MHz
      • 4.0 MHz
    • Added option to enabled Automatic Gain Control (AGC) of UPD and DNS singals. (This option is off by default)
    • Added option to enabled correction term for AbsToF estimate as a function of the calibrated resonator frequency as a function of LFXT. (This option is on by default)

Revision History

01_20_00_14

• USS SW Library:
  • Bug Fix:
    • Renamed USS_HSPLL_Configuration member from ussXTALsettlelingCount to ussXTALsettlingCount
  • Enhancement:
    • Updated library to use default excitation bias of 0.4V nominal.
    • Updated driverlib to version 2_91_00_20.
    • Recompiled library and validated example projects with SP_CCS_MSP430FR6047-Windows-2016-12-15T12-32 and SP_IAR_MSP430FR6047-Windows-2016-12-15T12-32.
• USS GUI demo project:
  • Enhancement:
    • Updated USS GUI example to Design Center based project.
    • Enabled LCD functionality on EVM.

01_20_00_13

• USS GUI demo project:
  • Enhancement:
    • Updated project to use USS_highFlow_option_version2 by default.
    • Reduced USS_ALG_ABS_TOF_INTERVAL from 100 to 1
• USS SW Library:
  • Enhancement:
    • Added support for a second computation option for high flow (>5gpm) using absTOF measurements for cycle slip correction.
    • Updated USS_Algorithms_User_Configuration structure. enableHighFlow bool flag in structure has been replace for enum highFlowOption. User can now select USS_highFlow_option_disabled, USS_highFlow_option_version1 or USS_highFlow_option_version2 via enum
    • Updated template example project to use USS_highFlow_option_version2 by default

01_20_00_12

• USS GUI demo project:
  • Enhancement:
    • Updated project to use ussXTALsettlelingCount configuration parameter
• USS SW Library:
  • Enhancement:
    • Added support to specify USSXTAL settling time via a new parameter ussXTALsettlelingCount in USS_HSPLL_Configuration configuration structure.
    • Added error code USS_message_code_HSPLL_invalid_settling_count_error. This error is returned if ussXTALsettlelingCount is set to 0.
    • Updated template example project to use ussXTALsettlelingCount parameter

01_20_00_11

• USS GUI demo project:
  • Bug Fix:
    • Demo stopped sending ADC waveform after a reset.
  • Enhancement:
    • Check reset source and log fault if the source is unexpected (different from BOR or RST).
    • Enabled Watchdog reset.
• USS SW Library:
  • Bug Fix:
    • UPS/DNS signals are lost if transducers are not connected the first time USS_runAlgorithms is called.

01_20_00_10

• Updated description for pulseLowPhasePeriod and pulseHighPhasePeriod.
• Updated description USS_runAlgorithmsFixedPoint, USS_runAlgorithms, and USS_startLowPowerUltrasonicCapture.
• Updated description USS_calibrateSignalGain API.
• Enabled accumulation and scaling of UPS/DNS captures. This functionality is enable via #define USS_SW_LIB_ENABLE_ACCUMULATION parameter in USS_userConfig.h
• Enabled resizing of LEA capture buffers using #define USS_SW_LIB_APP_MAX_CAPTURE_SIZE macro in USS_userConfig.h
• Updated library to define LEA RAM buffers outside of the library via USS configuration file. Current maximum UPS/DNS capture size is 620 without accumulation and 372 with accumulation enabled. Maximum capture size can be reduced to free up LEA memory.
• Fixed incorrect propagation delay configuraton.
• Renamed USS_Meter_Configuration *meterCofig; to USS_Meter_Configuration *meterConfig; in ussSwLib.h
• Added support for high flow rate
  • Added the following members to Algorith Configuration structure:enableHighFlow, cycleSlipThreshold, thresholdX1X3
• Updated CCS linker command file to allow placing algorithm function in RAM. This is enabled by removing comments on #define __USS_RUN_ALG_FROM_RAM__ in lnk_msp430fr6047.cmd

01_20_00_09

• Updated description for pulseLowPhasePeriod and pulseHighPhasePeriod.
• Updated description USS_runAlgorithmsFixedPoint, USS_runAlgorithms, and USS_startLowPowerUltrasonicCapture.
• Updated description USS_calibrateSignalGain API.
• Enabled accumulation and scaling of UPS/DNS captures. This functionality is enable via #define USS_SW_LIB_ENABLE_ACCUMULATION parameter in USS_userConfig.h
• Enabled resizing of LEA capture buffers using #define USS_SW_LIB_APP_MAX_CAPTURE_SIZE macro in USS_userConfig.h
• Updated library to define LEA RAM buffers outside of the library via USS configuration file. Current maximum UPS/DNS capture size is 620 without accumulation and 372 with accumulation enabled. Maximum capture size can be reduced to free up LEA memory.
• Fixed incorrect propagation delay configuraton.
• Renamed USS_Meter_Configuration *meterCofig; to USS_Meter_Configuration *meterConfig; in ussSwLib.h
• Added support for high flow rate
  • Added the following members to Algorith Configuration structure:enableHighFlow, cycleSlipThreshold, thresholdX1X3
• Updated CCS linker command file to allow placing algorithm function in RAM. This is enabled by removing comments on #define __USS_RUN_ALG_FROM_RAM__ in lnk_msp430fr6047.cmd

01_20_00_08

• Integrated optimized algortihms version 0_50_10_01
• Removed algorithn object from Library algorihtm object
• Updated USS_initAlgorithms to only require pointer to library configuration structure
• Increased capture buffer size from 400 to 500
• Removed elements from Algorithm configuration structure
• Added new APIS USS_getUPSPtr, USS_getDNSPtr, USS_setUPSPtr, USS_setDNSPtr
• Updated USS_initAlgorithms to force initialization of Algorithm object
• Updated documentation
• PEPTO results can be found ">here.

01_20_00_07

• Fixed JIRA bugs:
  • MSPUSSLIB-34
  • MSPUSSLIB-17
  • MSPUSSLIB-37
  • MSPUSSLIB-35
  • MSPUSSLIB-41
• Implemented USS_startLowPowerUltrasonicCapture API
• Evaluation of the non integer sampling freq and transducer freq fixed point implementation.
• Fixed minor bug impacting the first capture.
• Increased capture buffer size from 200 to 400.
• PEPTO results can be found here.
• Rebuild library using FR6047 SP v2016-10-26T12-43

01_10_08_03

• Fixed JIRA bugs:
  • MSPUSSLIB-18
  • MSPUSSLIB-20
  • MSPUSSLIB-21
  • MSPUSSLIB-24
  • MSPUSSLIB-25
  • MSPUSSLIB-26
  • MSPUSSLIB-27
  • MSPUSSLIB-28
• PEPTO results can be found here.
• Rebuild library using FR6047 SP v2016-10-26T12-43

1_10_05_03

• Fixed JIRA bugs:
  • MSPUSSLIB-15
  • MSPUSSLIB-16
• PEPTO results can be found here.
• Rebuild library using FR6047 SP v2016-10-13T10-02

1_10_03_00

PLL Output frequnecy configuration paramter is now configured as an enumeration Refere to example configuration file to full list of User configuration file changes. Fixed API name type "convertion" to "conversion" Know issues IAR example project will throw a compilation error when invoking USS_runAlgorithms

USS Sw Library API UG documetation was updated.

1_10_00_00

• USS_calibrateGain
• USS_calculateDCOffset
• USS_startLowPowerUltrasonicCapture

1_00_00_05

• Updated doc/benchmarks/API_Benchmarks.docx file to match Power budget cycle count.
• Updated release notes to reflect support will be done via Bugzilla

Bug Fixes

1_00_00_04

Bug Fixes

• Incorrect data formatting in USS_Capture_Configuration

New APIs

• Added the following APIS (refer to Library API UG for implementation details):
  • USS_message_code USS_calibrateIDAC(USS_SW_Library_configuration *config);
  • USS_message_code USS_runAlgorithmsFixedPoint(USS_SW_Library_configuration *config,USS_Algorithms_Results_fixed_point *results);
  • USS_message_code USS_updateABSTOFCalculationIteration(USS_SW_Library_configuration *config);

New structures

• Added new structure USS_Algorithms_Results_fixed_point. (refer to Library API UG for implementation details)

New enumeration elements

• Added the following USS_message_code error codes (refer to API UG for more information):
  • USS_message_code_algorithm_error_invalid_iteration_value
  • USS_message_code_error_conversion_stopped_by_debugger
  • USS_message_code_algorithm_error_invalid_iteration_value
  • USS_message_code_Calibration_DAC_success
  • USS_message_code_Calibration_DAC_error
• Added USS_UUPS_Interrupt_STPBYDB enumeration field to USS_UUPS_Interrupt

New structure elements

• Added the following elements to USS_Capture_Configuration structure (refer to Library API UG for implementation details):
  • bool validMismatchDeltaValues;
  • int8_t delta1;
  • int8_t delta2;
• Added new element to USS_Algorithms_User_Configuration structure (refer to Library API UG for implementation details):
  • uint16_t absTOFIteration;

New Macro definitions

• Added new bit USS_UUPS_STOPPED_BY_DEBUGGER to USSSWLIB_USS_interrupt_status.
  • Global variable USSSWLIB_USS_interrupt_status can be used to determine if UUPS STPBYDB interrupt was fired during a USS capture.

Fixed typos

• Fixed typos on USS_message_code enumeration:
  • USS_message_code_SAPH_update_error_ongoing_convertion to USS_message_code_SAPH_update_error_ongoing_conversion
  • USS_message_code_HSPLL_update_error_ongoing_convertion to USS_message_code_HSPLL_update_error_ongoing_conversion
  • USS_message_code_SDHS_update_error_ongoing_convertion to USS_message_code_SDHS_update_error_ongoing_conversion
  • USS_message_code_UUPS_update_error_ongoing_convertion to USS_message_code_UUPS_update_error_ongoing_conversion

0_80_00_02

This version of the library is a fully functional, not power optimized version of USS SW Library.

0_00_00_06

The is a UNTESTED release of MSP430 USS SW Library.

Installation and Usage

Device Support

• MSPvsocuss

Peripheral Support

This is the 01_30_00_04 release of MSP430 USS SW Library.

Dependencies

• CCS 6.1.0
• IAR 6.30.1
• IQ MAth libraries for MSP430FR5xx/6xx. This library is added as part of the release. The template project is has has been setup to reference the library included in this release.

Validation Information

This is an Enginnering release whith initial round of library functional validation passed. In additon, intial system level validation for 4MHz sampling frequency using Lab test data were performed.

Upgrade and Compatibility Information

Examples

The examples may be built with CCS.

Known Issues

None

Versioning

This is build 01_30_00_04 of  MSP430 USS SW library.

Technical Support and Product Updates

Bugs and enhancement request will be tracked via Bugzilla. To submit a bug please use the following link Submit Bug or Enhancement request

Additional Resources

For more information, visit www.ti.com.