System Packets
Acknowledge Packet
| Acknowledgement Packet | ||||
|---|---|---|---|---|
| Packet ID | 0 | |||
| Length | 4 | |||
| Read / Write | Read | |||
| Field # | Bytes Offset | Data Type | Size | Description |
| 1 | 0 | u8 | 1 | Packet ID being acknowledged |
| 2 | 1 | u16 | 2 | CRC of packet being acknowledged |
| 3 | 3 | u8 | 1 | Acknowledge Result |
Acknowledge Packet
Acknowledge Result
| Value | Description |
|---|---|
| 0 | Acknowledge success |
| 1 | Acknowledge failure, CRC error |
| 2 | Acknowledge failure, packet size incorrect |
| 3 | Acknowledge failure, values outside of valid ranges |
| 4 | Acknowledge failure, system flash memory failure |
| 5 | Acknowledge failure, system not ready |
| 6 | Acknowledge failure, unknown packet |
Acknowledge Result
Request Packet
| Request Packet | ||||
|---|---|---|---|---|
| Packet ID | 1 | |||
| Length | 1 x number of packets requested | |||
| Read / Write | Write | |||
| Field # | Bytes Offset | Data Type | Size | Description |
| 1 | 0 | u8 | 1 | Packet ID requested |
| + | Field 1 repeats for additional packet requests | |||
Request Packet
Boot Mode Packet
| Boot Mode Packet | ||||
|---|---|---|---|---|
| Packet ID | 2 | |||
| Length | 1 | |||
| Read / Write | Read / Write | |||
| Field # | Bytes Offset | Data Type | Size | Description |
| 1 | 0 | u8 | 1 | Boot Mode Types |
Boot Mode Packet
Boot Mode Types
| Value | Description |
|---|---|
| 0 | Bootloader |
| 1 | Main Program |
Boot Mode Types
Device Information Packet
| Device Information Packet | ||||
|---|---|---|---|---|
| Packet ID | 3 | |||
| Length | 24 | |||
| Read / Write | Read | |||
| Field # | Bytes Offset | Data Type | Size | Description |
| 1 | 0 | u32 | 4 | Software version |
| 2 | 4 | u32 | 4 | Device ID |
| 3 | 8 | u32 | 4 | Hardware revision |
| 4 | 12 | u32 | 4 | Boreas Serial number part 1 |
| 5 | 16 | u32 | 4 | Boreas Serial number part 2 |
| 6 | 20 | u32 | 4 | Boreas Serial number part 3 |
Device Information Packet
Device ID
| Value | Description |
|---|---|
| 1 | Spatial |
| 4 | Spatial FOG |
| 5 | Spatial Dual |
| 11 | Orientus (>v3) |
| 13 | Air Data Unit |
| 14 | Subsonus |
| 16 | Spatial FOG Dual |
| 17 | Motus |
| 19 | GNSS Compass |
| 21 | Subsonus Tag |
| 22 | Poseidon |
| 26 | Certus |
| 27 | Aries |
| 28 | Boreas D90 |
| 41 | Boreas D70 |
Device IDs
Restore Factory Settings Packet
Note: A Factory Reset will re-enable the DHCP Client and lose any static IP address settings.
| Restore Factory Settings Packet | ||||
|---|---|---|---|---|
| Packet ID | 4 | |||
| Length | 4 | |||
| Read / Write | Write | |||
| Field # | Bytes Offset | Data Type | Size | Description |
| 1 | 0 | u32 | 4 | Verification sequence (set to 0x85429E1C) |
Restore Factory Settings Packet
Reset Packet
| Reset Packet | ||||
|---|---|---|---|---|
| Packet ID | 5 | |||
| Length | 4 | |||
| Read / Write | Write | |||
| Field # | Bytes Offset | Data Type | Size | Description |
| 1 | 0 | u32 | 4 | Verification Sequence Values |
Reset Packet
Verification Sequence Values
| Value | Description |
|---|---|
| 0x21057A7E | Standard hot start reset |
| 0x9A5D38B7 | Cold start reset |
Verification Sequence Values
Serial Port Passthrough Packet
| Serial Port Passthrough Packet | ||||
|---|---|---|---|---|
| Packet ID | 10 | |||
| Length | Variable, up to 255 bytes | |||
| Read / Write | Read / Write | |||
| Field # | Bytes Offset | Data Type | Size | Description |
| 1 | 0 | u8 | 1 | Passthrough Route |
| 2 | 1 | Passthrough Data | ||
Serial Port Passthrough Packet
Passthrough Route
| Value | Description |
|---|---|
| 1 |
|
| 2 | Auxiliary |
Passthrough Route
IP Configuration Packet
| IP Configuration Packet | ||||
|---|---|---|---|---|
| Packet ID | 11 | |||
| Length | 30 | |||
| Read / Write | Read / Write | |||
| Field # | Bytes Offset | Data Type | Size | Description |
| 1 | 0 | u8 | 1 | Permanent |
| 2 | 1 | u8 | 1 | DHCP Mode |
| 3 | 2 | u32 | 4 | IP Address |
| 4 | 6 | u32 | 4 | IP Netmask |
| 5 | 10 | u32 | 4 | IP Gateway |
| 6 | 14 | u32 | 4 | DNS Server |
| 7 | 18 | u32 | 4 | Boreas Serial number part 1 |
| 8 | 22 | u32 | 4 | Boreas Serial number part 2 |
| 9 | 26 | u32 | 4 | Boreas Serial number part 3 |
IP Configuration Packet
DHCP Mode
| Bit | Description |
|---|---|
| 0 | DHCP Enabled |
| 1 | Automatic DNS |
| 2-4 | Link Mode. See Link Mode Index |
| 5-7 | Reserved (set to zero) |
DHCP Mode
Discovery Network Setting Overwrite
Settings 7,8 and 9 are optional over standard network interfaces but required to overwrite settings over multi-cast discovery. To overwrite network settings for a device over multi-cast send this packet to address 239.48.81.7 port 48817, the serial number must be set to the serial number of the device you want to overwrite settings for.