Link Search Menu Expand Document
Developer | Sahha

SDK

Learn how to use the Sahha SDK in your iOS app.


Table of contents
  1. Repository
  2. Installation
    1. Option A) Swift Package Manager
    2. Option B) CocoaPods
    3. Import Module
  3. Project Settings
  4. Configure
    1. Option A) SwiftUI
    2. Option B) UIKit
    3. Environment Settings
    4. Sensor Settings
    5. Sensor Data Settings
  5. Profile
    1. Authenticate
    2. Demographic
  6. Sensors
    1. Sensor Status
    2. Enable Sensors
    3. Sleep Sensor - IMPORTANT INFO
    4. Open App Settings
    5. Post Sensor Data
  7. Analyze

Repository

You can browse the Sahha iOS SDK on Github.

iOS SDK [GitHub]


Installation

You can install the Sahha SDK to your Xcode project in multiple ways.


Option A) Swift Package Manager

Add the Sahha swift package to your project’s Package Dependencies.

https://github.com/sahha-ai/sahha-swift

Option B) CocoaPods

Step 1) Add the Sahha pod to your project’s Podfile.

Podfile

 pod 'Sahha'

Step 2) Run pod install inside your project root folder.

Terminal

$ pod install

Import Module

After you have installed the Sahha SDK, import the Sahha module into any files inside your project that use the SDK.

Swift

import Sahha

Project Settings

Add NSMotionUsageDescription to your Xcode project’s Info.plist.

Add NSHealthShareUsageDescription to your Xcode project’s Info.plist.

Add NSHealthUpdateUsageDescription to your Xcode project’s Info.plist.

You will need to write a message explaining to the user why they should approve these permissions.

Info.plist

<key>NSMotionUsageDescription</key>
  <string>This app would like access to your motion activity for analysis.</string>
<key>NSHealthShareUsageDescription</key>
  <string>This app would like access to your health activity for analysis.</string>
<key>NSHealthUpdateUsageDescription</key>
  <string>This app would like access to your health activity for analysis.</string>

Add HealthKit entitlement to your Xcode project. Select your App Target in the Project panel, then Signing & Capabilities, then tap the + button, then select HealthKit from the list. You must also set Background Delivery to true.

App.entitlements

<dict>
 <key>com.apple.developer.healthkit</key>
  <true/>
 <key>com.apple.developer.healthkit.access</key>
  <array/>
 <key>com.apple.developer.healthkit.background-delivery</key>
  <true/>
</dict>

Configure

The Sahha SDK must be configured immediately on app launch.

You may pass an optional list of settings to the configure method.


Option A) SwiftUI

Configure Sahha inside onAppear of your app’s ContentView.

SwiftUI

ContentView().onAppear {
    let settings = SahhaSettings(environment: .development, sensors: [.sleep], postSensorDataManually: false)
    Sahha.configure(settings) {
        // SDK is ready to use
        print("SDK Ready")
    }
}

Option B) UIKit

Configure Sahha inside application didFinishLaunchingWithOptions of your app’s AppDelegate.

UIKit

func application(_: UIApplication, didFinishLaunchingWithOptions _: [UIApplication.LaunchOptionsKey: Any]? = nil) -> Bool {
    let settings = SahhaSettings(environment: .development, sensors: [.sleep], postSensorDataManually: false)
    Sahha.configure(settings) {
        // SDK is ready to use
        print("SDK Ready")
    }
}

Environment Settings

The SahhaEnvironment determines if the SDK connects to the development or production server of the API. Setting this incorrectly will send data to the wrong server.

SahhaEnvironment Description
development For development and testing
production For submission to the App store
public enum SahhaEnvironment: String {
    case development
    case production
}

Sensor Settings

You can specify which sensors for the Sahha SDK to use. To optimize your analysis result, we suggest enabling all sensors. Leave this value null to enable all sensors by default.

Some sensors are not available on all platforms.

SahhaSensor Description Android iOS
sleep For tracking sleep patterns
pedometer For tracking walking patterns
device For tracking device usage patterns X
public enum SahhaSensor: String, CaseIterable {
    case sleep
    case pedometer
    case device
}

Sensor Data Settings

If you would like to handle posting of sensor data to the Sahha API manually, set postSensorDataManually to true. You will then need to post sensor data to the Sahha API manually by calling postSensorData.

If you would like the Sahha SDK to handle posting of sensor data to the Sahha API automatically, set postSensorDataManually to false.

postSensorDataManually defaults to false.

postSensorDataManually Description
true You will post sensor data to the Sahha API manually by calling postSensorData
false The Sahha SDK will post sensor data to the Sahha API automatically

Profile

Each user of your app will be assigned a Sahha Profile for analyzation. This is not handled by the Sahha SDK. Please refer to the separate Sahha API documentation for steps to generate profiles and profile tokens.


Authenticate

The Sahha SDK must be authenticated in order to connect to the Sahha API. Do this once per user profile. Once the user is successfully authenticated, the SDK will take care of automatically refreshing expired tokens.

Sahha.authenticate(token: "PROFILE_TOKEN", refreshToken: "REFRESH_TOKEN")

Demographic

Each authenticated profile includes an optional demographic which can be used to increase the accuracy of analyzation. This data is not collected automatically. Your app can choose to GET or POST this demographic to the Sahha API.

All values are optional. String values are case insensitive (for example: 'us' and 'US' are equal and valid).

age : Int

Age must be a valid Int between 1 - 99.

gender : String

Gender must be a valid String from this list:

  • 'male'
  • 'female'
  • 'gender diverse'

