Merge pull request #84 from waterlinked/dev_thilo

thilo-huck · web-flow · commit adad85f210f2 · 2025-12-05T14:17:58.000+01:00
First restructure of the Sonar Manual
diff --git a/docs/css/extra.css b/docs/css/extra.css
@@ -114,6 +114,16 @@
   margin-right: auto;
 }
 
+/* Dark green for buttons */
+.md-button {
+  background-color: #2B9C6A;
+}
+
+/* Ocean Blue for links */
+a {
+  color: #1D3556;
+}
+
 @media (max-width: 1280px) {
   .col-xl-12,
   .col-xl-11,
diff --git a/docs/dvl/faq.md b/docs/dvl/faq.md
@@ -36,7 +36,7 @@ A great setup for lab work is to keep the DVL submerged in a small bucket of wat
 We realize it may be impractical to avoid air usage altogether when the DVL is mounted. One option is to disable the DVL’s acoustics while it is out of water to reduce heating. This option is available under **Configuration** in the DVL GUI.
 
 !!! Note
-    If you do use the DVL in air, we strongly recommend running software version 2.0.8 or higher, which allows the DVL to shut down safely if it reaches a critical temperature.
+    If you do use the DVL in air, we strongly recommend running software version 2.0.8 or higher so the DVL can shut down safely if it overheats. See [FAQ #9](#9-can-the-dvl-overheat) for shutdown behavior.
 
 ---
 
@@ -75,7 +75,7 @@ If you notice periodic data dropouts or lost connections, there are a few common
 
 3. **Thermal Shutdown**  
 
-    - To protect the DVL from damage due to overheating, it may shut down automatically. This will result in a lost connection until it cools and restarts.
+    - If the DVL overheats it will shut down and drop the link until it cools and restarts. See [FAQ #9](#9-can-the-dvl-overheat) for details on thresholds and restarts.
 
 ---
 
@@ -124,4 +124,9 @@ Yes, the DVL can operate over soft bottoms. However, softer seabeds absorb more
 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)
 
----
+---
+
+## 15. How should I maintain the DVL?
+After operating in seawater, brackish water, chlorinated pools, or any medium other than freshwater, rinse the DVL thoroughly with fresh water to remove residues and salt deposits. Once dry, wipe the exterior with a clean, dry cloth. Avoid solvents or abrasive cleaners.
+
+---
diff --git a/docs/img/Drawing_for_IO_board_rev6.png b/docs/img/Drawing_for_IO_board_rev6.png
diff --git a/docs/img/Sonar-3D-15-FOV-Visualization.png b/docs/img/Sonar-3D-15-FOV-Visualization.png
diff --git a/docs/img/Sonar-3D-15-grip.png b/docs/img/Sonar-3D-15-grip.png
diff --git a/docs/img/Sonar-3D-15-side.png b/docs/img/Sonar-3D-15-side.png
diff --git a/docs/index.md b/docs/index.md
@@ -40,7 +40,7 @@
       <div class="col-3 col-md-6 col-sm-12">
         <a href="./sonar-3d/sonar-3d-15/">
           <img class="img-fluid"
-               src="https://www.waterlinked.com/web/image/product.template/689/image_512/%5BWL-21045-2%5D%20Sonar%203D-15?unique=935e74a" />
+               src="https://www.waterlinked.com/web/image/product.product/919/image_1024/%5BWL-21045-2%5D%20Sonar%203D-15?unique=6f5242e" />
           <br />
           <h4>Sonar 3D-15</h4>
         </a>
diff --git a/docs/io-interface-cards/io-interface-rev4.md b/docs/io-interface-cards/io-interface-rev4.md
@@ -6,7 +6,7 @@ There currently exists three revisions of the I/O Interface. Revision 2 and 3 ar
 
 ### Revision 4
 
-![I/O_Interface_rev4](../../img/WL-31014-4_IO_Interface_connections.png)
+![I/O_Interface_rev4](../img/WL-31014-4_IO_Interface_connections.png)
 
 Dimensions: 50.6 x 47 x 18.6 mm (Width x Height x Thickness)
 
diff --git a/docs/io-interface-cards/io-interface-rev6.md b/docs/io-interface-cards/io-interface-rev6.md
@@ -0,0 +1,22 @@
+##  I/O interface
+
+The I/O Interface provides a simple means of connection to Water Linked products. It provides power and connection interfaces for Water Linked sensors during development. 
+
+It utilizes the Molex Micro-Fit 3.0 power connector (Part number: 436500228). Female connectors are listed under [Mates with Part(s)](https://www.molex.com/en-us/products/part-detail/436500228#mates-with-use-with).
+
+There currently exist multiple revisions of the I/O Interface. Revision 2 and 3 are electrically identical. Revision 4 has an integrated USB-to-UART interface and a micro USB port. Revision 6 has upgraded connection options, including screw terminals and RS-232. 
+
+I/O interfaces have the part number WL-31014-X, where X is the revision number.
+
+### Revision 6
+
+![I/O Interface Revision 6](../img/Drawing_for_IO_board_rev6.png)
+
+Dimensions: 50.6 x 47 x 18.6 mm (Width x Height x Thickness)
+
+| Connector                                      | Function | Comment       |
+| ---------------------------------------------  | :------- | :------------ |
+| RJ45 (8P8C)                                    | Ethernet | 10/100 BASE T |
+| Screw Terminal or CONN HEADER VERT 3POS 2.54MM | RS 232   |               |
+| CONN HEADER VERT 3POS 2.54MM                   | UART     |               |
+| Molex Micro Fit 3.0 or 5 mm Screw Terminal     | Power    | 10 to 30 VDC  |
diff --git a/docs/sonar-3d/sonar-3d-15-api.md b/docs/sonar-3d/sonar-3d-15-api.md
@@ -72,6 +72,7 @@ RIP2 supports several Protobuf-encoded messages, including:
 ### Coordinate and Image Conventions
 **Axes** (right-handed):
 
+- **Origin**: The point cloud uses a mechanical origin located on the backplate, centered between the mounting screw holes.
 - **x**: forward  
 - **y**: right  
 - **z**: downward  
diff --git a/docs/sonar-3d/sonar-3d-15-diagnostic-log.md b/docs/sonar-3d/sonar-3d-15-diagnostic-log.md
@@ -0,0 +1,14 @@
+# How to take a Diagnostic Log
+A diagnostic log is one of the most important tools we have for helping you. 
+It allows us to:
+
+- Check the health and performance of the sonar.
+
+- Analyse the acoustic environment the sonar is operating in.
+
+- Identify issues related to noise, reflections, and installation.
+
+Submerge the Sonar 3D-15 in water and make sure the front of the Sonar 3D-15 is ideally 0.5m - 2m away from any wall or solid object. 
+
+You can acquire this in the **UI > Settings > "Go to sonar config" Button > "Diagnostics" Tab > Diagnostic Log**.
+
diff --git a/docs/sonar-3d/sonar-3d-15-electrical.md b/docs/sonar-3d/sonar-3d-15-electrical.md
@@ -0,0 +1,29 @@
+# Wiring Sonar 3D-15
+
+The tables below shows the pinning of the Sonar 3D-15 interface.
+
+| Interface         | Color         |
+| :-----------------| :-------------|
+| Negative/Ground   | Black         |
+| Positive (10-30V) | Red           |
+| ETH RX+           | Green/White   |
+| ETH RX-           | Green         |
+| ETH TX-           | Orange        |
+| ETH TX+           | Orange/White  |
+| Shielded wire     | Naked (silver)| 
+
+# IO Boards
+The Water Linked IO Board is the easiest solution for testing Water Linked Products like the Sonar 3D-15. They provide an interface for connecting Power and ethernet to the Sonar 3D-15. Read more about how to connect your IO Board to your Water Linked product under "IO-Interface Cards".
+
+# LED Sonar 3D-15
+
+The table below shows the LED behavior of the Sonar 3D-15.
+
+| LED behavior          | Description                   |
+| :---------------------| :-----------------------------|
+| No light | Power is off |
+| Solid green | Powering on |
+| Flashing green, mostly off (slow, about every second) | Power on, acoustics disabled |
+| Flashing green, mostly on (slow, about every second)  | Power on, acoustics enabled |
+| Flashing green for a few seconds | Diagnostics blink initiated from GUI or API |
+| Flashing green (fast, many times a second) | Sonar is in thermal shutdown |
diff --git a/docs/sonar-3d/sonar-3d-15-faq.md b/docs/sonar-3d/sonar-3d-15-faq.md
@@ -1,5 +1,4 @@
 # Sonar 3D-15 FAQ
-
 Below are some frequently asked questions about the Sonar 3D-15. Click on a question in the table of content to the right or simply scroll down to read the FAQ's. 
 
 ---
@@ -24,22 +23,24 @@ Yes. The Sonar 3D-15 includes an internal thermal shutdown to prevent damage to
 ---
 
 ## 4. What are the default network settings of the Sonar 3D-15?
-By default, the Sonar 3D-15 uses **DHCP** (Dynamic Host Configuration Protocol). This means it attempts to get an IP address automatically from a DHCP server on your network.
-
-However, the Sonar 3D-15 is always accessible via its **fallback IP** `192.168.194.96`, even if no DHCP server is present. To use the fallback IP, configure your computer's network interface to an IP address in the `192.168.194.x` range (e.g., `192.168.194.90`) with a netmask of `255.255.255.0`.
-
-### Can I disable DHCP and set a static IP?
-Yes, you can disable DHCP in the config settings in the GUI and specify a custom static IP address. This is helpful if you need a fixed IP in your networking environment.
+By default, the Sonar 3D-15 uses **DHCP** to request an address. If no DHCP server answers, it is always accessible on the fallback IP `192.168.194.96`. For a step-by-step guide to using the fallback IP, mDNS, or setting a static IP in the GUI, see [Sonar 3D-15 Networking](sonar-3d-15-networking.md).
 
 ---
 
 ## 5. Is any software installation required to operate the Sonar 3D-15?
 No, there is no software installation needed. Once connected and powered on, you can access the Sonar 3D-15’s built-in GUI through a standard web browser. This allows you to operate and configure the sonar without installing any additional software.
 
-### What if I need custom integration?
-For advanced integrations, you can use the Sonar 3D-15’s API to develop custom solutions. This requires some programming knowledge but enables control and automation of the Sonar 3D-15’s functionality from your custom system.
-
 ---
 
 ## 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 your Sonar 3D-15 and submit a [support ticket](https://waterlinked.com/support) with the Sonar 3D diagnostic log file attached. 
+If the performance is not as expected and you can not find a solution in this documentation, please create a [diagnostic log](../sonar-3d-15-diagnostic-log) with your Sonar 3D-15 and submit a [support ticket](https://waterlinked.com/support) with the Sonar 3D diagnostic log file attached. 
+
+---
+
+## 7. How should I maintain the Sonar 3D-15?
+After operating in seawater, brackish water, chlorinated pools, or any medium other than freshwater, rinse the unit thoroughly with fresh water to remove residues and salt deposits. Once dry, wipe the exterior with a clean, dry cloth. Avoid solvents or abrasive cleaners.
+
+---
+
+## 8. What if I need a custom integration?
+For advanced integrations, you can use the Sonar 3D-15’s API to develop custom solutions. This requires some programming knowledge but enables control and automation of the Sonar 3D-15’s functionality from your custom system.
diff --git a/docs/sonar-3d/sonar-3d-15-gui.md b/docs/sonar-3d/sonar-3d-15-gui.md
@@ -1,6 +1,6 @@
 # GUI
 
-The GUI is designed to be user friendly with a clean an intuitive set of controls.
+The GUI provides a simple no-setup solution to view the Sonar 3D-15 data and change its settings.
 
 When you first start the Sonar 3D-15 GUI you will be greeted with a view showing the 3D point cloud and various settings. To get familiar with the interface, click the ![?](../img/Sonar-3D-15-question-mark-solid-transparent-20x20.png) icon (help overlay).
 The 3D view can be controlled via mouse and keyboard, or touch controls.
@@ -9,7 +9,7 @@ The 3D view can be controlled via mouse and keyboard, or touch controls.
 ![Help overlay](../img/Sonar-3D-15-gui-help-overlay-1280-600.png)
 
 The help overlay walks you through common features of the Sonar 3D-15 GUI.
-
+<!-- 
 ![Help overlay 2](../img/Sonar-3D-15-gui-help-overlay-1280-600-2.png)
 
 
@@ -58,4 +58,4 @@ Submit a [support ticket](https://waterlinked.com/support) with the diagnostic l
 ### Update rate
 Show a data update graph as an overlay on 3D view. Useful to determine how fast data is being received from the Sonar.
 ### Factory reset
-Resets all sonar settings to factory defaults. The Sonar will also restart afterwards.
+Resets all sonar settings to factory defaults. The Sonar will also restart afterwards. -->
diff --git a/docs/sonar-3d/sonar-3d-15-introduction.md b/docs/sonar-3d/sonar-3d-15-introduction.md
@@ -0,0 +1,8 @@
+# Sonar 3D-15
+![Sonar](../img/Sonar-3D-15-side.png)
+
+The Water Linked Sonar 3D-15 is an advanced 3D multibeam imaging sonar designed to enhance underwater exploration and navigation. 
+
+With real-time 3D imaging capabilities, it provides a comprehensive view of submerged environments, even in low-visibility conditions. 
+
+
diff --git a/docs/sonar-3d/sonar-3d-15-mechanical.md b/docs/sonar-3d/sonar-3d-15-mechanical.md
@@ -0,0 +1,43 @@
+# Mechanical Integration of the Sonar 3D-15
+
+Here you should find all the information needed for a successful mechanical integration of the Sonar 3D-15 into your system.
+
+## Dimensions
+
+A detailed model (.step) of the Sonar, including the field of view, is available under [Resources](sonar-3d-15-resources.md)
+
+![Sonar 3D 15 Dimensions](../img/Sonar-3D-15-physical-dims-v3.png)
+![Sonar 3D 15 Right Side View](../img/Sonar-3D-15-side-right.png)
+The cable can be bent as shown in the image up to 90 degrees without causing any damage.
+![Sonar 3D 15 Back Dim](../img/Sonar-3D-15-back.png)
+
+
+
+## Field of view
+
+![Sonar 3D 15 FOV](../img/Sonar-3D-15-FOV-Visualization.png)
+
+The Sonar 3D-15 provides an opening angle as described in the tables below for the different modes. 
+
+### Low Frequency (1.2 MHz)
+
+| Specification        | Range             |
+|----------------------|-------------------|
+| Pitch (opening)      | -20° to +20°      |
+| Yaw (opening)        | -45° to +45°      |
+| Vertical coverage    | 40° total         |
+| Horizontal coverage  | 90° total         |
+
+
+### High Frequency (2.4 MHz)
+
+| Specification        | Range             |
+|----------------------|-------------------|
+| Pitch (opening)      | -20° to +20°      |
+| Yaw (opening)        | -20° to +20°      |
+| Vertical coverage    | 40° total         |
+| Horizontal coverage  | 40° total         |
+
+
+
+
diff --git a/docs/sonar-3d/sonar-3d-15-resources.md b/docs/sonar-3d/sonar-3d-15-resources.md
@@ -0,0 +1,6 @@
+# Resources for the Sonar 3D-15
+
+## Sonar 3D-15 Shop Page Resources
+Here you can find the Datasheet, 3D Model (.step) and Certificate of Origin
+
+[Shop Page](https://www.waterlinked.com/shop/wl-21045-2-sonar-3d-15-689#Downloads-%2F-Resources)
diff --git a/docs/sonar-3d/sonar-3d-15-software-changelog.md b/docs/sonar-3d/sonar-3d-15-software-changelog.md
@@ -0,0 +1,8 @@
+# Software Versions
+
+## V 1.6.0 - Nov. 2025
+Improve imaging performance
+Improve diagnostic functionality
+Add compression of image packets (RIP2 protocol)
+Add automatic check for clock difference between Sonar and users time
+Change protocol from WebRTC to websocket for Web GUI
diff --git a/docs/sonar-3d/sonar-3d-15.md b/docs/sonar-3d/sonar-3d-15.md
@@ -13,6 +13,8 @@ The cable can be bent as shown in the image up to 90 degrees without causing any
 
 ## Field of view
 
+![Sonar 3D 15 FOV](../img/Sonar-3D-15-FOV-Visualization.png)
+
 The Sonar 3D-15 provides an opening angle as described in the tables below for the different modes. 
 
 ### Low Frequency (1.2 MHz)
@@ -34,8 +36,6 @@ The Sonar 3D-15 provides an opening angle as described in the tables below for t
 | Vertical coverage    | 40° total         |
 | Horizontal coverage  | 40° total         |
 
-<!-- Insert drawing of Line of Sight -->
-
 ## Sonar 3D-15 Datasheet
 
 [Datasheet](https://waterlinked.com/datasheets/sonar-3D-15)
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -6,10 +6,17 @@ theme:
   theme_dir: docstheme/material
   logo: img/waterlinked_logo.png
   favicon: img/favicon_water_linked.ico
-  palette:
-    accent: blue
   font:
     text: Open Sans
+  palette:
+    # Light mode
+    - scheme: default
+      primary: "#1D3556"         # Ocean blue
+      accent: "#4BEF8F"          # Signal green light
+      # Background override for light mode
+      background: "#F1F9EE"      # Green white
+      surface: "#2B9C6A"      # Signal green dark
+
 extra:
   social:
     - icon: fontawesome/brands/github
@@ -33,24 +40,36 @@ extra_css:
   - css/extra.css
 nav:
   - Home: index.md
-  - Sonar 3D-15:
-      - Introduction: sonar-3d/sonar-3d-15.md
-      - Quickstart: sonar-3d/sonar-3d-15-quickstart.md
-      - Interface: 
-        - Wiring: sonar-3d/sonar-3d-15-wiring.md
-        - LED: sonar-3d/sonar-3d-15-led.md
-        - GUI: sonar-3d/sonar-3d-15-gui.md
-        - API: sonar-3d/sonar-3d-15-api.md
-      - Integration:
-         - DeepTrekker Pivot: sonar-3d/sonar-3d-15-deep-trekker-rov.md
-         - Blueye X3: sonar-3d/sonar-3d-15-blueye-rov.md
-         - BlueROV2: sonar-3d/sonar-3d-15-bluerov-integration.md
-         - Chasing M2 PRO MAX: sonar-3d/sonar-3d-15-chasing-rov.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
-      - Sonar Replay: sonar-3d/sonar-replay.md
-      - FAQ: sonar-3d/sonar-3d-15-faq.md
+
+  - Sonar 3D 15:
+      - Overview: sonar-3d/sonar-3d-15-introduction.md
+      - Get started Quickstart Guide: sonar-3d/sonar-3d-15-quickstart.md
+
+      - Install and connect:
+          - Dimensions & FOV: sonar-3d/sonar-3d-15-mechanical.md
+          - Electrical & LED: sonar-3d/sonar-3d-15-electrical.md
+          - Network Setup: sonar-3d/sonar-3d-15-networking.md
+
+      - Operate the device:
+          - GUI: sonar-3d/sonar-3d-15-gui.md
+          - Settings: sonar-3d/sonar-3d-15-config.md
+          - Replay Sonar Data: sonar-3d/sonar-replay.md
+          - API: sonar-3d/sonar-3d-15-api.md
+          - Software update: sonar-3d/sonar-3d-15-software-update.md
+
+      - Integrate with specific ROV:
+          - DeepTrekker Pivot: sonar-3d/sonar-3d-15-deep-trekker-rov.md
+          - Blueye X3: sonar-3d/sonar-3d-15-blueye-rov.md
+          - BlueROV2: sonar-3d/sonar-3d-15-bluerov-integration.md
+          - Chasing M2 PRO MAX: sonar-3d/sonar-3d-15-chasing-rov.md
+
+      - Troubleshooting:
+          - FAQ: sonar-3d/sonar-3d-15-faq.md
+          - Diagnostic log: sonar-3d/sonar-3d-15-diagnostic-log.md
+
+      - Resources:
+          - Links to Resources: sonar-3d/sonar-3d-15-resources.md
+          - Software Changelog: sonar-3d/sonar-3d-15-software-changelog.md
 
   - Underwater GPS:
       - G2:
@@ -106,6 +125,7 @@ nav:
               - Diagnostic: explorer-kit/gui/diagnostic.md
               - API: explorer-kit/gui/api.md
           - Software updates: explorer-kit/upgrader.md
+
   - DVL:
       - DVL-A50 — Introduction: dvl/dvl-a50.md
       - DVL-A125 — Introduction: dvl/dvl-a125.md
@@ -125,6 +145,7 @@ nav:
       - Software updates: dvl/sw-update.md
       - Troubleshooting: dvl/dvl-troubleshooting.md
       - DVL FAQ: dvl/faq.md
+
   - Modem:
       - Modem-M64 (retired):
           - Introduction: modem-m64/modem-m64.md
@@ -140,8 +161,9 @@ nav:
             - Protocol: modem-m16/modem-m16-protocol.md
             - Diagnostic report structure: modem-m16/modem-m16-diagnostic-report.md
           - M16 FAQ: modem-m16/modem-m16-faq.md
-  - I/O interface cards:
-          - Rev 4: io-interface-cards/rev4/io-interface-rev4.md
+
+  - I/O interface cards: 
+      - Revision 4: io-interface-cards/io-interface-rev4.md
 
 
-copyright: © Water Linked 2018-2024
+copyright: © Water Linked 2018-2026
