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

RiverSurveyor Live Software

Data collection and post processing software (Windows XP/Vista/7/8) for SonTek/YSI M9 and S5 ADPs.

Version
Status
Changes and Known Issues
4.10
Jul 2018
Allowed - Bottom Track debug filter added.
- Maximum salinity input changed from 35 ppt to 45 ppt.
- USGS screening distance disabled for an S5.
- Disabled auto-export to Matlab if there are any missed samples in a data file.
- Fixed Matlab export of large .riv and .rivr files.
-*requires firmware 4.02 or greater (firmware 4.10 recommended)
4.00
Nov2016
Required Minimum
as of 2/27/2017
-Added Quality Control Window with real-time warnings
-Added manual configuration option
-Updated program settings options
-Fixed issues with auto generated matlab files
 -*requires firmware 4.02 or greater (firmware 4.10 recommended)
3.90.50
May2016
Allowed
(prior to 2/27/2017)
-Added RSSI Base information to time series data
-Added compass alert and RSSI Base information in postprocessing
-Added software version used to collect a measurement in the system tab under system configuration
-Added a radio button for direct connect in the manual connection dialog
-Added automatic Matlab export option in the RSL software
-Added ?Site Information? in the Matlab export
-Fixed bottom extrapolation method set to ?No Slip? sometimes results in missing area and discharge data.
-Fixed ?Compass Not Responding? bug in the G3 compass calibration
-Fixed bug when switching SonTek GPS option between RTK and DGPS. Also, ensured GPS application correctly displayed
-Fixed GPS.Utc data structure in the Matlab export
-Fixed occasional issue with corrupt Matlab export
-Changed the composite tracks default to OFF
-Changed default compressed file folder location to the folder containing the data that are opened in the software
-known issue: Occasional difference in water track velocities in auto generated Matlab files. Workaround: recreate Matlab files in post processing prior to loading in QRev or other software.
-known issue: There is a 0.0008 ft (0.0002 m) difference in sensor depth and screening distance between auto generated matlab file and processed matlab file. Workaround: recreate Matlab files in post processing prior to loading in QRev or other software.
3.90
Sep2015
Allowed
(prior to 2/27/2017)
-improved communication connection options
-screening distance option can be enabled during install
-combined tablet and PC display mode options
-checks for latest firmware version upon connection
-exported .mat files included in the Compress File Utility
-known issue: Occasionally exporting a transect to Matlab format will result in a corrupted .mat that can not be loaded in matlab or USGS utilities that rely on the matlab format such as Extrap. No known way to fix corrupted .mat for those transects.
-known issue: May not be compatible with Toshiba and/or Bluesoleil Bluetooth Stack. Workaround: Uninstall 3rd party Bluetooth drivers/managers.

 -*requires firmware 3.80 or greater
3.81

Apr2015
Testing
(prior to 2/27/2017)
-Tablet Version of RSLive. Only fully tested by SonTek with Dell Venue 8 Pro
-Only runs in full screen. Cannot resize window
-Improved matlab output compatibility.
-known issue: Magnetic Declination is applied twice (or doubled) to the Heading to get the True North ADP Heading. Does not affect computations, display only.
-known issue: May not be compatible with Toshiba and/or Bluesoleil Bluetooth Stack. Workaround: Uninstall 3rd party Bluetooth drivers/managers.
 -*requires firmware 3.80 or greater
3.80

Oct2014
Testing
(prior to 2/27/2017)
(needed for use with G3 compass)
-Added ability to auto apply screening distance. In order to use this feature, the user must first install RSLive (3.80 or greater), then download the file named "usgsScreen" (right click, save as) and place that file in the RS Live program directory.
-Added SonTek File Manager (for searching files)
-Added SonTek File compression tool - creates a .zip file of measurement (does not include .mat files in zip)
-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)
-Added ability to manually specify communication settings, improving compatibility with older PCMs
-Improved compass calibration feedback for ADCPs with G3 compass
-Added ability to plot time series of compass % magnetic error (G3 compass required)
-Added compass alerts during data collection for both: 1. Pitch/roll exceeds range during calibration and 2. Magnetic error > 3.5% from error magnetic error in calibration score
-Added marks on time-series for samples where compass alerts were raised
-Added option for for default screening distance - requires an addition text file be placed in the RSLive program directory
-Added transmit length and blanking distance to matlab output
-Added instrument serial number to compass calibration file
-Changed color map display in plots
-Fixed F5 button press issues
-known issue: High CPU usage when running with com port available but not connected.
-known issue: May not be compatible with Toshiba and/or Bluesoleil Bluetooth Stack. Workaround: Uninstall 3rd party Bluetooth drivers/managers.
-Note: when using with bluetooth PCM's recommend:
   FTDI USB-to-Serial Drivers 2.08.30 or greater
   Parani SD1000 firmware 2.0.8 or greater
   Parani SD1000U firmware 2.0.3 or greater
(Dip switches to left: SW Config with HW Flow Control: Off)
-*requires firmware 3.80 or greater
3.70

Sept2013
Testing
(prior to 2/27/2017)
-support for new PCMs
-new unified connection dialog
-known issue: Use of F5 shortcut will occasionally result in skipping to wrong step during data collection. Workaround: Use button on screen instead of F5 to start/stop pinging and edges.
-known issue: Users of this software/firmware combination and Bluetooth PCMs have reported multiple communication issues. If testing with Bluetooth PCMs, for best results, make sure to have firmware and drivers recommended below.  If testing in the field, the user should have the ability to use previous firmware and software in case of communication failure.
-recommend FTDI USB-to-Serial Drivers 2.08.30 or greater
-recommend Parani SD1000 firmware 2.0.8 or greater
-recommend Parani SD1000U firmware 2.0.3 or greater
-known issue: May not be compatible with Toshiba and/or Bluesoleil Bluetooth Stack. Workaround: Uninstall 3rd party Bluetooth drivers/managers.
-*requires firmware 3.50 or greater
3.60

Feb2013
Allowed
(prior to 2/27/2017)
-Data Summary Report now reports Total Area, Mean Velocity, Mean Weighted Gage Height, and Total Q to three significant digits under Discharge Results
-Data Summary and ASCII reports now display the Max Speed and Max Depth under Discharge Results. These reported values represent the entire set of the loaded transects; not an individual transect.
-Support for GPS sold with M9/S5 units shipped after Feb 2013
-known issue: When LC or SM is used as track reference and composite tracks is enabled, GPS data substituted in samples with invalid BT will have moving bed corrections applied. Workaround: When using LC or SM as reference, turn composite tracks off (uncheck) for all transects. In moving bed conditions with accurate GPS data, GPS (GGA or VTG) is preferred over moving bed corrected (LC or SM) track reference. (Issue in all previous versions containing LC or SM)
-known issue: When enabling or disabling composite tracks with a moving bed corrected track reference  (LC or SM), the corrected total Q will not be recalculated until the ?Apply to all? button is pressed under ?System Settings? with the desired correction method (LC or SM) selected. Workaround: After disabling composite track (uncheck), press the  ?Apply to all? button, then switch to System Settings and with the appropriate track reference selected (LC or SM) press the ?Apply to all? button again.
(Issue in all previous versions containing LC or SM)
Note: Potential compass calibration issues remain, see: Best Practice for Calibrating SonTek RiverSurveyor M9/S5 Compass
-*requires firmware 3.00 or greater

3.50

Aug2012
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.
Note: Potential compass calibration issues remain, see: Best Practice for Calibrating SonTek RiverSurveyor M9/S5 Compass
-*requires firmware 3.00 or greater
-Set as required minimum in OSW Tech Memo 2013.04.
3.01

With Release Date:
14Oct2011
Testing
(prior to 2/27/2017)
-known issues: no-slip bottom extrapolation method uses lower x% of depth cells above side lobe. If there is not a full depth cell in the bottom x%, no bottom discharge will be estimated for the sample. Example: if there are 4 or fewer depth cells in a sample (profile) and the no-slip percentage is set to the default 20%, there will be no bottom discharge for the sample because a full cell can not be in the bottom 20%. Suggested work-around: if a no-slip method is needed for the bottom extrapolation, increase the % to use so that all samples have a estimated bottom Q.
-resolves issue (v3.00) with no-slip bottom fit percentage defaulting to zero for data files collected with prior versions.
-contains all new features listed below under version 3.00
3.00
Do Not Use
-adds CastAway CTD integration
-adds ASCII export
-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
-adds batch matlab export
-known issues: The change in profile extrapolation methods replaces the power-fit bottom x number of cells with the no-slip method. If data processed with power fit x number of cells is reprocessed in 3.00, the computed Q will remain the same until the bottom discharge method is changed. Once the method is changed, discharge can no longer be reprocessed using the power fit with x number of cells. If data files collected with prior versions are reprocessed in 3.0 and the bottom extrapolation method is changed to no-slip, the percentage of lower cells used will default to zero, resulting in no bottom Q estimated. To fix this issue, the user should change the percentage to 20. See document at this link for more details.
2.50
Allowed (prior to 9/30/2013)
-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
-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.
2.00
Allowed (prior to 9/30/2013)
-Changed side-lobe cutoff to be more conservative, which can result in different discharges when reprocessing data collected/processed with prior versions.
-Changed contour plot color scale range
-added compatibility with SmartPulseHD
-Note: Current OSW testing is with firmware 1.00 or later. It is recommended that users upgrade to at least firmware 1.00 and software 2.00
1.51
Allowed (prior to 9/30/2013)
-Updated compass calibration
1.50
Testing
-(PC) added copy graphs and tables to clipboard
-(PC) added time series window
-(PC) edges tab displays left bank and right bank instead of start edge and end edge
-(PC) added highlights to transects in summary outside of 5% of mean
-(PC) site information can be edited in post-processing
-(PC) added ability to lock transects
-(PC) added heading correction to thresholds tool to correct heading errors in individual transects
-(PC) added composite tracks threshold option to disable the use of best possible reference. The default is to still use best possible reference, must uncheck to only use BT or GPS.
-(PC) increased precision on all parameters. May cause a slight change in discharge compared to previous versions
-(Mobile) added new graphs and changed hot keys

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 recommended 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.