# Quick Start ### SonarView Info Currently the Omniscan 3D requires using the Docker version of SonarView. The docker version of SonarView contains some additional components needed for the Omniscan 3D that are not present in the Desktop version of SonarView. \ \ The docker container can run on any Linux host. More info about SonarView Docker here:\ SonarView 1.14.23-dev or later is required. 1.14.30-beta recommended at this time. {% hint style="info" %} SonarView is available as a BlueOS Extension on the BlueOS Store. However some special steps need to be taken at this time to prevent collisions between the BlueOS Ping service and SonarView. See [#steps-to-allow-the-omniscan3d-to-work-in-blueos](#steps-to-allow-the-omniscan3d-to-work-in-blueos "mention") {% endhint %} ### Hardware Setup Connect the following devices to power (DC 10-30V) and an Ethernet connection so that they are all reachable locally:
* AX Module (The multibeam receive array) \* ```
``` * BX Module (The Omniscan 450 FS, SS, or Compact) * The device running the SonarView docker container (Linux laptop / desktop, or a SBC such as the Raspberry Pi). ### Software Setup 1. Open SonarView and go into Device Discovery. If your devices are powered on and reachable, you'll see the Omniscan 3D in the Discovered Devices list 1\. ```
``` 2. Before the Omniscan 3D can be used, some configuration needs to be done in the OS3D Configuration Dialog here:
3. Copy the AX Mac address at the top of the dialog (by clicking it) and paste it into the "ax\_mac" field of the JSON below, replacing the existing placeholder value. Do the same for the BX Mac address and paste it into the "bx\_mac" field. Make sure to keep the quotes.
4. Set the "ip\_address" and "ethernet\_interface" properties to match what your machine is using. Use `ifconfig` if you are unsure. 1. Default values for BlueRobotics platforms are: 1. "ethernet\_interface": "eth0" 2. "ip\_address": "192.168.2.2" 5. Click "Apply Changes" to save the config. 6. Restart the Docker container to load the new config. Then go back to SonarView's home screen, then Discovery, then connect again. #### Steps to allow the Omniscan 3D to work in BlueOS (1.5.0-beta.25 and earlier) 1. Open the BlueOS Terminal in a web browser. 2. Press CTRL+B, then S. 3. Use Arrow keys to navigate to the Ping service 4. Use CTRL+C to kill the process. 5. Leave this terminal open in a tab. In a separate browser tab, go to the BlueOS Installed Extensions page and restart the SonarView container. You can watch the Container logs right after it starts to see if it successfully binds to port 30303. 1. If all is well and your devices are recognized, you should see output similar to this: 2. ```` ``` ```` ```` TCP Listener on port 62312... HTTP server started on port 7078, serving from: ./web successful udp bind on 192.168.2.2:50505 successful udp bind on 0.0.0.0:30303 InterfaceManager::init() completed at IP address 192.168.2.2 awaitActivity timeout ABxDiscoveryHandler: broadcasting discovery msg: 'OS3D-DISCOVERY-1;PI_IP: 192.168.2.2 ,SPOOF: 192.168.2.253 ' ABxDiscoveryHandler received reply: '{ "message_type": "ABxDiscoveryResponse", "device_type": "BX", "MAC": "00:80:e1:4e:1c:24"}' ABxDiscoveryHandler received reply: '{ "message_type": "ABxDiscoveryResponse", "device_type": "AX", "MAC": "00:80:e1:29:7f:26"}' awaitActivity timeout ``` ```` 6. Now you can use SonarView in a separate browser tab (leave the terminal from step #5 open) 7. This process will need to be repeated on each boot until this issue is resolved via BlueOS Update. #### Steps to allow the Omniscan 3D to work in BlueOS (1.5.0-beta.26 and 27) 1. SonarView's web interface must be accessed directly, it will not load by clicking "SonarView" in the BlueOS menu. 2. SonarView runs on port 7077, so on a stock BlueOS instance SonarView can be accessed at . If hostname resolution is working, then may also work. ####
--- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.ceruleansonar.com/c/omniscan3d/quick-start.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.