Skip to content

Integration๐Ÿ”—

This page helps you choose an interface for integrating our DVLs into a vehicle, boat, or control system.

Choose an interface๐Ÿ”—

Use case Recommended interface
First setup, diagnostics, configuration, and testing Ethernet and the web GUI
Custom software integration over Ethernet TCP JSON API
Direct vehicle integration over serial Water Linked serial protocol
Existing systems with PD0, PD4, or PD6 support PD formats
Multiple acoustic instruments Triggering and synchronization

TCP JSON API๐Ÿ”—

Use the TCP JSON API when you want a network data stream, command interface, and easy access from custom software. In customer-facing documentation, Water Linked API refers to this TCP JSON API.

The DVL TCP server is available on port 16171. See Network Setup.

In our measurements, TCP JSON message latency was typically around 4 ms average, with 2 ms standard deviation and an observed maximum of 13 ms. This is not a hard real-time guarantee; actual latency can depend on network setup, host system, load, and integration method.

Protocol references:

Serial Water Linked protocol๐Ÿ”—

Use the Water Linked serial protocol when the vehicle controller expects a direct serial data stream.

Electrical interfaces differ by model:

Serial output is disabled by default on DVL A100/A250๐Ÿ”—

The serial output is the stream of velocity, transducer, and dead reckoning reports that the DVL sends on its own. The default differs by model:

Model Serial output by default
DVL A50/A125 Enabled
DVL A100/A250 Disabled

On DVL A100 and DVL A250 you must enable the serial output before any reports appear on the RS232 interface. On all models, the serial output is enabled or disabled in the web GUI or with the wcp command over serial. It cannot be changed over the TCP JSON API.

Disabling the serial output only stops the report stream. It does not affect:

  • Serial commands. The DVL still receives commands over serial and replies to them, so you can enable the output with wcp from the serial port itself.
  • Hardware triggering on DVL A100/A250. The trigger pulse on the RS232 RX line still works. See Triggering.

Protocol references:

PD formats๐Ÿ”—

Use PD formats only when the receiving system already supports PD0, PD4, or PD6. This can reduce integration work when replacing or adding a DVL to an existing system.

PD4 and PD6 are supported over TCP and serial for all DVL models. PD0 is planned for DVL A100 and DVL A250, but is not available yet.

Protocol references:

Triggering and synchronization๐Ÿ”—

Triggering can be useful when the DVL operates near other acoustic instruments and you want to avoid simultaneous acoustic transmissions.

Triggering and synchronization are handled through protocol or electrical interfaces, not through the web GUI.

TCP JSON API or serial command trigger๐Ÿ”—

The DVL can queue externally requested pings when acoustic pinging is controlled by command.

See:

RX-line trigger๐Ÿ”—

For DVL A100 and DVL A250, sending a NUL character at 115200 baud over the RS232 RX line triggers a ping. The DVL recognizes the 78.1 ยตs ยฑ 4.3 ยตs positive pulse on the wire and triggers the ping when the pulse ends. Hardware triggering must be enabled in the configuration first, otherwise the pulses are ignored. See Hardware triggering for the pulse timing and a drawing.

Diagnostics during integration๐Ÿ”—

If the integration does not behave as expected, collect a diagnostic log from the web GUI and include the integration interface in the support request.

See: