Update README.md

This commit is contained in:
Olaf Landsiedel 2020-06-10 16:38:30 +02:00 committed by GitHub
parent a399c1055d
commit b998223a6b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 10 deletions

View File

@ -1,24 +1,26 @@
# Covid Bracelet
# Covid Bracelet, compatabile to iOS and Adroid
**Contributions Welcome!** Based on Zephyr OS and NRF52 BLE SOCs
## Get Started:
We use Zepyhr master as we need a newer mbed TLS as the ones that ships with Zephyr 2.2. We are waiting for the Zepyhr 2.3 release. To build, please install Zephyr and compile via west. Note that Platform.io does not support Zephyr 2.3 rc / Zepyhr master at the current time.
**Contributions Welcome!**
## Features
* Code sends out and receives exposure beacons as specified by Google and Apple for Covid Contact Tracing
* Sends and receives exposure beacons as specified by Google and Apple for Covid Contact Tracing
* Rolling, encrypted, anonymous beacons
* Compatible with Apple iOS and Android phones
* with rolling proximity identifiers and encrypted metadata
* proximity identifiers and BLE addresses change every 10 minutes
* stores own keys for 14 days
* stores contacts with more than 5 minute duration
* With rolling proximity identifiers and encrypted metadata
* Proximity identifiers and BLE addresses change every 10 minutes
* Stores own keys for 14 days
* Stores contacts of more than 5 minute duration
* Upon infection upload keys to a public database
* Retrieve keys of infections from database
* computes rolling proximity identifiers
* compares to stored contacts to check for exposure
* Note: as we do not use the flash for key storage, this only works on nrf52480 or you can just store a very small number of keys
Based on Zephyr OS and NRF52 BLE SOCs
## Get Started:
We use Zepyhr master as we need a newer mbed TLS as the ones that ships with Zephyr 2.2. We are waiting for the Zepyhr 2.3 release. To build, please install Zephyr and compile via west. Note that Platform.io does not support Zephyr 2.3 rc / Zepyhr master at the current time.
**Note: this is a proof of concept and not ready for production**
## Demo Video