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

Update README.md

parent 64678383
No related branches found
No related tags found
No related merge requests found
...@@ -17,15 +17,15 @@ Locapack is distributed under the GPLv3 license. Please refer to the `LICENSE` f ...@@ -17,15 +17,15 @@ 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 | 2B | 1B (opt) | variable | 1B | variable |
|:--------:|:-----------------:|:-------------:|:----------------:|:-------------:|:-----------------------------:| |:--------:|:-----------------:|:-------------:|:-----------:|:-------------:|:-----------------------------:|
| `header` | `sequence_number` | `movement_id` | `source_address` | `payload_len` | `localisation_packet_payload` | | `header` | `sequence_number` | `movement_id` | `device_id` | `payload_len` | `localisation_packet_payload` |
The `sequence_number` field is mandatory. The `sequence_number` field is mandatory.
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.
The `source_address` field length is annouced in the header. A length of 0 means that the field is not present in the packet. The `device_id` field length is annouced in the header. A length of 0 means that the field is not present in the packet, for example if the `device_id` is the same as the source address of the packet.
The `payload_len` field contains the length of the payload. The `payload_len` field contains the length of the payload.
...@@ -34,13 +34,13 @@ The `localisation_packet_payload` length depends on the `localisation_packet_typ ...@@ -34,13 +34,13 @@ The `localisation_packet_payload` length depends on the `localisation_packet_typ
### Header structure ### Header structure
| 4b | 4b | 4b | 1b | 3b | | 4b | 4b | 4b | 1b | 3b |
|--------------------|-----------------------|----------------------------|-----------------------------|----------| |--------------------|------------------|----------------------------|-----------------------------|----------|
| `protocol_version` | `source_address_size` | `localisation_packet_type` | `movement_id_presence_flag` | reserved | | `protocol_version` | `device_id_size` | `localisation_packet_type` | `movement_id_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.
The `source_address_size` indicates the number of Bytes of the adresse of the sender. A length of 0 means that no source address is present in the packet. The `device_id_size` indicates the number of Bytes of the `device_id` field. A length of 0 means that no `device_id` is present in the packet.
The `localisation_packet_type` indicates the structure of the payload. These types of packet have been described: The `localisation_packet_type` indicates the structure of the payload. These types of packet have been described:
...@@ -53,7 +53,7 @@ The `movement_id_presence_flag` must be set to 1 if the `movement_id` field is p ...@@ -53,7 +53,7 @@ The `movement_id_presence_flag` must be set to 1 if the `movement_id` field is p
#### Type 0 : Universal GNSS localisation #### Type 0 : Universal GNSS localisation
Transport of GNSS coordinates. Transport of GNSS coordinates. Altitude and DOP are optionnal.
##### Payload general structure ##### Payload general structure
...@@ -81,7 +81,7 @@ The `dop_presence_flag` must be set to 1 if the `dop` field is present in the pa ...@@ -81,7 +81,7 @@ The `dop_presence_flag` must be set to 1 if the `dop` field is present in the pa
#### Type 1 : Locally referenced localisation #### Type 1 : Locally referenced localisation
Transport of locally referenced localisation Transport of locally referenced 2D or 3D localisation. The "repère" is identified by an UID.
#### Type 2 : Inter-node proximity #### Type 2 : Inter-node proximity
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment