Merge pull request #46 from waterlinked/3D-sonar

wl-estensd · web-flow · commit 585c5a6f0ef4 · 2025-04-03T13:55:43.000+02:00
Sonar 3D-15 update
diff --git a/docs/3d-sonar/3d-sonar-15/3d-sonar-15-led.md b/docs/3d-sonar/3d-sonar-15/3d-sonar-15-led.md
diff --git a/docs/dvl/faq.md b/docs/dvl/faq.md
@@ -119,4 +119,11 @@ For more details, see [Range mode](dvl-protocol.md#range-mode-configuration). In
 
 Yes, the DVL can operate over soft bottoms. However, softer seabeds absorb more acoustic energy, which reduces the maximum altitude at which the DVL can reliably track. The degree of range reduction varies from environment to environment and may require on-site testing to determine.
 
+---
+
+## 14. I get an error when updating my DVL?
+
+Most likely your DVL is running an older software version that requires you to set the time before you can update. This is not and issue when updating from version 2.6.5
+For more software update details please see [DVL Software Updates.](sw-update.md)
+
 ---
diff --git a/docs/img/Sonar-3D-15-physical-dims-public-alpha-4x.png b/docs/img/Sonar-3D-15-physical-dims-public-alpha-4x.png
diff --git a/docs/index.md b/docs/index.md
@@ -38,7 +38,7 @@
     <!-- ROW 1: 3D Sonar, DVL A125, DVL A50 -->
     <div class="grid align">
       <div class="col-3 col-md-6 col-sm-12">
-        <a href="./3d-sonar/3d-sonar-15/3d-sonar-15-introduction/">
+        <a href="./sonar-3d/sonar-3d-15/">
           <img class="img-fluid"
                src="https://waterlinked.com/web/image/product.template/689/image_512/%5BWL-21045-2%5D%20Sonar%203D-15?unique=935e74a" />
           <br />
diff --git a/docs/sonar-3d/sonar-3d-15-api.md b/docs/sonar-3d/sonar-3d-15-api.md
@@ -1,7 +1,7 @@
 # Integration API Sonar 3D-15
 
 ## Introduction
-The **Water Linked Sonar 3D-15** provides real-time 3D views of underwater environments using a low-bandwidth **Range Image Protocol (RIP1)**. This protocol efficiently transmits data such as 3D points or grayscale bitmaps over UDP (multicast or unicast), enabling live visualization, analysis, or archival for later use.
+The **Water Linked Sonar 3D-15** provides real-time 3D views of underwater environments using a low-bandwidth **Range Image Protocol (RIP1)**. This protocol efficiently transmits data such as 3D points or grayscale bitmaps over UDP multicast, enabling live visualization, analysis, or archival for later use.
 
 ---
 
@@ -24,7 +24,7 @@ RIP1 is a compact format for range and bitmap images, designed for <10 Mbit ba
 ---
 
 ## Network
-By default, the Sonar 3D-15 uses **UDP Multicast** (`224.0.0.96:4747`), so any device on the local network can receive data without knowing the sonar’s IP. You can also configure **UDP Unicast** to send data to a specific IP/port, allowing routing outside the local network (but losing multicast discoverability).
+By default, the Sonar 3D-15 uses **UDP Multicast** (`224.0.0.96:4747`), so any device on the local network can receive data without knowing the sonar’s IP.
 
 ---
 
@@ -59,7 +59,7 @@ RIP1 supports several Protobuf-encoded messages, including:
 
 **Image**:
 
-![Pixels](../../img/Sonar-3D-15-pixel-pic.png)
+![Pixels](../img/Sonar-3D-15-pixel-pic.png)
 
 - Horizontal FOV (`fovH`) spans width.
 - Vertical FOV (`fovV`) spans height.
diff --git a/docs/sonar-3d/sonar-3d-15-bluerov-integration.md b/docs/sonar-3d/sonar-3d-15-bluerov-integration.md
diff --git a/docs/sonar-3d/sonar-3d-15-faq.md b/docs/sonar-3d/sonar-3d-15-faq.md
diff --git a/docs/sonar-3d/sonar-3d-15-gui.md b/docs/sonar-3d/sonar-3d-15-gui.md
@@ -7,7 +7,7 @@ The GUI is designed to be user friendly with a clean an intuitive set of control
 
 Below you can see the main view that you will be first presented to when accessing the Sonar 3D-15 GUI. 
 
-![Main GUI](../../img/Sonar-3D-15-gui-main-2.png)
+![Main GUI](../img/Sonar-3D-15-gui-main-2.png)
 
 1. In the middle you can see the 3d image from the Sonar 3D-15
 2. Upper left corner shows the version and a help guide by clicking the *?* mark.
@@ -21,16 +21,16 @@ Below you can see the main view that you will be first presented to when accessi
 
 Below you can see how to adjust the 3D image and some hotkeys.
 
-![Keyboard hotkey](../../img/Sonar-3D-15-keyboard-hotkeys.png)
+![Keyboard hotkey](../img/Sonar-3D-15-keyboard-hotkeys.png)
 
-![Touch hotkey](../../img/Sonar-3D-15-touch-hotkeys.png)
+![Touch hotkey](../img/Sonar-3D-15-touch-hotkeys.png)
 
 
 ## Config View
 
 Here is the general configuration page of the Sonar 3D-15.
 
-![Config GUI](../../img/Sonar-3D-15-gui-config-3.png)
+![Config GUI](../img/Sonar-3D-15-gui-config-3.png)
 
 1. Enable/disable acoustics
 2. Network config
@@ -43,7 +43,7 @@ Here is the general configuration page of the Sonar 3D-15.
 
 In the same config view you can show diagnostic views which have these feasters.
 
-![Config GUI all](../../img/Sonar-3D-15-gui-config-diagnostics-3.png)
+![Config GUI all](../img/Sonar-3D-15-gui-config-diagnostics-3.png)
 
 1. Blink LED
 2. Update firmware
diff --git a/docs/sonar-3d/sonar-3d-15-led.md b/docs/sonar-3d/sonar-3d-15-led.md
@@ -0,0 +1,10 @@
+
+# LED Sonar 3D-15
+
+The tables below shows the LED behavior of the Sonar 3D-15.
+
+| LED behavior          | Description                   |
+| :---------------------| :-----------------------------|
+| Solid green           | Sonar has power               |
+| Blinking green fast   | Sonar is in thermal shutdown  |
+<!-- | Blinking green    | Acoustics are active  | -->
diff --git a/docs/sonar-3d/sonar-3d-15-networking.md b/docs/sonar-3d/sonar-3d-15-networking.md
@@ -3,16 +3,16 @@
 The Sonar 3D-15 has several services available over ethernet:
 
 * [Multicast DNS](#multicast-dns-mdns) (mDNS) for easy discovery
-* Web [GUI](3d-sonar-15-gui.md), providing a visualization of the data collected by the Sonar 3D-15, as well as configuration, [updating of software](3d-sonar-15-software-update.md) and more.
-* UDP Multicast and Unicast [data stream](#udp-multicast-and-unicast)
-* [Software updates](3d-sonar-15-software-update.md)
+* Web [GUI](sonar-3d-15-gui.md), providing a visualization of the data collected by the Sonar 3D-15, as well as configuration, [updating of software](sonar-3d-15-software-update.md) and more.
+* UDP Multicast [data stream](#udp-multicast)
+* [Software updates](sonar-3d-15-software-update.md)
 
 
 ## Network configuration
 
 ### Multicast DNS (mDNS)
 
-The Sonar 3D-15 runs a DHCP client which will attempt to obtain an IP address from a DHCP server (e.g. in a router) on the same network, and supports mDNS: the mDNS name of the Sonar 3D-15 is `waterlinked-sonar`. On a computer which supports mDNS, one can then simply access the web [GUI](3d-sonar-15-gui.md) at [http://waterlinked-sonar](http://waterlinked-sonar).
+The Sonar 3D-15 runs a DHCP client which will attempt to obtain an IP address from a DHCP server (e.g. in a router) on the same network, and supports mDNS: the mDNS name of the Sonar 3D-15 is `waterlinked-sonar`. On a computer which supports mDNS, one can then simply access the web [GUI](sonar-3d-15-gui.md) at [http://waterlinked-sonar](http://waterlinked-sonar).
 
 !!! note
     If no DHCP server is available on the network, it is recommended to use the [fallback IP](#fallback-ip) or  configure a [static IP address](#via-the-gui), as the Sonar 3D-15 can spend up to 5 minutes searching for a DHCP server.
@@ -24,11 +24,11 @@ The Sonar 3D-15 will always be available with the static IP address: **192.168.1
 * Connect an ethernet cable directly from the Sonar 3D-15 to your computer.
 * For an/the ethernet interface of your computer, configure it to have a static IP address in the same subnet as 192.168.194.96, (e.g. 192.168.194.90) or anything else of the form 192.168.194.xxx if using a subnet of the form 255.255.255.0 (aka 192.168.194.0/24).
 * Activate the ethernet interface of your computer which you configured in the previous step.
-* In a web browser, open http://192.168.194.96 to access the web [GUI](3d-sonar-15-gui.md).
+* In a web browser, open http://192.168.194.96 to access the web [GUI](sonar-3d-15-gui.md).
 
 ### User set IP 
 
-The IP address of the Sonar 3D-15 can be configured in two ways via the web [GUI](3d-sonar-15-gui.md):
+The IP address of the Sonar 3D-15 can be configured in two ways via the web [GUI](sonar-3d-15-gui.md):
 
 * DCHP client: An IP address is obtained from a DHCP server (e.g. in a router) on the same network, as mentioned above in [mDNS](#multicast-dns-mdns).
 * Static: Configure the Sonar 3D-15 to use static IP address of your choice.
@@ -38,8 +38,8 @@ After the IP configuration of the Sonar 3D-15 is modified, the Sonar 3D-15 needs
 !!! Note
     The boot time, i.e. the time it takes from the Sonar 3D-15 receives power until it starts operating normally, will depend upon the IP configuration. Using the [fallback IP](#fallback-ip), the boot time can be as much as 1 min 30 sec, whilst it can be as low as 20 sec with a static IP.
 
-## UDP multicast and unicast
+## UDP multicast
 
-By default, the Sonar 3D-15 uses **UDP Multicast** (`224.0.0.96:4747`), so any device on the local network can receive data without knowing the sonar’s IP. You can also configure **UDP Unicast** to send data to a specific IP/port, allowing routing outside the local network (but losing multicast discoverability). Please see [API](3d-sonar-15-api.md) for more information on the data on the UDP multi/unicast.
+By default, the Sonar 3D-15 uses **UDP Multicast** (`224.0.0.96:4747`), so any device on the local network can receive data without knowing the sonar’s IP. Please see [API](sonar-3d-15-api.md) for more information on the data on the UDP multicast.
 
 
diff --git a/docs/sonar-3d/sonar-3d-15-quickstart.md b/docs/sonar-3d/sonar-3d-15-quickstart.md
@@ -11,31 +11,30 @@ Requirements:
 
 <!-- Insert video here -->
 
-## 1. Prepare
-Unbox the Sonar 3D-15 and place it in a water container (e.g., a bucket or tank). Avoid getting water on the I/O board.  
 <!-- Insert picture of Sonar in a bucket/tank -->
 
-## 2. Connect the Ethernet cable
-Plug one end of the Ethernet cable into the I/O board, and connect the other end to your computer’s Ethernet port.  
+## 1. Unbox and connect the Ethernet cable
+Unbox the Sonar 3D-15 and plug one end of the Ethernet cable into the I/O board, and connect the other end to your computer’s Ethernet port.  
 <!-- Insert image showing the I/O card and computer -->
 
-## 3. Connect a power supply
+## 2. Connect a power supply
 Connect your power supply to the I/O board. Use a power supply capable of delivering 60W (surge) at 10-30V (20+ V recommended).
 <!-- Insert image showing power supply connection -->
 
-## 4. Boot the Sonar
-Turn on your power supply. Your Sonar 3D-15 takes about 30 seconds to boot.
+## 3. Place and Boot the Sonar
+- Place the Sonar 3D-15 in a water container (e.g., a bucket or tank). Avoid getting water on the I/O board. 
+- Turn on your power supply. Your Sonar 3D-15 takes about 30 seconds to boot.
 
-## 5. Configure your computer’s IP
+## 4. Configure your computer’s IP
 Assign your computer an IP address in the `192.168.194.x` range (e.g.: `192.168.194.90` with netmask `255.255.255.0`).
 !!! Note
     *Configuring network varies between operating systems and versions. Please search the web on how to do this for your operating system. Feel free to contact us for support.*
 <!-- Insert two images side by side (Linux and Windows network config) -->
-See more details in the [Networking section.](3d-sonar-15-networking.md)
+See more details in the [Networking section.](sonar-3d-15-networking.md)
 
-## 6. Access the Sonar GUI
+## 5. Access the Sonar GUI
 Open up your web browser (e.g.: Chrome) and enter the fallback IP address `192.168.194.96`. You should now be able to see and use the Sonar 3D-15 GUI.
 <!-- Insert an image showing the browser with IP address -->
 
 ## Need help?
-Check out the [FAQ!](3d-sonar-15-faq.md)
+Check out the [FAQ!](sonar-3d-15-faq.md)
diff --git a/docs/sonar-3d/sonar-3d-15-software-update.md b/docs/sonar-3d/sonar-3d-15-software-update.md
@@ -51,5 +51,5 @@ After completion, the Sonar 3D-15 will reboot with the new software version.
 
 ---
 
-If you have any questions or run into issues, please consult the release notes  and check out the [Sonar 3D-15 FAQ](../3d-sonar-15/3d-sonar-15-faq.md) or contact our support team.
+If you have any questions or run into issues, please consult the release notes  and check out the [Sonar 3D-15 FAQ](sonar-3d-15-faq.md) or contact our support team.
 
diff --git a/docs/sonar-3d/sonar-3d-15-wiring.md b/docs/sonar-3d/sonar-3d-15-wiring.md
diff --git a/docs/sonar-3d/sonar-3d-15.md b/docs/sonar-3d/sonar-3d-15.md
@@ -5,15 +5,15 @@
 
 
 <!-- Insert image of 3d sonar below -->
-<div style="text-align: center;">
-  <img src="../../../img/Sonar 3D-15-handheld-2.png" alt="Sonar 3D 15" width="500" />
-</div>
+<!-- <div style="text-align: center;">
+  <img src="../../img/Sonar-3D-15-physical-dims-public-alpha-4x.png" alt="Sonar 3D 15" width="500" />
+</div> -->
 <!-- ![Sonar 3D 15](../../img/Sonar 3D-15-handheld-2.png) -->
 
 
 ## Dimensions
 
-![Sonar 3D 15 Dimensions](../../img/Sonar-3D-15-dimensions_2.png)
+![Sonar 3D 15 Dimensions](../img/Sonar-3D-15-physical-dims-public-alpha-4x.png)
 
 The cable can be bent as shown in the image up to 90 degrees without causing any damage. 
 
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -30,22 +30,21 @@ markdown_extensions:
 
 extra_css:
   - css/extra.css
-
 nav:
   - Home: index.md
-  - Sonar 3D-15: 
-      - Introduction: 3d-sonar/3d-sonar-15/3d-sonar-15-introduction.md
-      - Quickstart: 3d-sonar/3d-sonar-15/3d-sonar-15-quickstart.md
+  - Sonar 3D-15:
+      - Introduction: sonar-3d/sonar-3d-15.md
+      - Quickstart: sonar-3d/sonar-3d-15-quickstart.md
       - Interface: 
-        - Wiring: 3d-sonar/3d-sonar-15/3d-sonar-15-wiring.md
-        - LED: 3d-sonar/3d-sonar-15/3d-sonar-15-led.md
-        - GUI: 3d-sonar/3d-sonar-15/3d-sonar-15-gui.md
+        - Wiring: sonar-3d/sonar-3d-15-wiring.md
+        - LED: sonar-3d/sonar-3d-15-led.md
+        - GUI: sonar-3d/sonar-3d-15-gui.md
       - Integration:
- #       - BlueROV2: 3d-sonar/3d-sonar-15/3d-sonar-15-bluerov-integration.md
-         - API: 3d-sonar/3d-sonar-15/3d-sonar-15-api.md
-      - Software Updates: 3d-sonar/3d-sonar-15/3d-sonar-15-software-update.md
-      - Networking: 3d-sonar/3d-sonar-15/3d-sonar-15-networking.md
-      - FAQ: 3d-sonar/3d-sonar-15/3d-sonar-15-faq.md
+ #       - 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
+      - Networking: sonar-3d/sonar-3d-15-networking.md
+      - FAQ: sonar-3d/sonar-3d-15-faq.md
 
   - Underwater GPS:
       - G2:
