Skip to content

Latest commit

 

History

History
103 lines (71 loc) · 4.93 KB

README.md

File metadata and controls

103 lines (71 loc) · 4.93 KB

License

Contact Tracing App iOS

This document is focused on the implementation of the iOS version of the Contact Tracing app. This app uses the CovidWatch base for which more information can be found at CovidWatch iOS. When installed, the Contact Tracing App provides the follow capabilities:

  • Allows users to record contact interactions locally (Contact Definition: Less than 6ft for a period of 10+ minutes) with others using the TCN Protocol
  • Uses a rotating Key for identification
  • Notifies users if someone they have interacted with in the past 14 days indicates they tested positive for COVID-19
  • Allows users to send contact data back to a centralized source if they tested positive for COVID-19
  • Proactively alerts a user if the user is in proximity to another user (both users must have the app running for detection)
  • Displays key statistics to the user regarding daily interactions
  • Adds an iBeacon and Location service to run the application continuously in the background
  • Adds iBeacon registration and associated iBeacon identifier with TCN
  • Device model-to-model distance calibration and profiling to augment distance detection and alerting.
  • Offers a seamless UX to complete all of the above!

Application Flow

Application Flow

Application Architecture

Application Architecture

Setup

We are using the following dependences:

Be sure to update to the lastest stable version of Xcode.

Clone this repo from the dev branch:

Open the project in Xcode:

sudo gem install cocoapods

pod install

brew install swiftlint


Install app on device in Xcode using the `prod` scheme.

Download and run backend services required for this app which can be found at [Contact Tracing Services](https://github.com/generalmotors/contact-tracing-mobile-app-backend)

Firebase Cloud Functions also need to be setup with codebase and README of this [commit](https://github.com/covidwatchorg/covidwatch-cloud-functions/commit/5fc89bee2e15433f55b4e2c8036f2ce13c23d2a3) in the [CovidWatch Cloud Functions](https://github.com/covidwatchorg/covidwatch-cloud-functions) repo.

git clone https://github.com/covidwatchorg/covidwatch-cloud-functions.git

git checkout 5fc89bee2e15433f55b4e2c8036f2ce13c23d2a3


Once Firebase is configured, create and replace the `GoogleService-Info.plist` in the `Firestore` project folder with one from your instance. 

Update the `API_BASE_URL` & `CT_KEY` property in the `Info.plist` to the url of your [Contact Tracing Services](https://github.com/generalmotors/contact-tracing-mobile-app-backend) instance.


 For full app functionality, both the [Contact Tracing Services](https://github.com/generalmotors/contact-tracing-mobile-app-backend) as well as the Firebase functions referenced [commit](https://github.com/covidwatchorg/covidwatch-cloud-functions/commit/5fc89bee2e15433f55b4e2c8036f2ce13c23d2a3) need to be configured and running. 

## iBeacon Registration 

During beacon registration, beacon identifiers are associated with TCN and stored in a local and backend database. When a device detects the beacon, it pulls the TCN from the backend and stores it in the user’s local phone for contact detection and COVID + trigger. 

## iBeacon TCN Retrieval  

When a device detects the iOS user’s beacon it has to pull the TCN from the backend and store it in the user's local phone for contact detection and COVID + trigger.  

## Post User’s Phone Number  

When user reports COVID positive the phone number is posted to backend API and also when the device detects the user as a potential infectious user 

**Note:** You cannot run this app on an emulator! It is dependent on Bluetooth being on and active, and most standard iOS emulators do not have Bluetooth drivers.

## FAQ

What is the anonymous protocol for communication between phones? How does it work and who designed it?

Covid Watch uses Temporary Contact Numbers, a decentralized, privacy-first contact tracing protocol developed by the [TCN Coalition](https://tcn-coalition.org/). This protocol is built to be extensible, with the goal of providing interoperability between contact tracing applications. You can read more about it on their [Github](https://github.com/TCNCoalition/TCN).

## Contributors

- Shane McCutchen
- Dan Rudman (@dantelope)
- Naveen Sankar (@naveenatgm)
- Sukhdev Tur 
- Joshua Noble (@joshuanoble)
- Zane Schepke (@zaneschepke)
- Mike Schuplin 
- Mark Celani
- Peter Wyatt
- Jeff Blumenthal
- Yara Lott
- Chris McGraw
- Eric Crichlow
- Jonathan Wilson
- Joseph Licari