---
# System prepended metadata

title: MVP for sleep sensing

---

# MVP for sleep sensing

Participants need to follow a two-step process to join the The MVP version of sleep tracking: (i) install the Aware app on the phone, (ii) join the study by scanning a QR code. These two steps are described below.


<br>


## Step #1: Installing AWARE app on the phone


AWARE is a sensor data collection platform that is widely used. The installation instructions are different for the Android and iOS as described below. 


### iOS
Open the 'App Store' app on your phone and search "Aware." The correct version of the app is "AWARE Client V2". Install the app.  
> ***iOS quirks 1**: (Contributed by Sarah Rathnam). AWARE asks to enable location when you start the app. Please don't press "skip." Press "next" and you'll see the location permission option. Once it asks to enable location, select "Always when using the app." Then go to "Setting app > Aware v2 > Location." Select always (now AWARE will do background sensing of location all the time).*


### Android
Android version of AWARE isn't available in the android play store and can be only downloaded from the aware framework's website as an apk (apk's are android's executatble file fomrat). The exact steps to install the apk are below:

1. There are two methods to install the apk: 

     
     - **Method 1 (easier)**: Click on this [link](http://jenkins.awareframework.com/job/com.aware.phone/lastSuccessfulBuild/artifact/aware-phone/build/outputs/apk/release/aware-phone-armeabi-release.apk) to download the **apk** from AWARE website. 
     - **Method 2**: Go to AWARE website [awareframework.com](https://awareframework.com/) and scroll down to find the link for `AWARE for Android`.  

2. Android OS may ask to enable the installation of apks from **unknown sources**. Android is asking this because the apk is not distributed through the play store, so Google can't verify if the app obeys all app store rules and is not malicous. AWARE isn't a malicious app, but it uses some permissions for background recording that Google recently disabled for privacy reasons. The official statement from AWARE website is the following:

    > *You won’t find AWARE on the Google Play Store. Being an application to conduct user-studies, we use many permissions that current developer guidelines do not allow. We are now hosting the client. This allows us to provide you with the tool you are used to without restrictions and allows us to better support the platform going forward.*


<br>

## Step #2: Joining the sleep study
We have already configured a study for the Harvard component of SARA. The study data is currently located in a MySQL database hosted in an Amazon EC2 machine.

Steps to join this study is the following:
- Open the aware app. Right at the top, you'll see a QR code icon.
- Scan the following **QR** code. The app will automatically ask you to join the study called `aware-sara-harvard`.

<img src="https://temp-files-for-mash.s3.amazonaws.com/aware-harvard-qr-code.png" alt="drawing" width="300"/>

- Once the study is configured, the icon at the top of the app will change. 
     > **iOS quirks 2**: When you subscribe to our study, it will ask you enable Health Kit data. Select "Turn on all categories".    
- At the top of the app, you will see a `Device ID`. The device ID is required to separte one user's data from another. Please send us the first 8 digits of the device id (highlighed in green in the following image).


    <img src="https://temp-files-for-mash.s3.amazonaws.com/aware-study-ios-successful-study-device-id.png" alt="drawing" width="400"/>
<br>


# Troubleshooting

## How do I check that I joined the right study?

### iOS 
Go to the `settings` tab in the AWARE app. You will see the study URL right at the top. (See screenshot below)
> <img src="https://temp-files-for-mash.s3.amazonaws.com/aware-study-ios-successful-study.jpg" alt="drawing" width="400"/>

### Android 
On the main page of the app, scroll down until you see the 'AWARE study' tab (left screenshot). Click on it. You will be in a new page and you will see the study URL (right screenshot).  

> <img src="https://temp-files-for-mash.s3.amazonaws.com/aware-study-android-successful-study-1.png" alt="drawing" width="300"/>
> <img src="https://temp-files-for-mash.s3.amazonaws.com/aware-study-android-successful-study-2.png" alt="drawing" width="300"/>








