Link to USGS home USGS Home
Contact USGS
Search USGS
USGS Hydroacoustics

RiverSurveyor M9 and S5 Firmware

Firmware for SonTek/YSI M9 and S5 ADPs. You must contact SonTek/YSI for firmware upgrades.

Changes and Known Issues

Aug 2018
Required Minimum
as of 8/21/2018
-Fixed Date/Time reset bug that caused the date to reset to January 2005

Required Minimum
(2/27/2017 - 8/21/2018)
-Recorder improvements to accommodate multiple memory card types and minimize potential data loss

(prior to 2/27/2017)
-CPU Optimization
-Added support for new factory test procedures
-Accomidates component change in new units
-*requires RiverSurveyor Live 3.9.50 or later

(prior to 2/27/2017)
-Provides for M9/S5 factory test procedure changes to improve the beam angle calibration.
-All new and repaired M9/S5 systems will ship with this firmware.
-Change does not affect data collection.
-Systems running firmware v3.80 do not need to be updated to v3.91.
-*requires RiverSurveyor Live 3.80 or later

(prior to 2/27/2017)
Communication startup baud rate has been fixed at 57600. The change does not affect data collection. Systems running firmware v3.80 do not need to be updated to v3.81.
-*requires RiverSurveyor Live 3.80 or later

(prior to 2/27/2017)
(needed for use with G3 compass)
-Added support for G3 compass (new units shipped from SonTek after Oct 13 2014 or units that have been returned to SonTek for G3 compass update)
-*requires RiverSurveyor Live 3.80 or later

(prior to 2/27/2017)
-added support for new PCM

Required Minimum
(9/30/2013 - 2/27/2017)
-new compass calibration interface
-updated loop method algorithms
-fixed no-slip bottom extrapolation method so that it will now use the last good cell if there are no good cells in the lower x% of the depth cells above side lobe.
-resolved "compass not responding" issue
-resolved the issue with Start profiling taking too long when there are many files on the recorder
Note: Potential compass calibration issues remain, see: Best Practice for Calibrating SonTek RiverSurveyor M9/S5 Compass
-*requires RiverSurveyor Live 3.50 or later
-Set as required minimum in OSW Tech Memo 2013.04.
(prior to 2/27/2017)
-improved bottom-track algorithm
-adds CastAway CTD integration
-adds compatibility for GPS compass sensors
-adds new "SmartPage" step-by-step setup guide
-adds built-in SMBA stationary moving-bed processing
-adds test results stored in measurement data files
-adds additional extrapolation methods, including 3-point slope and no-slip
-adds auto edge
-*requires RiverSurveyor Live 3.00 or later
Allowed (prior to 9/30/2013)
know issue: large numbers of transects (>150-200) stored in ADCP memory can result in communications problems. To avoid this issue, routinely format recorder after data is downloaded and backed-up. This issue is also in all previous versions.
-adds dual data recording to PC or handheld and on ADCP for moving-boat measurements. Limits the need for downloading from recorder to only when there are communications issues during data collection.
-adds Loop Correction moving-bed method built into software and firmware.
-allows user entered temperature and speed of sound corrections
-*should also upgrade software to RiverSurveyor Live 2.50
-Note: Current OSW testing is with firmware 1.00 or later. It is recommended that users upgrade to at least 1.00. There are no know issues to keep users from upgrading to firmware 1.50 and taking advantage of the new features.
Allowed (prior to 9/30/2013)
-adds compatibility with newer SonTek supplied Bluetooth PCM boxes. Identified by their new FCC ID, S7APARANIESD1XXV2
-*requires RiverSurveyor Live 2.00 or later
-Note: Current OSW testing is with firmware 1.00 or later. It is recommended that users upgrade to at least 1.00
Allowed (prior to 9/30/2013)
-changes only for production, should function the same as 1.00
-*requires RiverSurveyor Live 2.00 or later
-added SmartPulseHD adaptive acoustic pulse scheme algorithm
-enhanced low-velocity capability
-improved bottom-depth/shallow-water performance
-improved compass initialization
-*requires RiverSurveyor Live 2.00 or later
Allowed (prior to 9/30/2013)
-improved compass calibration
-fixed issue with screening distance and salinity not stored in data file properly
-fixed issue with data collection being started properly if the system time was set prior to the current time
-*requires RiverSurveyor Live 1.51 or later
-known issue: occasional compass initialization problems
-Note: Current OSW testing is with firmware 1.00 or later. It is recommended that users upgrade to at least 1.00


Software/Firmware Status Definitions

Required Minimum: Minimum version required. This version has proven stable and may contain enhancements that are significant over previous required versions

Recommended: Shown to have been reliable and contains features that result in a recommend upgrade over the required version. There could be a few specific use cases where this version may have issues that would result in some users not using this version. If so, those cases will be noted.

Allowed*: Deemed reliable during initial testing. Any issues will be noted along with improvements available over prior versions. Use of allowed versions may be desired in cases when the changes benefit a significant number of the user's conditions or equipment. For example: a new version of software is released that adds support for new hardware. If the user has this hardware, they would need to upgrade to the newer software before it becomes recommended or required. Use of these versions by experienced users will also help OSW identify any unknown issues.

Testing*: OSW is currently testing; any known issues or advantages over prior release will be noted. The use of a version that is in testing should usually be limited to advanced users that can trouble shoot potential issues and provide feedback on any irregularities or problems observed.

Do Not Use: A version either prior to the required minimum or that contains issues that significantly affect operations.

*Note: A version may remain in Allowed or Testing indefinitely. Example: A new version is released while the prior version is still in Testing. In this case the prior version may remain in Testing, while future testing efforts are placed on the newer version.

Return to Moving-Boat Deployment - Software and Firmware

Links to the manufacturer's software and firmware are provided primarily as a service for USGS users. However, in some cases, access has also been provided for other agencies with the manufacturer's permission. Software or firmware without a direct download link should be obtained from the manufacturer.