country : String

Country must be a valid 2 character ISO String from this list:

ISO Country Codes

birthCountry : String

Birth Country must be a valid 2 character ISO String from this list:

ISO Country Codes

ethnicity : String

Any String value.

occupation : String

Any String value.

industry : String

Any String value.

incomeRange : String

Any String value.

education : String

Any String value.

relationship : String

Any String value.

locale : String

Any String value.

livingArrangement : String

Any String value.

birthDate : String

Birth Date must be a String in the format 'YYYY-MM-DD'. For example, '1990-05-20'.

MODEL

public struct SahhaDemographic: Codable {
    public var age: Int?
    public var gender: String? // "male", "female", "gender diverse"
    public var country: String? // ISO 2 character code, i.e. "us", "uk", "au", etc.
    public var birthCountry: String?  // ISO 2 character code, i.e. "us", "uk", "au", etc.
    public var ethnicity: String? // any string
    public var occupation: String? // any string
    public var industry: String? // any string
    public var incomeRange: String? // any string
    public var education: String? // any string
    public var relationship: String? // any string
    public var locale: String? // any string
    public var livingArrangement: String? // any string
    public var birthDate: String? // must be in format "YYYY-MM-DD", i.e. "1990-05-20"
}

POST

let demographic = SahhaDemographic(age: 21, gender: "female", country: "uk", birthCountry: "au")

Sahha.postDemographic(demographic) { error, success in
    if let error = error {
        print(error)
    }
    print(success)
}

GET

Sahha.getDemographic() { error, demographic in
    if let error = error {
        print(error)
    }
    if let demographic = demographic {
        print(demographic)
    }
}

Sensors

The Sahha SDK acts as a bridge between your app and the sensors.


Sensor Status

The sensors have multiple possible statuses.

public enum SensorStatus: Int {
    case pending /// Sensors pending User permission
    case unavailable /// Sensors not supported by the User's device
    case disabled /// Sensors disabled by the User
    case enabled /// Sensors enabled by the User
}

You can check the current status of the sensors by calling getSensorStatus. This method is asynchronous and will return the updated SahhaSensorStatus in its callback.

Sahha.getSensorStatus { newStatus in
    print(newStatus.description)
}

Enable Sensors

Before the SDK can start collecting data, you will need to enable sensors by calling enableSensors. This method is asynchronous and will return the updated SahhaSensorStatus in its callback.

Sahha.enableSensors { newStatus in
    print(newStatus.description)
}

Sleep Sensor - IMPORTANT INFO

In order for the Sahha SDK to collect data from the sleep sensor, Sleep functionality must be enabled by your mobile user BEFORE calling enableSensors.

Please read the official Apple documentation to help your users setup Sleep for iOS.

Sleep for iOS

We suggest checking if your user has seen the HealthKit permission screen before enabling the sleep sensor. If the status is pending, this is the perfect time to show your custom UI asking your user to setup Sleep in the Health App.

Sahha.getSensorStatus { newStatus in
    if newStatus == .pending {
        // Show your custom UI asking your user to setup Sleep in the Health App
    }
}

Open App Settings

It’s possible for your app user to disable a sensor. In this case, you must send the user to the app settings to manually enable the sensor.

Sahha.openAppSettings()

NOTICE: If the user enables / disables a sensor permission from the device settings menu while your app is in the background, the iOS system will force your app to terminate. This is intentional behavior and your app will need to be relaunched.


Post Sensor Data

By default, the Sahha SDK will post sensor data automatically. However, if you set postSensorDataManually to true, you will need to post sensor data manutally to the Sahha API by calling postSensorData at a regular interval of your choosing.

Sahha.postSensorData { error, success in
    if let error = error {
        print(error)
    }
    print(success)
}

Analyze

You can analyze a user’s activities over a period of time and receive a mental health personalized report which you can display or action within your app. The default time period for an analysis is the previous 24 hours.

You can set (includeSourceData: true) if you would like to receive an array of the source data that was used to generate the analysis in the response. The default value is false.

// Analyze Previous 24 Hours
// Leave date range empty
Sahha.analyze(includeSourceData: true) { error, json in
    isAnalyzeButtonEnabled = true
    if let error = error {
        print(error)
    } else if let json = json {
        print(json)
    }
}

You can provide an optional data range if you would like to receive multiple analysis over a specific time period. The response will include an array of analysis for each 24 hour segment in that time period.

// Analyze Previous 7 Days
// Add a date range
let today = Date()
let sevenDaysAgo = Calendar.current.date(byAdding: .day, value: -7, to: today) ?? Date()
Sahha.analyze(dates: (sevenDaysAgo, today), includeSourceData: true) { error, json in
    isAnalyzeButtonEnabled = true
    if let error = error {
        print(error)
    } else if let json = json {
        print(json)
    }
}

The response will be in JSON format. An example response includes these fields:

{
  "inferences": [
    {
      "createdAt": "2022-05-20T00:30:00+00:00",
      "predictionState": "not_depressed",
      "predictionSubState": "",
      "predictionRange": -1,
      "predictionConfidence": 0.8,
      "dataSource": ["sleep", "screenTime"]
    }
  ]
}

The analysis engine requires a minimum amount of device sensor data to be uploaded and processed before an analysis can be determined. If you call analyze for a new user profile, it’s possible for the response to be 204 No Content. This is not an error. You will need to wait and try again every 24 hours until an analysis is available.

// An analysis is not ready yet
// Try again in 24 hours
// Empty JSON
{}