Ctrlk
Docs DirectoryStore
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Quick Start [AIO]

Use this guide if your unit is the fully self-contained Omniscan 3D "all in one" unit, which looks like this:

If your device does not look like the unit shown above, you likely need to reference the Modular unit / Upgrade Kit documentation instead.

Because the Omniscan 3D contains an onboard Linux computer, the setup process should be quite straightforward and you should be up and running in just a few minutes.

If you are configuring multiple units, set them up one at a time, we will combine them together later. If you connect multiple units together without setting them up individually first, they may have networking conflicts.

Hardware Setup

  1. Connect the Omniscan 3D power wires (red, black) 12-30V DC Power

    1. Hint: For bench testing, it's hard to beat the convenience of an adjustable USB-C PD trigger cable.

  2. Connect the Omniscan 3D Ethernet cable to a network that is reachable by your computer. At the present, Omniscan 3D units ship with DHCP enabled, but fall back to a static IP of 192.168.2.21 if it is unable to receive a DHCP address.

    1. It can be most convenient to connect directly to the device as shown below. In this case, it is important that you set a static IP on your network interface in the 192.168.2.1/24 subnet. For example, 192.168.2.1 would be a good choice.

    2. The IP Address of the Omniscan 3D cannot be changed over UDP broadcast from SonarView. For this reason if you would like to change the IP address to something else, you will need to first contact the device via its default static IP in order to access the device's web interface, which is the only supported method of changing the IP address.

Per-Device Software Setup

  1. Install SonarView

    1. Version 1.14.70 (or later) is recommended at this time.

    2. SonarView is the way that you will use the device. It can run as a desktop app (Windows, Mac, Linux) or as a BlueOS extension, or as a web app hosted from a docker container on any Linux host. Go here for the SonarView install instructions, then come back to this guide.

    3. Open SonarView

      1. If you have supplied power to the Omniscan 3D and you have connected it to a network that is reachable by your computer, then you should see the device in your SonarView Device Discovery menu

    4. If a firmware update is available (as shown in the above image), please install that now before proceeding.

  2. Unlike other Cerulean Sonar devices, the Omniscan 3D must be configured from a web interface hosted on the device before it can be paired with other devices in SonarView.

    1. If you are using a single Omniscan 3D by itself, you can skip down a few steps to "Remove the default mounting offset"

    2. To access the web interface, click the "Open WebUI" button shown in the SonarView Device Discovery menu, or type the IP address of the device in your web browser.

  3. Using the device's web interface, configure the device:

    1. The default user interface is only usable for "Common Setups" such as a single unit, or dual units. For any other configuration, such as using 3 or 4 units, the Advanced Configuration menu must be used.

    2. You may set a name for the device to make it easier to identify later.

    3. If you plan to use the Omniscan 3D by itself, then you can select "Single Omniscan 3D'

    4. If you plan to pair the Omniscan 3D with another unit, then select one of the "Dual Omniscan 3D"

      1. Note: The 'port' and 'starboard' labels shown in the user interface are purely examples of ways that an object might point, they have no bearing on the function or orientation of the device. Mounting angles will need to be entered manually in SonarView regardless.

    6. To prevent IP Address collisions, the default user interface will choose a the final octet of the static IP based on the device's role. If you'd like to customize this, you must use the Advanced Configuration menu.

    7. Click "Commit" when you are satisfied with your configuration.

    8. If everything went well, you'll see the device appear in device discovery at the new IP address:

    10. Remove the default mounting offset: The Omniscan 3D ships with a default mounting offset of 750mm forward of the position source. Since mounting offsets are primarily handled in SonarView, this can make entering offsets later confusing, so it's best to set it to zero.

      1. This can be done by connecting to the device, opening the "Advanced" menu on the left side, and then opening "OS3D Configuration

      3. hand-edit the x_mm line and set it to 0:

      5. NOTE: Make this change carefully, as changing any other values on this screen could compromise the functionality of your device.

      6. NOTE: Clicking the "Revert BX to Omniscan f/w" button may compromise the functionality of your device.

      7. NOTE: Do not edit the ax_mac or bx_mac, or set any other position or orientation offsets here. We will set position and orientation in SonarView's session configurations.

      8. Click Apply Changes when you are done.

  4. If you have an additional device to configure, then go back to the beginning of this step and complete that now.

Session Configuration

  1. Combining multiple data sources (devices, or vehicles) requires adding them to a Session together. This can be done in SonarView's Session Configurations screen.

  2. Select "Add Device", and then use the "Detect Devices" feature in the Device menu:

    1. This is the point where you will assign the mounting position and orientation of your device.

    2. Common Yaw Angles:

      1. Port: -90

      2. Starboard: 90

      3. Forward: 0

    3. Roll and pitch angles are determined by the device's IMU, and don't need to be set.

    5. When you are satisfied with the device, save it. If you have another device, repeat this step and add it as well at this time. If you are just using a single Omniscan 3D unit, then proceed here.

  3. Finally, combine all of the devices you plan to use together into a Session by clicking "Add Session", opening the Devices dropdown, and selecting the relevant devices

  4. When the Session is built, then it should appear in SonarView's Device Discovery screen:

    2. Connecting to the Session and Starting the device should render independent fan beams for each device.

      1. Note: the fan beams are only shown if the devices are pointing below the horizon

  5. Add your position and heading source.

Additional Usage Information:

  • Unlike other Cerulean Sonar devices, an Omniscan 3D can no longer be used independently after it has been configured to act as a device in a pair of devices. In this scenario, the device will fail to sync because it expects to be in a pair.

    • This is indicated to the user by pinging at 0.5hz instead of pinging at the commanded rate.

    • The Omniscan 3D will need to be reconfigured to be able to connect to it individually by entering the web interface and configuring it as a Single Device.

      • Warning: this will change the IP address of your Omniscan 3D

      • Warning: This will prevent the Omniscan 3D from acting as a device in a session.

PreviousWhat's In The BoxNextQuick Start [Upgrade Kit]

Last updated