diff --git a/README.md b/README.md index ecc8605bd4a861338646ec084791735231719c57..53800a94654fa7cbe1c2fad40c997831706a4d07 100644 --- a/README.md +++ b/README.md @@ -4,17 +4,26 @@ Another localisation packet protocol to send/receive localisation data over networks. +## Details + +LocaPack is an implementation of the locapack protocol used to send or receive various localisation data over wired and wireless networks. + LocaPack enables the transport of: -- universal GNSS localisation coordonates, -- locally referenced localisations, such as indoor environments, with automatic mapping of coordonates in a universal GNSS translation, -- inter-node proximity informations such as ranging data +- universal GNSS localisation coordonates such as latitude/longitude data, +- locally referenced localisations, such as {x,y} positions in an indoor environment, +- inter-node proximity information such as ranging data. + +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) +- packet sequence numbering and local timestamping, to track positions and detect missing information Several implementations are available: - Embedded: C++ class (Arduino) - Infrastrucure/IoT: Node-RED palette - Portable: python -A Json description of the messages. +A Json description of the messages is also available. ## Implementation