diff --git a/README.md b/README.md index 616f014c37829a0090334da6f37f0a6d1f6d75b5..eb3cbd0fdeb060592312c375940f73cfc907ea24 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Message endianness is little endian. | 2B | 2B | 0/5B | 1B (opt) | variable | 1B | variable | |:--------:|:-----------------:|:-----------:|:-------------:|:-----------:|:-------------:|:-----------------------------:| -| `header` | `sequence_number` | `timestamp` | `movement_id` | `device_id` | `payload_len` | `localisation_packet_payload` | +| `header` | `sequence_number` | `timestamp` | `movement_id` | `device_id` | `payload_len` | `payload` | The `sequence_number` field is mandatory. @@ -33,20 +33,20 @@ The `device_id` field length is annouced in the header. A length of 0 means that The `payload_len` field contains the length of the payload. -The `localisation_packet_payload` length depends on the `localisation_packet_type` annouced in the header. +The `payload` length depends on the `packet_type` annouced in the header. ### Header structure -| MSB 4b | 4b | 4b | 1b | 1b | 2b LSB | -|--------------------|------------------|----------------------------|-----------------------------|---------------------------|----------| -| `protocol_version` | `device_id_size` | `localisation_packet_type` | `movement_id_presence_flag` | `timestamp_presence_flag` | reserved | +| MSB 4b | 4b | 4b | 1b | 1b | 2b LSB | +|--------------------|------------------|---------------|-----------------------------|---------------------------|----------| +| `protocol_version` | `device_id_size` | `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 `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 `packet_type` indicates the structure of the payload. These types of packet have been described: * `type 0` : Universal GNSS localisation * `type 1` : Locally referenced localisation