More protocol docs.
This commit is contained in:
@@ -1,20 +1,54 @@
|
|||||||
message AdsbHeader {
|
message AdsbHeader {
|
||||||
|
// Always "aDsB"
|
||||||
required string magic = 1;
|
required string magic = 1;
|
||||||
|
|
||||||
|
// Unique identifier for this server implementation
|
||||||
|
// Recommended: "https://url/of/source#version"
|
||||||
required string server_version = 2;
|
required string server_version = 2;
|
||||||
|
|
||||||
|
// Unique identifier for this server instance
|
||||||
|
// UUID recommended
|
||||||
|
// 36 character limit
|
||||||
required string server_id = 3;
|
required string server_id = 3;
|
||||||
|
|
||||||
|
// MHz of the clock used in subsequent mlat_timestamp fields
|
||||||
required fixed32 mlat_timestamp_mhz = 4;
|
required fixed32 mlat_timestamp_mhz = 4;
|
||||||
|
|
||||||
|
// Maximum value of subsequent mlat_timestamp fields, at which point values are expected to wrap
|
||||||
required fixed64 mlat_timestamp_max = 5;
|
required fixed64 mlat_timestamp_max = 5;
|
||||||
|
|
||||||
|
// Maximum value of subsequent rssi fields
|
||||||
required fixed32 rssi_max = 6;
|
required fixed32 rssi_max = 6;
|
||||||
}
|
}
|
||||||
|
|
||||||
message AdsbPacket {
|
message AdsbPacket {
|
||||||
|
// Unique value for the source that recorded this packet
|
||||||
|
// UUID recommended
|
||||||
|
// 36 character limit
|
||||||
required string source_id = 1;
|
required string source_id = 1;
|
||||||
|
|
||||||
|
// Value of the MLAT counter when this packet arrived at the recorder
|
||||||
|
// Range [0, mlat_timestamp_max]
|
||||||
|
// Units of 1 / (mlat_timestamp_mhz * 10^6) Hz
|
||||||
optional fixed64 mlat_timestamp = 2;
|
optional fixed64 mlat_timestamp = 2;
|
||||||
|
|
||||||
|
// RSSI of the received packet at the recorder
|
||||||
|
// Range [0, rssi_max]
|
||||||
|
// Units unspecified
|
||||||
optional fixed32 rssi = 3;
|
optional fixed32 rssi = 3;
|
||||||
|
|
||||||
|
// Binary packet payload.
|
||||||
|
// Length:
|
||||||
|
// mode_ac: 2 bytes
|
||||||
|
// mode_s_short: 7 bytes
|
||||||
|
// mode_s_long: 14 bytes
|
||||||
required bytes payload = 4;
|
required bytes payload = 4;
|
||||||
}
|
}
|
||||||
|
|
||||||
message Adsb {
|
message Adsb {
|
||||||
|
// Each message must contain exactly one; zero is invalid.
|
||||||
|
// The first record of a stream must be a header.
|
||||||
|
// Subsequent records may be in any order, including additional headers.
|
||||||
oneof record {
|
oneof record {
|
||||||
AdsbHeader header = 1;
|
AdsbHeader header = 1;
|
||||||
AdsbPacket mode_ac = 2;
|
AdsbPacket mode_ac = 2;
|
||||||
@@ -23,6 +57,9 @@ message Adsb {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// adsbus proto serialization takes advantage of the fact that an AdsbStream
|
||||||
|
// with many messages and many AdsbStreams each with a single message encode
|
||||||
|
// identically.
|
||||||
message AdsbStream {
|
message AdsbStream {
|
||||||
repeated Adsb msg = 1;
|
repeated Adsb msg = 1;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -21,7 +21,7 @@ additional headers.
|
|||||||
## Header
|
## Header
|
||||||
* `type`: `header`
|
* `type`: `header`
|
||||||
* `magic`: `aDsB`
|
* `magic`: `aDsB`
|
||||||
* `server_version`: (string) unqiue identifier for this server implementation. `https://url/of/source#version` recommended
|
* `server_version`: (string) unique identifier for this server implementation. `https://url/of/source#version` recommended
|
||||||
* `server_id`: (string) unique identifier for this server instance. [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) recommended; 36 character limit
|
* `server_id`: (string) unique identifier for this server instance. [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) recommended; 36 character limit
|
||||||
* `mlat_timestamp_mhz`: (integer) MHz of the clock used in subsequent `mlat_timestamp` fields
|
* `mlat_timestamp_mhz`: (integer) MHz of the clock used in subsequent `mlat_timestamp` fields
|
||||||
* `mlat_timestamp_max`: (integer) maximum value of subsequent `mlat_timestamp` fields, at which point values are expected to wrap
|
* `mlat_timestamp_max`: (integer) maximum value of subsequent `mlat_timestamp` fields, at which point values are expected to wrap
|
||||||
@@ -35,7 +35,7 @@ additional headers.
|
|||||||
* `Mode-S long` (see [Packet](#packet); 28 byte payload, 14 bytes when decoded)
|
* `Mode-S long` (see [Packet](#packet); 28 byte payload, 14 bytes when decoded)
|
||||||
* `source_id`: (string) unique value for the source that recorded this packet. [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) recommended; 36 character limit
|
* `source_id`: (string) unique value for the source that recorded this packet. [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) recommended; 36 character limit
|
||||||
* `mlat_timestamp`: (integer) value of the [MLAT](https://en.wikipedia.org/wiki/Multilateration) counter when this packet arrived at the recorder, range [0, `mlat_timestamp_max`], in units of 1 / (`mlat_timestamp_mhz` * 10^6) Hz
|
* `mlat_timestamp`: (integer) value of the [MLAT](https://en.wikipedia.org/wiki/Multilateration) counter when this packet arrived at the recorder, range [0, `mlat_timestamp_max`], in units of 1 / (`mlat_timestamp_mhz` * 10^6) Hz
|
||||||
* `rssi`: (integer) [RSSI](https://en.wikipedia.org/wiki/Received_signal_strength_indication) of the receiver packet at the recorder, range [0, `rssi_max`], units unspecified
|
* `rssi`: (integer) [RSSI](https://en.wikipedia.org/wiki/Received_signal_strength_indication) of the received packet at the recorder, range [0, `rssi_max`], units unspecified
|
||||||
* `payload`: upper-case, hex-encoded. see `type` for length
|
* `payload`: upper-case, hex-encoded. see `type` for length
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user