The below reference is automatically generated from the proto files, therefore some fields are blank.

Protocol Documentation

Table of Contents

• Protocol Documentation
• Table of Contents
• sonardyne-public/idl/common/primitives.proto
  • BoundedDouble
  • BoundedFloat
  • BoundedInt32
  • BoundedInt64
  • BoundedUInt32
  • BoundedUInt64
  • Fixed32Value
  • Fixed64Value
  • SFixed32Value
  • SFixed64Value
  • SInt32Value
  • SInt64Value
• sonardyne-public/idl/common/result.proto
  • Result
  • Result.Outcome
• sonardyne-public/idl/common/timestamp.proto
  • Timestamp
• sonardyne-public/idl/common/uid.proto
  • Uid
• sonardyne-public/idl/common/version.proto
  • VersionRequest
  • VersionResponse
• sonardyne-public/idl/configuration/aiding_configuration.proto
  • AidingConfiguration
  • AidingState
  • AidingState.AidingStateEnum
• sonardyne-public/idl/configuration/configuration_envelope.proto
  • ConfigurationEnvelope
  • ConfigurationRequest
• sonardyne-public/idl/configuration/dvl_configuration.proto
  • DvlConfiguration
  • DvlUpdateRate
  • DvlUpdateRate.DvlUpdateRateEnum
• sonardyne-public/idl/configuration/reset_configuration.proto
  • ResetConfiguration
  • ResetType
  • ResetType.ResetTypeEnum
• sonardyne-public/idl/configuration/shutdown_configuration.proto
  • ShutdownConfiguration
• sonardyne-public/idl/configuration/sound_velocity_configuration.proto
  • SoundVelocityConfiguration
  • SoundVelocityType
  • SoundVelocityType.SoundVelocityTypeEnum
• sonardyne-public/idl/services/state_service.proto
  • StateService
• Scalar Value Types

Top

sonardyne-public/idl/common/primitives.proto

BoundedDouble

Field	Type	Label	Description
value	double		The value
min	double		The minimum value (read only)
max	double		The maximum value (read only)

BoundedFloat

Field	Type	Label	Description
value	float		The value
min	float		The minimum value (read only)
max	float		The maximum value (read only)

BoundedInt32

Field	Type	Label	Description
value	int32		The value
min	int32		The minimum value (read only)
max	int32		The maximum value (read only)

BoundedInt64

Field	Type	Label	Description
value	int64		The value
min	int64		The minimum value (read only)
max	int64		The maximum value (read only)

BoundedUInt32

Field	Type	Label	Description
value	uint32		The value
min	uint32		The minimum value (read only)
max	uint32		The maximum value (read only)

BoundedUInt64

Field	Type	Label	Description
value	uint64		The value
min	uint64		The minimum value (read only)
max	uint64		The maximum value (read only)

Fixed32Value

Field	Type	Label	Description
value	fixed32		The value
min	fixed32		The minimum value (read only)
max	fixed32		The maximum value (read only)

Fixed64Value

Field	Type	Label	Description
value	fixed64		The value
min	fixed64		The minimum value (read only)
max	fixed64		The maximum value (read only)

SFixed32Value

Field	Type	Label	Description
value	sfixed32		The value
min	sfixed32		The minimum value (read only)
max	sfixed32		The maximum value (read only)

SFixed64Value

Field	Type	Label	Description
value	sfixed64		The value
min	sfixed64		The minimum value (read only)
max	sfixed64		The maximum value (read only)

SInt32Value

Field	Type	Label	Description
value	sint32		The value
min	sint32		The minimum value (read only)
max	sint32		The maximum value (read only)

SInt64Value

Field	Type	Label	Description
value	sint64		The value
min	sint64		The minimum value (read only)
max	sint64		The maximum value (read only)

Top

sonardyne-public/idl/common/result.proto

Result

Field	Type	Label	Description
success	Result.Outcome		Indicates success or failure. True for success, otherwise False
message	string		Description of the operations result

Result.Outcome

Name	Number	Description
UNSPECIFIED	0	Result of operation unspecified (default value)
SUCCESS	1	Operation has succeeded
FAILURE	2	Operation has failed
INVALID	3	Operation has been given invalid parameters
RESTRICTED	4	Operation is not allowed - user does not have permission, or instrument is not in the correct mode.

Top

sonardyne-public/idl/common/timestamp.proto

Timestamp

Field	Type	Label	Description
common_time_seconds	double		Time since the UNIX epoch (01/01/1970) in seconds and fractional seconds
instrument_time_seconds	double		Monotonically increasing instrument time in seconds and fractional seconds

Top

sonardyne-public/idl/common/uid.proto

Uid

Used to identify a recipient

Field	Type	Label	Description
uid	uint32		Unique identifier of a recipient
name	string		Human-readable recipient name populated in reply

Top

sonardyne-public/idl/common/version.proto

VersionRequest

VersionResponse

A message that contains Semantic Versioning which comprises a three part version number: Major.Minor.Patch

Field	Type	Label	Description
major	uint32		MAJOR version incremented for incompatible changes that break existing clients.
minor	uint32		MINOR version incremented for backward-compatible features or enhancements.
patch	uint32		PATCH version incremented for backward-compatible bug fixes or patches.

Top

sonardyne-public/idl/configuration/aiding_configuration.proto

AidingConfiguration

Position aiding configuration, defines which position input(s) to use for aiding

Field	Type	Label	Description
id	sonardyne.api.pub.common.Uid		Used to identify recipient instrument/module
result	sonardyne.api.pub.common.Result		Populated by instrument when replying to a SetState indicating the success of the operation
enable_gnss	AidingState		Used to turn GNSS aiding on or off
enable_xpos	AidingState		Used to turn XPOS aiding on or off
enable_usbl	AidingState		Used to turn USBL aiding on or off

