Skip to content
Snippets Groups Projects
Commit 6a30713b authored by Adrien van den Bossche's avatar Adrien van den Bossche
Browse files

Update README.md

parent 1b242fa4
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 11 additions and 7 deletions
README.md
+ 11
− 7
View file @ 6a30713b
...@@ -17,11 +17,13 @@ Locapack is distributed under the GPLv3 license. Please refer to the `LICENSE` f ...@@ -17,11 +17,13 @@ Locapack is distributed under the GPLv3 license. Please refer to the `LICENSE` f
### Packet general structure ### Packet general structure
| 2B | 2B | 1B (opt) | variable | 1B | variable | | 2B | 0/5B | 2B | 1B (opt) | variable | 1B | variable |
|:--------:|:-----------------:|:-------------:|:-----------:|:-------------:|:-----------------------------:| |:--------:|:-----------:|:-----------------:|:-------------:|:-----------:|:-------------:|:-----------------------------:|
| `header` | `sequence_number` | `movement_id` | `device_id` | `payload_len` | `localisation_packet_payload` | | `header` | `timestamp` | `sequence_number` | `movement_id` | `device_id` | `payload_len` | `localisation_packet_payload` |
The `sequence_number` field is mandatory. The `sequence_number` field is mandatory.
The `timestamp` field is optional and its presence is announced in the header. The timestamp field contains the number of milliseconds since the boot of the local system.
The `movement_id` field is optional and its presence is announced in the header. The `movement_id` field is optional and its presence is announced in the header.
...@@ -34,9 +36,9 @@ The `localisation_packet_payload` length depends on the `localisation_packet_typ ...@@ -34,9 +36,9 @@ The `localisation_packet_payload` length depends on the `localisation_packet_typ
### Header structure ### Header structure
| 4b | 4b | 4b | 1b | 3b | | 4b | 4b | 4b | 1b | 1b | 2b |
|--------------------|------------------|----------------------------|-----------------------------|----------| |--------------------|------------------|----------------------------|-----------------------------|---------------------------|----------|
| `protocol_version` | `device_id_size` | `localisation_packet_type` | `movement_id_presence_flag` | reserved | | `protocol_version` | `device_id_size` | `localisation_packet_type` | `movement_id_presence_flag` | `timestamp_presence_flag` | reserved |
The `protocol_version` field indicates the version of the localisation packet used. This documentation describes the version #1 of the localisation packet protocol. The `protocol_version` field indicates the version of the localisation packet used. This documentation describes the version #1 of the localisation packet protocol.
...@@ -50,6 +52,8 @@ The `localisation_packet_type` indicates the structure of the payload. These typ ...@@ -50,6 +52,8 @@ The `localisation_packet_type` indicates the structure of the payload. These typ
The `movement_id_presence_flag` must be set to 1 if the `movement_id` field is present in the packet. The `movement_id_presence_flag` must be set to 1 if the `movement_id` field is present in the packet.
The `timestamp_presence_flag` must be set to 1 if the `timestamp` field is present in the packet.
### Payload structure by packet type ### Payload structure by packet type
#### Type 0 : Universal GNSS localisation #### Type 0 : Universal GNSS localisation
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment