Skip to content

Commit 8c66b49

Browse files
committed
Updated bluerov guide
1 parent fd8092e commit 8c66b49

3 files changed

Lines changed: 88 additions & 163 deletions

File tree

354 KB
Loading
264 KB
Loading

docs/sonar-3d/sonar-3d-15-bluerov-integration.md

Lines changed: 88 additions & 163 deletions
Original file line numberDiff line numberDiff line change
@@ -23,36 +23,35 @@ The Sonar 3D-15 from Water Linked is normally shipped with an attached I/O Inter
2323

2424
---
2525

26-
## What You’ll Need
27-
28-
To follow this guide, you will need the following:
29-
30-
- [BlueROV2 Roof Rack](https://bluerobotics.com/store/rov/bluerov2-accessories/rov-roof-rack/)
31-
32-
- A mount (Sonar 3D-15 to ROV)
33-
34-
- *An example can be downloaded from here: [3D step file](./stp_files/sonar_mount_1.stp)*
35-
36-
- Correct screws
37-
38-
- *See the [Mounting](#mounting) section*
39-
40-
- 2 spade connectors *(or ring terminals)*
41-
42-
- A JST 4-pin connector
43-
44-
- WetLink Penetrator 6.5 *(low-compression)*
45-
46-
- *[WetLink from Blue Robotics](https://bluerobotics.com/store/cables-connectors/penetrators/wlp-vp/)*
47-
48-
- Ethernet Switch board
49-
50-
- *Make sure you have an Ethernet Switch installed on your BlueROV2. This is needed for the integration of the Sonar 3D-15. The installation guide for the Ethernet Switch can be found here:* [Ethernet Switch Installation Guide from Blue Robotics](https://bluerobotics.com/learn/ethernet-switch-installation-guide-for-the-bluerov2/)
26+
## Prerequisites
27+
28+
Before starting the integration, ensure you have all the necessary tools and parts ready.
29+
30+
### Tools Required
31+
- Soldering iron and solder
32+
- Wire strippers / cutters
33+
- Heat gun or lighter (for heat shrink)
34+
- Small flathead screwdriver
35+
- Hex key set (for opening ROV and mounting)
36+
37+
### Parts Required
38+
- **[BlueROV2 Roof Rack](https://bluerobotics.com/store/rov/bluerov2-accessories/rov-roof-rack/)**: To mount the sonar.
39+
- **Sonar Mount**: Custom mount for Sonar 3D-15.
40+
- *Download the example [3D step file](./stp_files/sonar_mount_1.stp)*
41+
- **Mounting Screws**:
42+
- 4x M4 screws (length depends on mount thickness) for Sonar-to-Mount.
43+
- 4x M4 screws + nuts + washers for Mount-to-ROV.
44+
- **Connectors**:
45+
- 2x Spade connectors (or ring terminals) for power.
46+
- 1x JST 4-pin connector (GH type usually used with BlueROV2 devices, verify pitch).
47+
- **[WetLink Penetrator 6.5mm (Low Compression)](https://bluerobotics.com/store/cables-connectors/penetrators/wlp-vp/)**: For passing cable into the enclosure.
48+
- **Ethernet Switch**:
49+
- Must be installed in the BlueROV2. See [Ethernet Switch Installation Guide](https://bluerobotics.com/learn/ethernet-switch-installation-guide-for-the-bluerov2/).
5150

5251

5352
---
5453

55-
## Connector Setup
54+
## 1. Prepare the Connectors
5655
**Testing the Sonar 3D-15 Separately**
5756

5857
If the I/O Interface board is attached, the Sonar 3D-15 can be tested directly using an Ethernet cable and a power supply. If you wish to test the device on its own before integration, follow the general Quickstart tutorial, available here: [Quickstart](https://docs.waterlinked.com/sonar-3d/sonar-3d-15-quickstart/).
@@ -142,174 +141,100 @@ To install the Sonar 3D-15 for the BlueROV2, perform the following procedure:
142141

143142
---
144143

145-
## Mounting
146-
The Sonar 3D-15 needs to be physically attached to the BlueROV2 ROV. A possible option on how to do this will be listed here. There are many different approaches to achieve this, and this approach is only listed to provide an idea.
144+
## 2. Mount the Sonar
145+
Proper mounting is critical for accurate sonar performance.
147146

148-
1. **Create or find a suitable mount**
147+
### Recommended Mounting Procedure
149148

150-
An example 3D step file of a mount is found here: [Download 3D step file](./stp_files/sonar_mount_1.stp)
149+
1. **Prepare the Mount**
150+
If you haven't already, print or machine the mount.
151+
- [Download 3D step file](./stp_files/sonar_mount_1.stp)
151152
![Pixels](../img/sonar3d-integration-deeptrekkerpivot/mount_3d_print_step-fotor2.png)
152153

153154
!!! Note
154-
Choose a 3D print material that can withstand the expected operating conditions.
155-
156-
2. **Identify the screws and mount to use**
155+
Choose a material (like PETG or ABS) that can withstand the marine environment.
157156

158-
Use `[M4x (5.0 + X) mm]` screws to attach the Sonar 3D-15 to the mount, and use `[M4x (9.0 + X) mm]` screws with hex nuts and washers to attach the mount to the BlueROV2 Roof Rack. Exchange the *X* with the thickness of your mount.
159-
160-
For example, for a 3.0mm thick mount *(as the given 3D print)*, the following is sufficient:
157+
2. **Attach Sonar to Mount**
158+
Secure the Sonar 3D-15 to the mount using **4x M4 screws**.
159+
- Length = `5.0mm + Mount Thickness` (e.g., 8mm screws for a 3mm mount).
161160

162-
- 4x `M4x8.0mm` screws
163-
- 4x `M4x12.0mm` screws
164-
- 4x `M4` Hex Nuts
165-
- 4x `M4` Washers
166-
167161
![Pixels](../img/sonar3d-integration-deeptrekkerpivot/sonar_dimentions_screwholes.png)
168162

169-
!!!Warning
170-
To avoid damaging the Sonar 3D-15, make sure the screws are not too long.
171-
172-
3. **Attach the mount to the Sonar 3D-15**
163+
!!! Warning
164+
**Do not use screws that are too long.** They will penetrate the casing and permanently damage the sonar electronics.
173165

174166
![Pixels](../img/sonar3d-integration-deeptrekkerpivot/mount_attached_to_sonar.png)
175167

176-
177-
4. **Attach the mounted Sonar 3D-15 to the BlueROV2 ROV**
178-
179-
We recommend putting the Sonar 3D-15 on the BlueROV2 Roof Rack in the front for the BlueROV2. In that way, the Sonar 3D-15 will not block the Sonar 3D-15’s field of view.
168+
3. **Attach Assembly to ROV**
169+
Mount the assembly to the **BlueROV2 Roof Rack**, preferably at the **front** to ensure a clear field of view.
170+
- Use **4x M4 screws, nuts, and washers**.
180171

181172
![Pixels](../img/sonar3d-integration-bluerov2/bluerov_attatchmentbar.jpg){width="49%"}
182173
![Pixels](../img/sonar3d-integration-bluerov2/bluerov_mounted_sonar.jpg){width="49%"}
183174
![Pixels](../img/sonar3d-integration-bluerov2/bluerov_mounted_sonar_behind.jpg)
184175

185-
!!! note
186-
Make sure the Sonar 3D-15 and cable are neatly and securely attached before use.
176+
!!! Checkpoint
177+
Verify the sonar is securely attached and the cable is routed neatly away from thrusters.
187178
---
188179

189-
## Connection steps
190-
191-
192-
### 1. **Make your ROV ready for launch**
193-
194-
Follow the [BlueROV2 Software Setup](https://bluerobotics.com/learn/bluerov2-software-setup/) guide to make your ROV ready for launch. This shows how to turn on the ROV and what software to install.
195-
196-
The Sonar 3D-15 will now show a green light, indicating it is powered.
197-
198-
### 2. **Access the Sonar 3D-15 GUI**
199-
200-
We recommend installing the **[Sonar 3D-15 extension](https://github.com/waterlinked/BlueOS-Sonar-Extension)** found in the [BlueOS extension manager](https://www.google.com/search?q=https://blueos.cloud/docs/latest/usage/advanced/%23extensions-manager). If you use the extension, you can skip directly to **Connection Step 3**. Otherwise, follow the procedure below to connect manually.
180+
## 3. Configure Software & Network
201181

202-
The Sonar 3D-15 GUI can be accessed by entering the Sonar 3D-15's IP-address into the browser running on the computer connected to the ROV.
182+
### Step 1: Prepare the ROV
183+
Power on the BlueROV2 and ensure it is connected to your computer.
184+
- Follow the [BlueROV2 Software Setup](https://bluerobotics.com/learn/bluerov2-software-setup/) if needed.
185+
- **Verify**: The Sonar 3D-15 should show a **green light**, indicating it is powered.
203186

204-
You have to determine which IP-address has been automatically assigned to the Sonar 3D-15 by the BlueRov2 system. Steps to find it follows below. Once located, entering it in your browser will display a page like the one below — in this example, the Sonar 3D-15 is assigned the IP-address `192.168.2.172`.
187+
### Step 2: Install BlueOS Extension (Recommended)
188+
The easiest way to connect is using the **Sonar 3D-15 extension**.
205189

190+
1. Open the [BlueOS extension manager](https://blueos.cloud/docs/latest/usage/advanced/#extensions-manager).
191+
2. Search for and install **Sonar 3D-15 extension**.
192+
![Pixels](../img/sonar3d-integration-bluerov2/bluerov_Install_sonar_3d-15_extension_example.png)
193+
3. Click the extension to open it. It will automatically detect the Sonar IP.
194+
![Pixels](../img/sonar3d-integration-bluerov2/bluerov_extension_sonar_3d-15.png)
206195

207-
![Pixels](../img/sonar3d-integration-bluerov2/sonar_gui_bluerov.png)
196+
### Step 3: Configure Cockpit
197+
We recommend using **Cockpit** for the best experience.
208198

209-
!!! Warning
210-
Don't operate the Sonar 3D-15 out of water for any long periods. To avoid overheating of the Sonar 3D-15, **don’t click the green button “Enable Acoustics”**, until the ROV is submerged in water.
211-
212-
Acoustics is always disabled when first booting up the Sonar 3D-15, and will be turned on once clicking this button. The Sonar 3D-15 will automatically turn itself off if too hot, but will take some time to cool down, it's best to avoid this happening.
213-
214-
215-
216-
Find the IP-address corresponding to the Sonar 3D-15 on a computer by doing the following:
217-
218-
1. **Find the IP-address of your computer on the BlueROV2 network**
219-
220-
You need your own network IP-address on the BlueROV2 network.
221-
On **Linux** you find it by typing in:
222-
223-
```sh
224-
ip a
225-
```
226-
in the terminal.
227-
228-
On **Windows** you find it by typing in:
229-
```sh
230-
ipconfig
231-
```
232-
!!!Tip
233-
It's easier to find your IP-address if your computer is connected only to the BlueROV2 network.
199+
1. Open Cockpit and click the **collapse handle** on the left.
200+
![Pixels](../img/sonar3d-integration-bluerov2/cockpit_sonar1.jpg)
201+
2. Click **Edit Interface**.
202+
![Pixels](../img/sonar3d-integration-bluerov2/cockpit_sonar2.png)
203+
3. Drag an **IFrame** box onto your layout.
204+
![Pixels](../img/sonar3d-integration-bluerov2/cockpit_sonar3.png)
205+
4. Click the **settings icon** for the IFrame.
206+
![Pixels](../img/sonar3d-integration-bluerov2/cockpit_sonar6.png)
207+
5. **Enter the Sonar IP Address**:
208+
- Use the IP address displayed in the Extension (Step 2), e.g., `http://192.168.2.172`.
209+
- Press **Enter**.
210+
![Pixels](../img/sonar3d-integration-bluerov2/cockpit_sonar8.png)
234211

212+
### Step 4: Deploy & Validate
235213

236-
2. **Test and find the Sonar 3D-15's IP-address**
214+
1. **Submerge**: Place the ROV in water.
215+
![Pixels](../img/sonar3d-integration-bluerov2/bluerov_put_into_water.png)
216+
2. **Enable Acoustics**: In the Sonar GUI (now visible in Cockpit), click the green **"Enable Acoustics"** button.
237217

238-
A quick easy way to see the IP-addresses of the devices on your local network is to use [nmap](https://nmap.org/download.html). Install it for your operating system and go to the terminal and write
239-
```sh
240-
nmap -sn <YOUR_IP>
241-
```
242-
243-
This will scan the BlueROV2 network and show all accessible connected devices and their IPs.
244-
245-
![Pixels](../img/sonar3d-integration-bluerov2/nmap_bluerov_cropped.png)
246-
247-
To find the IP-address of the Sonar 3D-15, try the IP-addresses on the list by typing them into the search bar of your browser.
248-
249-
- For example, if you have the list above, try `192.168.2.2`, `192.168.2.136`, `192.168.2.172` and so on. You may try them all safely.
250-
251-
If the Sonar 3D-15 GUI appears, you have found the correct IP-address.
252-
253-
!!! Tip
254-
You can also access the GUI on the Sonar 3D-15's fallback address `192.168.194.96`. This method is explained in more detail on the general quickstart guide, which can be found at [Quickstart](https://docs.waterlinked.com/sonar-3d/sonar-3d-15-quickstart/) .
255-
256-
### 3. ***(Optional)* Open Cockpit with the Sonar 3D-15 GUI**
257-
258-
We recommend using **Cockpit**, a new, highly customizable ground control station software from Blue Robotics. More information about Cockpit can be found here: [Cockpit Information](https://discuss.bluerobotics.com/t/cockpit-1-0-0-release/17744), and it can be installed from here: [Install Cockpit](https://github.com/bluerobotics/cockpit/releases/tag/v1.15.2).
259-
260-
Once Cockpit is installed and the BlueROV2 is ready for launch, you will see the Cockpit GUI, as shown in the following picture. Click the **collapse handle** on the left to reveal the GUI options.
261-
262-
![Pixels](../img/sonar3d-integration-bluerov2/cockpit_sonar1.jpg)
263-
264-
Click **Edit Interface**.
265-
266-
![Pixels](../img/sonar3d-integration-bluerov2/cockpit_sonar2.png)
267-
268-
Here you can change the layout of the GUI. We will add a frame to display the Sonar 3D-15 GUI. Click and drag an **IFrame** box onto the main screen.
269-
270-
![Pixels](../img/sonar3d-integration-bluerov2/cockpit_sonar3.png)
271-
272-
An *IFrame* box will appear with the standard BlueOS page.
273-
274-
![Pixels](../img/sonar3d-integration-bluerov2/cockpit_sonar4.png)
275-
276-
Resize it as needed to fit your desired layout.
277-
278-
![Pixels](../img/sonar3d-integration-bluerov2/cockpit_sonar5.png)
279-
280-
Click the **settings icon for the IFrame**.
281-
282-
![Pixels](../img/sonar3d-integration-bluerov2/cockpit_sonar6.png)
283-
284-
The following configuration panel will appear.
285-
286-
![Pixels](../img/sonar3d-integration-bluerov2/cockpit_sonar7.png)
287-
288-
Instead of `http://blueos-avahi.local`, enter the IP-address for the Sonar 3D-15, as found in the previous step. In this example, the IP-address is `http://192.168.2.172`. Press *Enter* on your keyboard, then close the settings panel.
289-
290-
![Pixels](../img/sonar3d-integration-bluerov2/cockpit_sonar8.png)
291-
292-
The Sonar 3D-15 GUI will now appear in the IFrame box within your Cockpit control station.
293-
294-
![Pixels](../img/sonar3d-integration-bluerov2/cockpit_sonar9.png)
295-
296-
!!! Warning
297-
To avoid overheating of the Sonar 3D-15, **don’t click the green "Enable Acoustics" button**, until the ROV is submerged in water.
298-
299-
300-
### 4. **Put the ROV into water**
301-
302-
You are now ready to put the ROV into water.
218+
!!! Warning
219+
**Never enable acoustics in air.** Only enable when submerged to prevent overheating.
303220

304-
![Pixels](../img/sonar3d-integration-bluerov2/bluerov_put_into_water.png)
221+
![Pixels](../img/sonar3d-integration-bluerov2/cockpit_sonar10.png){width="100%"}
305222

223+
**Success!** You are now ready to use the Sonar 3D-15.
306224

307-
### 4. **Enable acoustics**
225+
---
308226

309-
When ready, click the ”Enable acoustics” button to initiate the Sonar 3D-15. It will display a 3D point cloud in the GUI representing the area in front of the Sonar 3D-15.
227+
## Troubleshooting & Advanced
310228

229+
??? info "How to find the IP Address Manually"
311230

312-
<!-- ![Pixels](../img/sonar3d-integration-deeptrekkerpivot/sonar_3d_enjoy.png){width="100%"} -->
313-
![Pixels](../img/sonar3d-integration-bluerov2/cockpit_sonar10.png){width="100%"}
231+
If the extension does not work, you can find the IP manually.
314232

315-
You are now ready to use the Water Linked Sonar 3D-15 with the BlueROV2!
233+
1. **Identify your computer's IP** on the BlueROV network (`ip a` on Linux, `ipconfig` on Windows).
234+
2. **Scan the network** using `nmap`:
235+
```sh
236+
nmap -sn 192.168.2.* ```
237+
*(Adjust the subnet to match your BlueROV network)*
238+
3. **Try recognized IPs** in a browser until the Sonar GUI loads.
239+
- Common subnets: `192.168.2.x`
240+
- Fallback IP: `192.168.194.96` See [quickstart](sonar-3d-15-quickstart.md) for details.

0 commit comments

Comments
 (0)