AidingState

Field	Type	Label	Description
value	AidingState.AidingStateEnum		The state of the aiding
valid_values	AidingState.AidingStateEnum	repeated	The valid values for the aiding state

AidingState.AidingStateEnum

Name	Number	Description
UNKNOWN	0
ENABLED	1
DISABLED	2

Top

sonardyne-public/idl/configuration/configuration_envelope.proto

ConfigurationEnvelope

A container of instrument configurations, a timestamp and a result.

Field	Type	Label	Description
timestamp	sonardyne.api.pub.common.Timestamp		Timestamp of the configuration
result	sonardyne.api.pub.common.Result		Populated by instrument when replying to a SetState indicating the success of the operation
configuration	google.protobuf.Any	repeated	The configuration data - can be any of AidingConfiguration, DvlConfiguration, ResetConfiguration, ShutdownConfiguration or SoundVelocityConfiguration

ConfigurationRequest

Field	Type	Label	Description
timestamp	sonardyne.api.pub.common.Timestamp		Timestamp of the request
requestor	string		Optional user-definable field

Top

sonardyne-public/idl/configuration/dvl_configuration.proto

DvlConfiguration

Doppler Velocity Log configuration which controls the update rate

Field	Type	Label	Description
id	sonardyne.api.pub.common.Uid		Used to identify recipient instrument/module
result	sonardyne.api.pub.common.Result		Populated by instrument when replying to a SetState indicating the success of the operation
update_rate	DvlUpdateRate		Specifies the update rate

DvlUpdateRate

Field	Type	Label	Description
value	DvlUpdateRate.DvlUpdateRateEnum		The type of reset to execute
valid_values	DvlUpdateRate.DvlUpdateRateEnum	repeated	The valid values for the reset type

DvlUpdateRate.DvlUpdateRateEnum

Name	Number	Description
UNKNOWN	0
TRIGGER_RISING	1	Use external trigger (rising edge)
TRIGGER_FALLING	2	Use external trigger (falling edge)
MAX_RATE	3	Use max supported update rate
FIXED_1HZ	4	Use fixed 1Hz rate
FIXED_2HZ	5	Use fixed 2Hz rate
FIXED_5HZ	6	Use fixed 5Hz rate
FIXED_10HZ	7	Use fixed 10Hz rate

Top

sonardyne-public/idl/configuration/reset_configuration.proto

ResetConfiguration

Set type of reset to execute

Field	Type	Label	Description
id	sonardyne.api.pub.common.Uid		Used to identify recipient instrument/module
result	sonardyne.api.pub.common.Result		Populated by instrument when replying to a SetState indicating the success of the operation
reset_type	ResetType		Indicates the type of reset required

ResetType

Field	Type	Label	Description
value	ResetType.ResetTypeEnum		The type of reset to execute
valid_values	ResetType.ResetTypeEnum	repeated	The valid values for the reset type

ResetType.ResetTypeEnum

Name	Number	Description
UNKNOWN	0
SOFT_RESET	1	See instrument manual for description
HARD_RESET	2	See instrument manual for description

Top

sonardyne-public/idl/configuration/shutdown_configuration.proto

ShutdownConfiguration

Field	Type	Label	Description
id	sonardyne.api.pub.common.Uid		Used to identify recipient instrument/module
result	sonardyne.api.pub.common.Result		Populated by instrument when replying to a SetState indicating the success of the operation

Top

sonardyne-public/idl/configuration/sound_velocity_configuration.proto

SoundVelocityConfiguration

Sound Velocity configuration which controls the type of trigger to use

Field	Type	Label	Description
id	sonardyne.api.pub.common.Uid		Used to identify recipient instrument/module
result	sonardyne.api.pub.common.Result		Populated by instrument when replying to a SetState indicating the success of the operation
sound_velocity_type	SoundVelocityType		Define the Sound Velocity source
manual_salinity_value_parts_per_thousand	sonardyne.api.pub.common.BoundedDouble		Used if Sound Velocity type is INTERNAL_SALINITY
manual_velocity_value_metres_per_second	sonardyne.api.pub.common.BoundedDouble		Used if Sound Velocity type is INTERNAL_MANUAL

SoundVelocityType

Field	Type	Label	Description
value	SoundVelocityType.SoundVelocityTypeEnum		Define the Sound Velocity source
valid_values	SoundVelocityType.SoundVelocityTypeEnum	repeated	Define the range of valid values

SoundVelocityType.SoundVelocityTypeEnum

Name	Number	Description
UNKNOWN	0
EXTERNAL	1	Use external - N.B. The port must be specified in the webUI
INTERNAL_SALINITY	2	Use internal (derived from salinity)
INTERNAL_MANUAL	3	Use manually defined value

Top

sonardyne-public/idl/services/state_service.proto

StateService

Method Name	Request Type	Response Type	Description
GetVersion	pub.common.VersionRequest	pub.common.VersionResponse	Gets the api protocol version
SetState	pub.configuration.ConfigurationEnvelope	pub.configuration.ConfigurationEnvelope	Sets instrument configuration. Returns the updated configuration, result, and timestamp
GetState	pub.configuration.ConfigurationRequest	pub.configuration.ConfigurationEnvelope	Gets instrument configuration. The 'ConfigurationRequest' contains required instrument specific configuration type
StateStream	pub.configuration.ConfigurationRequest	pub.configuration.ConfigurationEnvelope stream	A stream which publishes all state changes on the instrument.

Scalar Value Types

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	float	float	Float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)