From 5c0c34c58dd6d8eba08ca86de65dda739d6e5507 Mon Sep 17 00:00:00 2001
From: Adrien van den Bossche <vandenbo@univ-tlse2.fr>
Date: Tue, 23 Jun 2020 18:14:45 +0200
Subject: [PATCH] Update README.md
---
README.md | 23 ++++++++++++++---------
1 file changed, 14 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
index db1f3b4..f15f5e3 100644
--- a/README.md
+++ b/README.md
@@ -15,7 +15,7 @@ LocaPack enables the transport of:
Some extra features are also avalable, such as:
- automatic mapping/translation of coordonates between universal GNSS/locally referenced localisations,
-- movement_id, that enables extra movement information (typically based on a local accelerometer),
+- movement_id, that enables extra movement information based on another sensor (typically a local accelerometer),
- packet sequence numbering and local timestamping, to track positions and detect missing information,
- message hashing, to send shorter but incomplete payloads, to respect privacy.
@@ -28,6 +28,11 @@ A Json description of the messages is also available.
## Implementation
+Implementation status:
+
+- Arduino: encode/decode header, encode/decode universal GNSS packets ; example sketch with GPS receiver.
+- Node-RED: decode header, decode universal GNSS packets
+
### Arduino
LocaPack is available as an Arduino library, to produce or decode locapack messages.
@@ -166,9 +171,9 @@ Transport of locally referenced 2D or 3D localisation. The "repère" is identifi
##### Payload general structure
-| 1B | 4B | 4B | 0/4B | 0/4B | 0/8B |
-|----------|-----|-----|------|-------|-------------|
-| `header` | `x` | `y` | `z` | `dop` | `repere_id` |
+| 1B | 4B | 4B | 0/4B | 0/4B | 0/8B |
+|----------|-----|-----|------|-------|-----------------|
+| `header` | `x` | `y` | `z` | `dop` | `frameofref_id` |
The `x` field is a C-type float and is mandatory.
@@ -178,19 +183,19 @@ The `z` field is a C-type float and its presence is annouced in the `header`
The `dop` field is a C-type float and its presence is annouced in the `header`
-The `repere_id` field is a 64-bit UID and its presence is annouced in the `header`
+The `frameofref_id` field is a 64-bit UID that identify the Frame of Reference ("le repère utilisé") and its presence is annouced in the `header`
##### Header
-| 1b | 1b | 1b | 5b |
-|-------------------|---------------------|----------------------------|----------|
-| `z_presence_flag` | `dop_presence_flag` | `repere_id_presence_flag` | reserved |
+| 1b | 1b | 1b | 5b |
+|-------------------|---------------------|--------------------------------|----------|
+| `z_presence_flag` | `dop_presence_flag` | `frameofref_id_presence_flag` | reserved |
The `z_presence_flag` must be set to 1 if the `z` field is present in the packet (3D localisation).
The `dop_presence_flag` must be set to 1 if the `dop` field is present in the packet.
-The `repere_id_presence_flag` must be set to 1 if the `repere_id` field is present in the packet.
+The `frameofref_id_presence_flag` must be set to 1 if the `frameofref_id` field is present in the packet.
#### Type 2 : Inter-node proximity
--
GitLab