This SDK supports connecting to and commanding ARIS Explorer and ARIS Voyager sonars. (Connecting to an ARIS Defender is not supported). For information on ARIS frame formats, see ARIS File SDK.
The ARIS control and imaging protocols require the use of Google Protocol Buffers, and TCP & UDP communications. While the example code in this repo is largely targeted at Windows clients, one can write client code on any platform that supports the above technologies.
Note: if you are using Protocol Buffers version 3 to control an ARIS, you must use ARIS onboard software version 2.7.x or later. You can update the onboard software from within ARIScope.
This SDK provides capabilities for controlling an ARIS Explorer. ARIS Defender cannot be controlled with this SDK, only the built-in supervisor functionality is available for ARIS Defender.
This SDK, beginning with version 2.0, supersedes a previous ARIS 1.x SDK. The older SDK is not compatible with current ARIS production.
This SDK does not support for the DIDSON sonar. Please contact support@soundmetrics.com for more information on DIDSON protocols.
The release history of this SDK is tracked here. Releases are available here.
The following documentation is provided:
aris-integration-sdk/documents/ARIS-Integration-SDK.pdf: Describes the mechanisms necessary to build an application to control an ARIS.
aris-integration-sdk/documents/Integration-SDK-suggested-settings.xlsx: An Excel spreadsheet that provides rudimentary support in choosing valid acoustic settings.
aris-integration-sdk/documents/how-to-set-the-ARIS-IP-address.pdf: Describes how to configure an ARIS to use a static IP address. (Not recommended.)
Documentation of file formats and frame headers can be found in our repo aris-file-sdk.
aris-integration-sdk/common/code/: These folders contain the following:
SoundMetrics.Aris2.Protocols
, a managed C# assembly project that provides helper functions to correctly construct the most common ARIS 2 commands. See the readme for more information.aris-integration-sdk/common/protobuf/: Contains Protocol Buffer files describing messages sent to/received from the ARIS.
aris-integration-sdk/sample-code/: These folders contain the following:
aris-integration-sdk/tools: contains the following:
This repository makes use of vcpkg
for building arislog
and vc-using-framestream
.
vcpkg
is an external tool that downloads the source code for protobuf
and builds it.
The version of protobuf downloaded is coded within the vcpkg
submodule and, therefore,
won't change unless we update that submodule.
To build the arislog
and vc-using-framestream
samples, first run prepare-vcpkg.cmd
in a Visual Studio 2019 command prompt.
This git repository includes the submodule aris-file-sdk
. If you intend to clone this repo
you'll want to use the --recursive
flag.
NOTE: The .zip and .tar.gz bundle files available from GitHub are incomplete--the submodules are not populated. In order to successfully build, please consider cloning directly:
git clone --recursive https://github.com/SoundMetrics/aris-integration-sdk.git
Releases of this SDK are available here.
Whether it's a big or small bug, please read the Contributions Guideline for how to address it to us.
Please read the Contributions Guideline for help on requesting a feature.
The stated version number of this SDK does not track with Sound Metrics' other software applications' version numbers.