diff --git a/docs/img/Sonar-3D-15-advanced-settings-download-diagnostic-log.png b/docs/img/Sonar-3D-15-advanced-settings-download-diagnostic-log.png new file mode 100644 index 00000000..1b1ea3ad Binary files /dev/null and b/docs/img/Sonar-3D-15-advanced-settings-download-diagnostic-log.png differ diff --git a/docs/img/Sonar-3D-15-config-acoustics.png b/docs/img/Sonar-3D-15-config-acoustics.png new file mode 100644 index 00000000..af5edcdb Binary files /dev/null and b/docs/img/Sonar-3D-15-config-acoustics.png differ diff --git a/docs/img/Sonar-3D-15-config-advanced-firmware.png b/docs/img/Sonar-3D-15-config-advanced-firmware.png new file mode 100644 index 00000000..7c3171ca Binary files /dev/null and b/docs/img/Sonar-3D-15-config-advanced-firmware.png differ diff --git a/docs/img/Sonar-3D-15-config-advanced-update-rate.png b/docs/img/Sonar-3D-15-config-advanced-update-rate.png new file mode 100644 index 00000000..1e3a9a75 Binary files /dev/null and b/docs/img/Sonar-3D-15-config-advanced-update-rate.png differ diff --git a/docs/img/Sonar-3D-15-config-advanced.png b/docs/img/Sonar-3D-15-config-advanced.png new file mode 100644 index 00000000..83e8b1dc Binary files /dev/null and b/docs/img/Sonar-3D-15-config-advanced.png differ diff --git a/docs/img/Sonar-3D-15-config-mounting-angle-3d-view.png b/docs/img/Sonar-3D-15-config-mounting-angle-3d-view.png new file mode 100644 index 00000000..bec82c73 Binary files /dev/null and b/docs/img/Sonar-3D-15-config-mounting-angle-3d-view.png differ diff --git a/docs/img/Sonar-3D-15-config-mounting-angle.png b/docs/img/Sonar-3D-15-config-mounting-angle.png new file mode 100644 index 00000000..2c88966b Binary files /dev/null and b/docs/img/Sonar-3D-15-config-mounting-angle.png differ diff --git a/docs/img/Sonar-3D-15-config-page.png b/docs/img/Sonar-3D-15-config-page.png new file mode 100644 index 00000000..6aa5777e Binary files /dev/null and b/docs/img/Sonar-3D-15-config-page.png differ diff --git a/docs/img/Sonar-3D-15-enable-acoustics.png b/docs/img/Sonar-3D-15-enable-acoustics.png new file mode 100644 index 00000000..687cb7af Binary files /dev/null and b/docs/img/Sonar-3D-15-enable-acoustics.png differ diff --git a/docs/img/Sonar-3D-15-sidebar-config.png b/docs/img/Sonar-3D-15-sidebar-config.png new file mode 100644 index 00000000..9ba554e4 Binary files /dev/null and b/docs/img/Sonar-3D-15-sidebar-config.png differ diff --git a/docs/sonar-3d/sonar-3d-15-config.md b/docs/sonar-3d/sonar-3d-15-config.md new file mode 100644 index 00000000..f614dd55 --- /dev/null +++ b/docs/sonar-3d/sonar-3d-15-config.md @@ -0,0 +1,122 @@ +# Settings - Sonar 3D-15 + +## Introduction + +A selection of different configurable settings to adjust and fine tune your experience with the Sonar 3D-15. + +![Config link](../img/Sonar-3D-15-config-page.png) + +Access the configuration settings page from the "Settings" sidebar from the main page and following the "Config" link. + +![Config link](../img/Sonar-3D-15-sidebar-config.png) + +### Acoustics + +Toggle whether or not to enable the Sonar to send acoustic signals. The 3D point cloud can only be shown when this is enabled. + +![Acoustics](../img/Sonar-3D-15-config-acoustics.png) + +!!! Important + Ensure that the Sonar is under water before enabling acoustics, to avoid interference with objects and infrastructure around you. + +Acoustics are disabled when the Sonar first boot. You'll see a message in the 3D view about enabling this. + +![Acoustics](../img/Sonar-3D-15-enable-acoustics.png) + +### Network + +Set how the Sonar 3D-15 is assigned an IP on your network: Automatic IP (DHCP) or Static IP. Default is Automatic IP. For further details regarding network setup, [see Networking](/Sonar-3d/Sonar-3d-15-networking/). + +!!! Note + Saved Network Settings are persistent, meaning it is kept on restart. + +### Time + +Set how the Sonar acquires date and time, NTP Server og Use Computer Time. Default is NTP server (automatically get time sync from the Internet). + +!!! Note + Using computer time is only valid until the next restart of the Sonar. Saved Time Settings are persistent, meaning it is kept on restart. + +### Speed of Sound + +Change the speed of sound to reflect the surroundings of the Sonar. Default is **1491 m/s**, the approximate speed of sound in 5-10°C ocean water at 5 meters depth. When using custom speed, the speed must be between 1000 and 2000 m/s. + +### Mounting angle + +Adjust how the Sonar is mounted on your vehicle / ROV. Valid values are from -90° (downwards) to 90° (upwards). Default mounting angle is 0° (straight ahead). + +!!! Note + Mounting angle is only stored locally in your browser and not persisted if you access the Sonar GUI from a different browser or device. + +![Mounting Angle](../img/Sonar-3D-15-config-mounting-angle.png) + +Changing this value will affect how the default rotation of the vision cone and Sonar model is shown in the 3D view. + +![3D point cloud view cone](../img/Sonar-3D-15-config-mounting-angle-3d-view.png) + +### About this Sonar + +Displays various version and hardware readouts from your Sonar. The changelog can also be accessed from here (or by clicking the version number in the footer of any other page). + +The changelog only shows the latest changes for the firmware version currently installed. Use the [firmware upgrader](#firmware) to see if there are newer versions available. + +## Advanced + +Various advanced settings related to maintenance and troubleshooting the Sonar 3D-15. Toggle the display of these settings by clicking the "Show / Hide" button. + +![Advanced Settings](../img/Sonar-3D-15-config-advanced.png) + +### Blink + +Toggle blinking of the Sonar's LED. The LED on the front of the Sonar blinks green for a set duration of time before turning off, confirming connection and operational status. + +### Restart + +Restarts the Sonar. Restarts usually take between 30 seconds to a minute to complete. + +!!! Note + Some settings are preserved on restart. These are Network, Time and Integration API settings. Other settings may need to be set again after restart. See each respective section for further details. + +### Firmware + +Allows for upgrading the Sonar's firmware. Click the button to open a new tab to the firmware updater. + +![Upgrade firmware](../img/Sonar-3D-15-config-advanced-firmware.png) + +The firmware upgrader allows for automatically checking and upgrading the Sonar firmware if neccessary. This requires a working Internet connection to work. Alternatively, an offline (manual) upgrade can be used. [Read more about offline firmware upgrades](/sonar-3d-15-software-update/#offline-software-update). + +If needed, follow the steps to complete the upgrade. Upon completion, the Sonar will reset all settings back to factory default and restart. Firmware upgrade can take a couple of minutes. + +!!! Important + Keep the Sonar submerged in water to ensure a proper operational temperature during upgrade. Failure to do so may render your Sonar in an inoperable state. + +### Download Diagnostics + +Generates a diagnostic log for Water Linked to assist in diagnosing issues. + +![Download diagnostic log](../img/Sonar-3D-15-advanced-settings-download-diagnostic-log.png) + +Click the "Prepare download" button and ensure that the Sonar is submerged in water. Provide a detailed description of the issue in the text box and click "Download". + +!!! Important + The front of the Sonar should be 0.5m to 2m away from any wall or solid object to ensure ideal conditions before creating a diagnostic log. + +Submit a [support ticket](https://waterlinked.com/support) and attach the diagnostic log you just downloaded. + +### Integration API + +Change how the Sonar transmits data and at what address the integration API is available from. Options are Disabled, Multicast (Default) and Unicast. [Read more about the Integration API](/sonar-3d/sonar-3d-15-api). + +### Update Rate + +Toggle the display of an update graph overlay in 3D view which shows how fast data is being received from the Sonar. The graph displays the last 10 seconds of updates along with an average frame rate. The graph can be toggled in the 3D view. + +![Update rate graph](../img/Sonar-3D-15-config-advanced-update-rate.png) + +### Factory Reset + +Reset all settings to factory defaults and restarts the Sonar. A confirmation is required before initiating a factory reset. + +### Connection events + +Troubleshoot WebRTC connection issues between the GUI and the Sonar backend. These events relate to the UIs ability to communicate with the Sonar to establish the video streams, connection to the API, read system status and so on. diff --git a/docs/sonar-3d/sonar-3d-15-faq.md b/docs/sonar-3d/sonar-3d-15-faq.md index 1320930e..afab4a2c 100644 --- a/docs/sonar-3d/sonar-3d-15-faq.md +++ b/docs/sonar-3d/sonar-3d-15-faq.md @@ -42,4 +42,4 @@ For advanced integrations, you can use the Sonar 3D-15’s API to develop custom --- ## 6. The performance is not as expected? -If the performance is not as expected and you can not find a solution in this documentation, please create a diagnostic log with you Sonar 3D-15 and submit a [support ticket](https://waterlinked.com/support) with the Sonar 3D diagnostic log file attached. \ No newline at end of file +If the performance is not as expected and you can not find a solution in this documentation, please create a diagnostic log with your Sonar 3D-15 and submit a [support ticket](https://waterlinked.com/support) with the Sonar 3D diagnostic log file attached. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index d093750e..dfbcfb56 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -43,6 +43,7 @@ nav: # - BlueROV2: sonar-3d/sonar-3d-15/sonar-3d-15-bluerov-integration.md - API: sonar-3d/sonar-3d-15-api.md - Software Updates: sonar-3d/sonar-3d-15-software-update.md + - Settings: sonar-3d/sonar-3d-15-config.md - Networking: sonar-3d/sonar-3d-15-networking.md - FAQ: sonar-3d/sonar-3d-15-faq.md