1. reate manager

Asleep.createSleepTrackingManager

• Create SleepTrackingManager that manages Sleep Tracking Feature.

fun createSleepTrackingManager(
    asleepConfig: AsleepConfig?, 
    trackingListener: SleepTrackingManager.TrackingListener
): SleepTrackingManager?

Asleep.SleepTrackingManager.TrackingListener

interface TrackingListener {
    fun onCreate()
    fun onUpload(sequence: Int)
    fun onClose(sessionId: String)
    fun onFail(errorCode: Int, detail: String)
}

• When Sleep Tracking starts, onCreate() is called, and onUpload() is called every 30 seconds.

• When Sleep Tracking is ended, onClose()is called.

• If failure, onFail() is called.

2. Start sleep tracking

Asleep.SleepTrackingManager.startSleepTracking

• Start Sleep Tracking. If called without parameters, 'isPrivacySensitive' is set to true (recommended).

fun startSleepTracking()
// or
fun startSleepTracking(isPrivacySensitive = true)

🚧

Follow the guideline for testing the sleep tracking

To accurately test Asleep's sleep tracking/analysis, 
please follow the test environment guide. Please note that sleep analysis results obtained 
in environments not adhering to this guide may not accurately reflect actual sleep patterns.

🔗 Check Test Environment Guideline

3. Sleep Analysis

Asleep.SleepTrackingManager.requestAnalysis()

• We receive the results measured to date.

fun requestAnalysis(analysisListener: SleepTrackingManager.AnalysisListener)

Asleep.SleepTrackingManager.AnalysisListener

interface AnalysisListener {
    fun onSuccess(session: Session)
    fun onFail(errorCode: Int, detail: String)
}

• If success, onSuccess() is called.

Session data type

data class Session(
    val id: String?,
    val state: String?,
    val startTime: String?,
    val endTime: String?,
    val sleepStages: List<Int?>?,
    val breathStages: List<Int?>?
)

• If failure, onFail() is called.

4. Stop sleep tracking

Asleep.SleepTrackingManager.stopSleepTracking

• Stop Sleep Tracking.

fun stopSleepTracking()

5. Get sleep tracking status

• Available from v2.1.2

Asleep.SleepTrackingManager.getTrackingStatus()

fun getTrackingStatus(): TrackingStatus

Asleep.SleepTrackingManager.TrackingStatus

class TrackingStatus (var sessionId: String? = null)