Quick Start [Upgrade Kit]

Use this guide if your unit is the Omniscan 3D Upgrade Kit, also referred to as the Modular system, which looks like this:

If your unit does not look like the one pictured above, you likely need to reference the documentation for the Omniscan 3D AIO variant.

Note: As this documentation pertains to the Omniscan 3D upgrade kit, it is assumed that you already have a functioning Omniscan 450 unit.

Hardware Setup

Connect the following devices to power (DC 12-30V) and an Ethernet connection so that they are all reachable locally:

• AX Module (Also called the RX-16) (The multibeam receive array)

  
• BX Module (The Omniscan 450 FS, SS, or Compact)

• The device that will run the SonarView docker container (Linux laptop / desktop, or a SBC such as the Raspberry Pi).

For port and starboard OS3D kits, we recommend completing this setup procedure with only the starboard unit connected first. Once that unit is set up and working properly, repeat the software steps with both units connected.

Software Setup

1. Install SonarView

The OmniScan 3D currently requires the Docker version of SonarView. On vehicles running BlueOS, the SonarView BlueOS extension uses the Docker version, so it is also compatible.

SonarView 1.14.40 or later is required. 1.14.68 is recommended at this time.

BlueOS Extension

To install the SonarView BlueOS extension, follow the instructions found here

We *highly* recommend using BlueOS 1.4.4-beta.1 or later. If you cannot upgrade your BlueOS version, you must disable the ping service every boot and restart the SonarView extension as described below. You can skip the next step if using a recommended BlueOS version

Disabling Ping Service for BlueOS

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.

6. If all is well and your devices are recognized, you should see output similar to this:

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

Now you can use SonarView in a separate browser tab (leave the terminal from step #5 open). This process will need to be repeated on each boot until this issue is resolved via BlueOS Update.

Docker Version

2. Discover Devices

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

3. Open the OS3D Configuration Dialog

Once connected, navigate to the left side bar and open the OS3D Configuration. If not visible here, check under the Advanced tab

4. Configure the OS3D

You should see something like this:

1. If you have a regular Omniscan unit, you will need to update the firmware to be compatable with the Omniscan3D. Find those instructions here

2. Assuming only one AX (RX16) and one BX (Omniscan) are connected, the ax_mac and bx_mac fields should populate automatically. If they do not, or if the values do not match the devices listed under Discovered Devices above, copy those values into the appropriate fields. Be sure to keep the quotation marks.

3. Configure mount_fsd (forward, starboard, down) so it matches the unit’s position and yaw angle relative to your position and heading source.

4. Set the spoof_ip value to a valid IP address within the range used by the machine running SonarView. On a factory BlueOS installation, any address in the 192.168.2.xxx range should work, provided it does not conflict with another device—for example, do not use 192.168.2.2. You can also run ifconfig in a terminal to check for a valid address.

5. Click Apply Changes to confirm changes. This should restart the device.

6. If you have a second unit, connect it to the system while keeping the first one connected and configure the ax_mac, bx_mac, and mount_fsd as a second device in that array as shown below

{
  "devices": [
    {
      "ax_mac": "00:80:e1:4d:7c:24",
      "bx_mac": "00:80:e1:27:02:24",
      "mount_fsd": {
        "x_mm": 0,
        "y_mm": 0,
        "yaw_deg": 90,
        "z_mm": 0
      },
      "name": "Omniscan 3D Starboard"
    },
    {
      "ax_mac": "00:80:e1:4d:7c:23",
      "bx_mac": "00:80:e1:27:ab:24",
      "mount_fsd": {
        "x_mm": 0,
        "y_mm": 0,
        "yaw_deg": -90,
        "z_mm": 0
      },
      "name": "Omniscan 3D Port"
    }
  ],
  "spoof_ip": "192.168.2.200",
  "type": "os3d_config"
}

With everything connected and configured, you should now be able to connect and start collecting data. Follow the links below for next steps

Configure Source of Position and Heading

Position and Heading Source

Change Firmware on Omnsican Unit

Omniscan <-> Omniscan3D

Using SonarView for the Omniscan 3D

3D View