Device Configuration Packet
| Device Configuration Packet | ||||
|---|---|---|---|---|
| Packet ID | 196 | |||
| Length | Varies | |||
| Read / Write | Read / Write | |||
| Field # | Bytes Offset | Data Type | Size | Description |
| 1 | 0 |
u16 |
2 | Device Type |
| 2 | 2 |
u16 |
2 | Device Key |
| 3 | 4 | u16 | 2 | Device Address |
| 4 | 6 | str | 16 | Display Name |
| 5 | 22 | u8 | 1 | Active Flag |
| + | Varies by device type, see sections Subsonus Device Packet and below | |||
Device Configuration Packet
Device Type
| Value | Description |
|---|---|
| 0 |
No Device |
| 1 |
Advanced Navigation Subsonus |
| 2 |
Advanced Navigation Subsonus Tag |
| 3 |
Advanced Navigation GNSS Compass |
| 4 |
Advanced Navigation INS |
| 5 |
Fixed Tone Pinger Generic |
| 6 |
Fixed Tone Transponder Generic |
| 7 |
Fixed Tone Transponder Benthowave |
| 8 |
Fixed Position Device |
| 9 |
Fixed Tone Pinger Emergency |
| 10 |
Hemisphere GNSS Compass |
| 11 |
WB2 Transponder |
| 12 |
Generic NMEA GNSS Compass |
| 13 |
Micron Transponder |
| 14 |
Advanced Navigation Spatial |
| 15 |
Advanced Navigation FOG |
| 16 |
Advanced Navigation Dual |
| 17 |
Advanced Navigation FOG Dual |
| 18 |
NMEA Depth Sensor |
| 19 |
Generic ANPP Device |
Device Type
Device Key
Device Key is a unique index that can be used to reference a device on the Subsonus. Device Keys are locally unique to the Subsonus and should be used to resolve Device Address conflicts.
| Value | Name | Description |
|---|---|---|
| 0 |
New Device |
Set Device Key to 0 to create a new Device |
| 1 | This Device |
The Subsonus device receiving the packet |
| 2 | Device Address |
Set to 2 to use the Device Address to refer to a device |
Device key
Device Address
Device Address is a user settable address used to index devices on the system. All devices need to be assigned a device address. Device Address is used for both acoustic tracking and data stream control.
| Value | Name | Description |
|---|---|---|
| 0 | Automatic | Device Address will be automatically assigned |
| 1-255 | Subsonus, Subsonus Tag | Range of valid Device Address for Subsonus and Subsonus Tag |
| 256-499 | Reserved | |
| 500-599 | 3rd Party Trackable | All trackable third party transponders and beacons |
| 600-699 | Non-Trackable | All non trackable devices |
| 700-65000 | Subsonus, Subsonus Tag | Range of valid Device Address for Subsonus and Subsonus Tag |
Device Address Ranges
Display Name
This field is a user settable display name for the Device, the display name is up to 15 characters long and requires a null termination in the string. Subsonus devices with a network connection will automatically update the display name to match the Subsonus host name, see Hostname Packet
Display names are limited to letters (a-z, A-Z), numbers (0-9), and the minus ‘-’ character as per the RFC 952 hostname standard.
Active Flag
Devices can be 1 - “Active” or 0 “Inactive”
Devices must be “Active” to be used by Subsonus. Automatically discovered devices are “Inactive”
To delete a device from the system, set this flag to “Inactive”
Tracked Flag
This flag can be enabled: 1 or disabled: 0. When enabled an acoustically trackable device will be scheduled for tracking by a Subsonus operating in Master mode.
Enable Flag
This flag can be set to enabled: 1 or disabled: 0. When enabled a device will be used as a position or heading aiding source.
Port and Hostname
The Port and Hostname refer to a TCP server that the Subsonus will connect to in order to communicate with the device. These settings are not required for a Subsonus device and will be automatically configured by device discovery if a change is detected by Subsonus.
External INS
This flag can be enabled: 1 or disabled: 0. When enabled Subsonus will use the device as an external INS instead of its internal INS.
Data Protocol
This settings allows setting of the acoustic data protocol used to communicate with the device when tracking.
| Value | Name | Description |
|---|---|---|
| 0 |
Automatic |
Tracking will attempt Fast tracking but automatically fall back to reliable in the event acoustic tracking is not performing |
| 1 |
High Reliability |
Slower acoustic data encoding with high redundancy for reliable communication |
| 2 |
High Speed |
Broadband signal encoding, with less redundancy for faster communication |
Data Protocol
Subsonus Device Packet
| Device Configuration Packet | ||||
|---|---|---|---|---|
| Packet ID | 196 | |||
| Length | 78 | |||
| Read / Write | Read / Write | |||
| Field # | Bytes Offset | Data Type | Size | Description |
| 1-5 | 0 | - | 23 | Common, see Device Configuration Packet |
| 6 | 23 | u16 | 2 | Port, see Port and Hostname |
| 7 | 25 | str | 32 | Hostname or IP address, see Port and Hostname |
| 8 | 57 | u8 | 1 | Tracked, see Tracked Flag |
| 9 | 58 | i32 | 4 | Operation Mode, (Read Only set to Zero) |
| 10 | 62 | u32 | 4 | Serial Number part 1, (Read Only set to Zero) |
| 11 | 66 | u32 | 4 | Serial Number part 2, (Read Only set to Zero) |
| 12 | 70 | u32 | 4 | Serial Number part 3, (Read Only set to Zero) |
| 13 | 74 | fp32 | 4 | Interrogation Period (sec) |
| 14 | 78 | u8 | 1 | Data Protocol, see Data Protocol |
Subsonus Device Configuration Packet
Subsonus Tag Device Packet
| Device Configuration Packet | ||||
|---|---|---|---|---|
| Packet ID | 196 | |||
| Length | 40 | |||
| Read / Write | Read / Write | |||
| Field # | Bytes Offset | Data Type | Size | Description |
| 1-5 | 0 | - | 23 | Common, see Device Configuration Packet |
| 6 | 23 | u8 | 1 | Tracked, see Tracked Flag |
| 7 | 24 | u32 | 4 | Serial Number part 1, (Read Only set to Zero) |
| 8 | 28 | u32 | 4 | Serial Number part 2, (Read Only set to Zero) |
| 9 | 32 | u32 | 4 | Serial Number part 3, (Read Only set to Zero) |
| 10 | 36 | fp32 | 4 | Interrogation Period (sec) |
| 11 | 40 | u8 | 1 | Data Protocol, see Data Protocol |
Subsonus Tag Device Configuration Packet
Advanced Navigation GNSS Compass
| Device Configuration Packet | ||||
|---|---|---|---|---|
| Packet ID | 196 | |||
| Length | 82 | |||
| Read / Write | Read / Write | |||
| Field # | Bytes Offset | Data Type | Size | Description |
| 1-5 | 0 | - | 23 | Common, see Device Configuration Packet |
| 6 | 23 | u16 | 2 | Port, see Port and Hostname |
| 7 | 25 | str | 32 | Hostname or IP address, see Port and Hostname |
| 8 | 57 | u32 | 4 | Serial Number part 1, (Read Only set to Zero) |
| 9 | 61 | u32 | 4 | Serial Number part 2, (Read Only set to Zero) |
| 10 | 65 | u32 | 4 | Serial Number part 3, (Read Only set to Zero) |
| 11 | 69 | u8 | 1 | Enable, see Enable Flag |
| 12 | 70 | fp32 | 4 | Offset X (m) |
| 13 | 74 | fp32 | 4 | Offset Y (m) |
| 14 | 78 | fp32 | 4 | Offset Z (m) |
GNSS Compass Device Configuration Packet
Advanced Navigation INS
| Device Configuration Packet | ||||
|---|---|---|---|---|
| Packet ID | 196 | |||
| Length | 83 | |||
| Read / Write | Read / Write | |||
| Field # | Bytes Offset | Data Type | Size | Description |
| 1-5 | 0 | - | 23 | Common, see Device Configuration Packet |
| 6 | 23 | u16 | 2 | Port, see Port and Hostname |
| 7 | 25 | str | 32 | Hostname or IP address, see Port and Hostname |
| 8 | 57 | u32 | 4 | Serial Number part 1, (Read Only set to Zero) |
| 9 | 61 | u32 | 4 | Serial Number part 2, (Read Only set to Zero) |
| 10 | 65 | u32 | 4 | Serial Number part 3, (Read Only set to Zero) |
| 11 | 69 | u8 | 1 | External INS |
| 12 | 70 | u8 | 1 | Enable, see Enable Flag |
| 13 | 71 | fp32 | 4 | Offset X (m) |
| 14 | 75 | fp32 | 4 | Offset Y (m) |
| 15 | 79 | fp32 | 4 | Offset Z (m) |
Advanced Navigation INS Device Configuration Packet
Advanced Navigation Spatial INS
| Device Configuration Packet | ||||
|---|---|---|---|---|
| Packet ID | 196 | |||
| Length | 82 | |||
| Read / Write | Read / Write | |||
| Field # | Bytes Offset | Data Type | Size | Description |
| 1-5 | 0 | - | 23 | Common, see Device Configuration Packet |
| 6 | 23 | u16 | 2 | Port, see Port and Hostname |
| 7 | 25 | str | 32 | Hostname or IP address, see Port and Hostname |
| 8 | 57 | u32 | 4 | Serial Number part 1, (Read Only set to Zero) |
| 9 | 61 | u32 | 4 | Serial Number part 2, (Read Only set to Zero) |
| 10 | 65 | u32 | 4 | Serial Number part 3, (Read Only set to Zero) |
| 11 | 69 | u8 | 1 | External INS |
| 12 | 70 | fp32 | 4 | Offset X (m) |
| 13 | 74 | fp32 | 4 | Offset Y (m) |
| 14 | 78 | fp32 | 4 | Offset Z (m) |
Spatial INS Device Configuration Packet
Advanced Navigation Spatial FOG INS
| Device Configuration Packet | ||||
|---|---|---|---|---|
| Packet ID | 196 | |||
| Length | 82 | |||
| Read / Write | Read / Write | |||
| Field # | Bytes Offset | Data Type | Size | Description |
| 1-5 | 0 | - | 23 | Common, see Device Configuration Packet |
| 6 | 23 | u16 | 2 | Port, see Port and Hostname |
| 7 | 25 | str | 32 | Hostname or IP address, see Port and Hostname |
| 8 | 57 | u32 | 4 | Serial Number part 1, (Read Only set to Zero) |
| 9 | 61 | u32 | 4 | Serial Number part 2, (Read Only set to Zero) |
| 10 | 65 | u32 | 4 | Serial Number part 3, (Read Only set to Zero) |
| 11 | 69 | u8 | 1 | External INS |
| 12 | 70 | fp32 | 4 | Offset X (m) |
| 13 | 74 | fp32 | 4 | Offset Y (m) |
| 14 | 78 | fp32 | 4 | Offset Z (m) |
Spatial FOG Device Configuration Packet
Advanced Navigation Dual INS
| Device Configuration Packet | ||||
|---|---|---|---|---|
| Packet ID | 196 | |||
| Length | 83 | |||
| Read / Write | Read / Write | |||
| Field # | Bytes Offset | Data Type | Size | Description |
| 1-5 | 0 | - | 23 | Common, see Device Configuration Packet |
| 6 | 23 | u16 | 2 | Port, see Port and Hostname |
| 7 | 25 | str | 32 | Hostname or IP address, see Port and Hostname |
| 8 | 57 | u32 | 4 | Serial Number part 1, (Read Only set to Zero) |
| 9 | 61 | u32 | 4 | Serial Number part 2, (Read Only set to Zero) |
| 10 | 65 | u32 | 4 | Serial Number part 3, (Read Only set to Zero) |
| 11 | 69 | u8 | 1 | External INS |
| 12 | 70 | u8 | 1 | Enable, see Enable Flag |
| 13 | 71 | fp32 | 4 | Offset X (m) |
| 14 | 75 | fp32 | 4 | Offset Y (m) |
| 15 | 79 | fp32 | 4 | Offset Z (m) |
Advanced NavigationDual INS Device Configuration Packet
Advanced Navigation FOG Dual INS
| Device Configuration Packet | ||||
|---|---|---|---|---|
| Packet ID | 196 | |||
| Length | 83 | |||
| Read / Write | Read / Write | |||
| Field # | Bytes Offset | Data Type | Size | Description |
| 1-5 | 0 | - | 23 | Common, see Device Configuration Packet |
| 6 | 23 | u16 | 2 | Port, see Port and Hostname |
| 7 | 25 | str | 32 | Hostname or IP address, see Port and Hostname |
| 8 | 57 | u32 | 4 | Serial Number part 1, (Read Only set to Zero) |
| 9 | 61 | u32 | 4 | Serial Number part 2, (Read Only set to Zero) |
| 10 | 65 | u32 | 4 | Serial Number part 3, (Read Only set to Zero) |
| 11 | 69 | u8 | 1 | External INS |
| 12 | 70 | u8 | 1 | Enable, see Enable Flag |
| 13 | 71 | fp32 | 4 | Offset X (m) |
| 14 | 75 | fp32 | 4 | Offset Y (m) |
| 15 | 79 | fp32 | 4 | Offset Z (m) |
FOG Dual INS Device Configuration Packet
Generic NMEA GNSS Compass
| Device Configuration Packet | ||||
|---|---|---|---|---|
| Packet ID | 196 | |||
| Length | 70 | |||
| Read / Write | Read / Write | |||
| Field # | Bytes Offset | Data Type | Size | Description |
| 1-5 | 0 | - | 23 | Common, see Device Configuration Packet |
| 6 | 23 | u16 | 2 | Port, see Port and Hostname |
| 7 | 25 | str | 32 | Hostname or IP address, see Port and Hostname |
| 8 | 57 | u8 | 1 | Enable, see Enable Flag |
| 9 | 58 | fp32 | 4 | Offset X (m) |
| 10 | 62 | fp32 | 4 | Offset Y (m) |
| 11 | 66 | fp32 | 4 | Offset Z (m) |
Generic NMEA GNSS Compass Device Configuration Packet
Hemisphere GNSS Compass
| Device Configuration Packet | ||||
|---|---|---|---|---|
| Packet ID | 196 | |||
| Length | 70 | |||
| Read / Write | Read / Write | |||
| Field # | Bytes Offset | Data Type | Size | Description |
| 1-5 | 0 | - | 23 | Common, see Device Configuration Packet |
| 6 | 23 | u16 | 2 | Port, see Port and Hostname |
| 7 | 25 | str | 32 | Hostname or IP address, see Port and Hostname |
| 8 | 57 | u8 | 1 | Enable, see Enable Flag |
| 9 | 58 | fp32 | 4 | Offset X (m) |
| 10 | 62 | fp32 | 4 | Offset Y (m) |
| 11 | 66 | fp32 | 4 | Offset Z (m) |
Hemisphere GNSS Compass Device Configuration Packet
NMEA Depth Sensor
| Device Configuration Packet | ||||
|---|---|---|---|---|
| Packet ID | 196 | |||
| Length | 70 | |||
| Read / Write | Read / Write | |||
| Field # | Bytes Offset | Data Type | Size | Description |
| 1-5 | 0 | - | 23 | Common, see Device Configuration Packet |
| 6 | 23 | u16 | 2 | Port, see Port and Hostname |
| 7 | 25 | str | 32 | Hostname or IP address, see Port and Hostname |
| 8 | 57 | u8 | 1 | Enable, see Enable Flag |
| 9 | 58 | fp32 | 4 | Offset X (m) |
| 10 | 62 | fp32 | 4 | Offset Y (m) |
| 11 | 66 | fp32 | 4 | Offset Z (m) |
NMEA Depth Sensor Configuration Packet
Generic ANPP Device
| Device Configuration Packet | ||||
|---|---|---|---|---|
| Packet ID | 196 | |||
| Length | 82 | |||
| Read / Write | Read / Write | |||
| Field # | Bytes Offset | Data Type | Size | Description |
| 1-5 | 0 | - | 23 | Common, see Device Configuration Packet |
| 6 | 23 | u16 | 2 | Port, see Port and Hostname |
| 7 | 25 | str | 32 | Hostname or IP address, see Port and Hostname |
| 8 | 57 | u8 | 1 | Enable, see Enable Flag |
| 9 | 58 | fp32 | 4 | Offset X (m) |
| 10 | 62 | fp32 | 4 | Offset Y (m) |
| 11 | 66 | fp32 | 4 | Offset Z (m) |
| 12 | 70 | fp32 | 4 | Alignment X (radians) |
| 13 | 74 | fp32 | 4 | Alignment Y (radians) |
| 14 | 78 | fp32 | 4 | Alignment Z (radians) |
Generic ANPP Device Configuration Packet
Fixed Position Device
| Device Configuration Packet | ||||
|---|---|---|---|---|
| Packet ID | 196 | |||
| Length | 47 | |||
| Read / Write | Read / Write | |||
| Field # | Bytes Offset | Data Type | Size | Description |
| 1-5 | 0 | - | 23 | Common, see Device Configuration Packet |
| 6 | 23 | fp64 | 8 | Latitude (rad) |
| 7 | 31 | fp64 | 8 | Longitude (rad) |
| 8 | 39 | fp64 | 8 | Height (m) |
Fixed Position Device Configuration Packet
Generic Fixed Tone Pinger
| Device Configuration Packet | ||||
|---|---|---|---|---|
| Packet ID | 196 | |||
| Length | 36 | |||
| Read / Write | Read / Write | |||
| Field # | Bytes Offset | Data Type | Size | Description |
| 1-5 | 0 | - | 23 | Common, see Device Configuration Packet |
| 6 | 23 | u8 | 1 | Tracked, see Tracked Flag |
| 7 | 24 | fp32 | 4 | Transmit Frequency (Hz) |
| 8 | 28 | fp32 | 4 | Transmit Duration (sec) |
| 9 | 32 | fp32 | 4 | Acoustic Echo Time (sec) |
Fixed Tone Pinger Device Configuration Packet
Fixed Tone Emergency Pinger
| Device Configuration Packet | ||||
|---|---|---|---|---|
| Packet ID | 196 | |||
| Length | 24 | |||
| Read / Write | Read / Write | |||
| Field # | Bytes Offset | Data Type | Size | Description |
| 1-5 | 0 | - | 23 | Common, see Device Configuration Packet |
| 6 | 23 | u8 | 1 | Tracked, see Tracked Flag |
Fixed Tone Emergency Pinger Device Configuration Packet
Generic Fixed Tone Transponder
| Device Configuration Packet | ||||
|---|---|---|---|---|
| Packet ID | 196 | |||
| Length | 48 | |||
| Read / Write | Read / Write | |||
| Field # | Bytes Offset | Data Type | Size | Description |
| 1-5 | 0 | - | 23 | Common, see Device Configuration Packet |
| 6 | 23 | u8 | 1 | Tracked, see Tracked Flag |
| 7 | 24 | fp32 | 4 | Interrogation Period (sec) |
| 8 | 28 | fp32 | 4 | Interrogation Duration (sec) |
| 9 | 32 | fp32 | 4 | Interrogation Frequency (Hz) |
| 10 | 36 | fp32 | 4 | Transmit Frequency (Hz) |
| 11 | 40 | fp32 | 4 | Transmit Duration (sec) |
| 12 | 44 | fp32 | 4 | Reply Delay (sec) |
Fixed Tone Transponder Device Configuration Packet
Benthowave Fixed Tone Transponder
| Device Configuration Packet | ||||
|---|---|---|---|---|
| Packet ID | 196 | |||
| Length | 49 | |||
| Read / Write | Read / Write | |||
| Field # | Bytes Offset | Data Type | Size | Description |
| 1-5 | 0 | - | 23 | Common, see Device Configuration Packet |
| 6 | 23 | u8 | 1 | Tracked, see Tracked Flag |
| 7 | 24 | fp32 | 4 | Interrogation Period (sec) |
| 8 | 28 | fp32 | 4 | Interrogation Duration (sec) |
| 9 | 32 | fp32 | 4 | Interrogation Frequency (Hz) |
| 10 | 36 | fp32 | 4 | Transmit Frequency (Hz) |
| 11 | 40 | fp32 | 4 | Transmit Duration (sec) |
| 12 | 44 | fp32 | 4 | Reply Delay (sec) |
| 13 | 48 | u8 | 1 | One Way Delay |
Benthowave Fixed Tone Transponder Device Configuration Packet
WB2 Transponder
| Device Configuration Packet | ||||
|---|---|---|---|---|
| Packet ID | 196 | |||
| Length | 37 | |||
| Read / Write | Read / Write | |||
| Field # | Bytes Offset | Data Type | Size | Description |
| 1-5 | 0 | - | 23 | Common, see Device Configuration Packet |
| 6 | 23 | u8 | 1 | Tracked, see Tracked Flag |
| 7 | 24 | u8 | 1 | Wake Enable |
| 8 | 25 | u16 | 2 | Reply Code |
| 9 | 27 | u16 | 2 | Interrogation Code |
| 10 | 29 | fp32 | 4 | Interrogation Period (sec) |
| 11 | 33 | fp32 | 4 | Reply Delay (sec) |
WB2 Transponder Device Configuration Packet
Micron Transponder
| Device Configuration Packet | ||||
|---|---|---|---|---|
| Packet ID | 196 | |||
| Length | 30 | |||
| Read / Write | Read / Write | |||
| Field # | Bytes Offset | Data Type | Size | Description |
| 1-5 | 0 | - | 23 | Common, see Device Configuration Packet |
| 6 | 23 | u8 | 1 | Tracked, see Tracked Flag |
| 7 | 24 | u16 | 2 | Interrogation Code |
| 8 | 26 | fp32 | 4 | Interrogation Period (sec) |
Micron Transponder Device Configuration Packet