Skip to content

crslade/iOSUsage

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

iOSUsage

iOSUsage is a MacOS app that reads the screentime usage stats from the MacOS database and exports it in CSV format or uploads the data in JSON format to a Web API. This is designed to support studies that analyze screen time data. The app reads the screen time of shared devices and not the Mac that reads the screen time.

iOSUsage App

Installation

Download the DMG from GitHub, then drag iOSUsage to your application folder.

Recommended Usage

Please remember the privacy of your participants and do all you can to ensure their privacy.

  1. Improve Synchronization:

    Consistent Internet Connection: Ensure that both devices are connected to the same Wi-Fi network during the syncing process. This can help to avoid discrepancies caused by different internet connections.

    Device Usage: Try to avoid using the devices during the syncing process. To efficiently complete synchronization requires the device to remain unused until syncing completes.

    Regular Syncing: Schedule regular syncing processes. The more frequent the sync, the less data there is to transfer each time, which could lead to faster and more successful syncs.

  2. Prevent Data Loss:

    Avoid Deleting Apps: Application deletions and reinstalls may affect screen time data for specific apps. Try to avoid deleting apps that you want to track usage for.

    Longer Sync Duration: If data is missing, try a longer sync duration. Longer sync durations may help recover missing data.

1. Login to the device with an Apple ID and Enable ScreenTime

If not already done, make sure the iPhone or iPad is logged in to an iCloud account with an Apple ID. Then go to Settings -> Screen Time and make sure it is enabled. Also, make sure "Share Across Devices" is enabled.

2. Setup Collection Mac.

On a Mac computer login to iCloud using the same Apple ID that the iPad or iPhone uses. If your participant doesn't have a Mac to sync the data to, you can create a new user account (see image below) on a research Mac.

To create an account on a research Mac:

  1. Use an Admin account on the research Mac and go to Settings -> Users & Groups -> Add User. Make sure the new account is a "Standard" account.
How to Create a User Account

After creating the user account (making sure the participant sets the password to ensure privacy), log into the new user account and then have the participant log in to their iCloud account. Make sure they use the same Apple ID as their device.

Then, to ensure privacy, shut off all iCloud services by going to Settings -> (Apple ID) -> iCloud (Click Show All). Turn off all services using iCloud.

Turn off all iCloud services

Then, on the Mac, go to Settings -> Screen Time and enable screen time. Then make sure the "Share across devices" is turned on.

Turn on Screen time and share across devices.

3. Sync Screen Time data to the Mac

On the Mac, go to Settings -> Screen Time -> App & Website Activity. Wait a little while (5-10 minutes) for data to sync between devices. You should see the iOS device in the list of devices. Also, make sure the screen time data from the iOS device is current.

Let Screen Time data sync

4. Copy the Screen Time database to a separate folder

After the Data has Synced, copy the Screen Time Database from /Users/<account>/Library/Application Support/Knowledge to a folder on the Desktop or Documents.

To find the folder, you must show hidden files: with the Finder as the active window, press Shift-CMD-. (period). From the user's home folder, you will see a Library folder. From that go to Application Support -> Knowledge. Right-click on Knowledge.db and select copy. Create a destination folder on the desktop/documents. Then inside this folder, right-click, and paste.

Find the Screen Time Data

4. Read Screen Time Data

If not already done, install the iOSUsage app on the Mac (see installation above). If you have a research Mac, you need to install it using the Admin account and it will be available to all users.

Open the iOSUsage app. Select the folder containing the copied knowledge.db file to read the data.

5. Export Screen Time Data

Select among the different devices and make sure you have the right device selected by looking at the screen time data. Then you can export the file by entering the participant id.

Uploading data to an API

If you would rather upload the data to an API, you can click upload. Enter the API Endpoint and the participant ID. You can also create a text file containing the API endpoint.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages