Halaman ini diterjemahkan oleh Cloud Translation API.

Melacak sesi tidur

Panduan ini kompatibel dengan Health Connect versi 1.1.0-alpha11.

Health Connect menyediakan jenis data sesi tidur, untuk menyimpan informasi tentang tidur pengguna, seperti sesi malam atau tidur siang. Jenis data SleepSessionRecord digunakan untuk merepresentasikan sesi ini.

Sesi memungkinkan pengguna mengukur performa berdasarkan waktu selama jangka waktu tertentu, seperti detak jantung berkelanjutan atau data lokasi.

Sesi SleepSessionRecord berisi data yang mencatat tahapan tidur, seperti AWAKE, SLEEPING, dan DEEP.

Data subjenis adalah data yang "termasuk" dalam sesi dan hanya bermanfaat jika dibaca dengan sesi induk. Misalnya, fase tidur.

Memeriksa ketersediaan Health Connect

Sebelum mencoba menggunakan Health Connect, aplikasi Anda harus memverifikasi bahwa Health Connect tersedia di perangkat pengguna. Health Connect mungkin tidak diinstal sebelumnya di semua perangkat atau dapat dinonaktifkan. Anda dapat memeriksa ketersediaan menggunakan metode HealthConnectClient.getSdkStatus().

Cara memeriksa ketersediaan Health Connect

fun checkHealthConnectAvailability(context: Context) {
    val providerPackageName = "com.google.android.apps.healthdata" // Or get from HealthConnectClient.DEFAULT_PROVIDER_PACKAGE_NAME
    val availabilityStatus = HealthConnectClient.getSdkStatus(context, providerPackageName)

    if (availabilityStatus == HealthConnectClient.SDK_UNAVAILABLE) {
      // Health Connect is not available. Guide the user to install/enable it.
      // For example, show a dialog.
      return // early return as there is no viable integration
    }
    if (availabilityStatus == HealthConnectClient.SDK_UNAVAILABLE_PROVIDER_UPDATE_REQUIRED) {
      // Health Connect is available but requires an update.
      // Optionally redirect to package installer to find a provider, for example:
      val uriString = "market://details?id=$providerPackageName&url=healthconnect%3A%2F%2Fonboarding"
      context.startActivity(
        Intent(Intent.ACTION_VIEW).apply {
          setPackage("com.android.vending")
          data = Uri.parse(uriString)
          putExtra("overlay", true)
          putExtra("callerId", context.packageName)
        }
      )
      return
    }
    // Health Connect is available, obtain a HealthConnectClient instance
    val healthConnectClient = HealthConnectClient.getOrCreate(context)
    // Issue operations with healthConnectClient
}

Bergantung pada status yang ditampilkan oleh getSdkStatus(), Anda dapat memandu pengguna untuk menginstal atau mengupdate Health Connect dari Google Play Store jika perlu.

Ketersediaan fitur

Tidak ada tanda ketersediaan fitur untuk jenis data ini.

Izin yang diperlukan

Akses ke sesi tidur dilindungi oleh izin berikut:

android.permission.health.READ_SLEEP
android.permission.health.WRITE_SLEEP

Untuk menambahkan kemampuan sesi tidur ke aplikasi Anda, mulailah dengan meminta izin tulis untuk jenis data SleepSession.

Berikut adalah izin yang harus Anda deklarasikan agar dapat menulis sesi tidur:

<application>
  <uses-permission
android:name="android.permission.health.WRITE_SLEEP" />
...
</application>

Untuk membaca sesi tidur, Anda perlu meminta izin berikut:

<application>
  <uses-permission
android:name="android.permission.health.READ_SLEEP" />
...
</application>

Meminta izin dari pengguna

Setelah membuat instance klien, aplikasi Anda perlu meminta izin dari pengguna. Pengguna harus diizinkan untuk memberikan atau menolak izin kapan saja.

Untuk melakukannya, buat kumpulan izin untuk jenis data yang diperlukan. Pastikan izin dalam kumpulan dideklarasikan dalam manifes Android Anda terlebih dahulu.

// Create a set of permissions for required data types
val PERMISSIONS =
    setOf(
  HealthPermission.getReadPermission(SleepSessionRecord::class),
  HealthPermission.getWritePermission(SleepSessionRecord::class)
)

Gunakan getGrantedPermissions untuk mengetahui apakah aplikasi Anda sudah mendapatkan izin yang diperlukan. Jika belum, gunakan createRequestPermissionResultContract untuk meminta izin tersebut. Tindakan ini akan menampilkan layar izin Health Connect.

// Create the permissions launcher
val requestPermissionActivityContract = PermissionController.createRequestPermissionResultContract()

val requestPermissions = registerForActivityResult(requestPermissionActivityContract) { granted ->
  if (granted.containsAll(PERMISSIONS)) {
    // Permissions successfully granted
  } else {
    // Lack of required permissions
  }
}

suspend fun checkPermissionsAndRun(healthConnectClient: HealthConnectClient) {
  val granted = healthConnectClient.permissionController.getGrantedPermissions()
  if (granted.containsAll(PERMISSIONS)) {
    // Permissions already granted; proceed with inserting or reading data
  } else {
    requestPermissions.launch(PERMISSIONS)
  }
}

Karena pengguna dapat memberikan atau mencabut izin kapan saja, aplikasi Anda harus memeriksa izin yang diberikan secara berkala dan menangani skenario saat izin tersebut hilang.

Agregasi yang didukung

Nilai gabungan berikut tersedia untuk SleepSessionRecord:

SLEEP_DURATION_TOTAL

Panduan umum

Berikut adalah beberapa panduan praktik terbaik tentang cara menggunakan sesi tidur di Health Connect.

Sesi harus digunakan untuk menambahkan data dari sesi tidur tertentu, untuk tidur:

suspend fun writeSleepSession(healthConnectClient: HealthConnectClient) {
    healthConnectClient.insertRecords(
        listOf(
            SleepSessionRecord(
                startTime = Instant.parse("2022-05-10T23:00:00.000Z"),
                startZoneOffset = ZoneOffset.of("-08:00"),
                endTime = Instant.parse("2022-05-11T07:00:00.000Z"),
                endZoneOffset = ZoneOffset.of("-08:00"),
                title = "My Sleep"
            ),
        )
    )
}

Sesi tidak boleh digunakan untuk pengukuran umum, seperti jumlah langkah harian.
Data subjenis tidak berisi UID, tetapi data terkait memiliki UID yang berbeda.
Data subjenis harus disejajarkan dalam sesi dengan stempel waktu berurutan yang tidak tumpang-tindih. Namun, celah diizinkan.
Sesi akan berguna jika pengguna menginginkan data dikaitkan dengan (dan dilacak sebagai bagian dari) sesi, bukan dicatat secara terus-menerus.

Sesi tidur

Anda dapat membaca atau menulis data tidur di Health Connect. Data tidur ditampilkan sebagai sesi, dan dapat dibagi menjadi 8 tahapan tidur yang berbeda:

UNKNOWN: Tidak ditentukan atau tidak diketahui apakah pengguna sedang tidur.
AWAKE: Pengguna terbangun dalam siklus tidur, bukan pada siang hari.
SLEEPING: Deskripsi tidur umum atau tidak terperinci.
OUT_OF_BED: Pengguna beranjak dari tempat tidur di tengah sesi tidur.
AWAKE_IN_BED: Pengguna terbangun di tempat tidur.
LIGHT: Pengguna dalam siklus tidur ringan.
DEEP: Pengguna berada dalam siklus tidur nyenyak.
REM: Pengguna berada dalam siklus tidur REM.

Nilai ini mewakili jenis tidur yang dialami pengguna dalam rentang waktu. Menulis tahapan tidur bersifat opsional, tetapi sebaiknya dilakukan jika tersedia.

Menulis sesi tidur

Jenis data SleepSessionRecord memiliki dua bagian:

Sesi keseluruhan yang mencakup seluruh durasi tidur.
Masing-masing tahapan selama sesi tidur seperti tidur ringan atau tidur nyenyak.

Berikut ini cara menyisipkan sesi tidur tanpa tahapan:

SleepSessionRecord(
      title = "weekend sleep",
      startTime = startTime,
      endTime = endTime,
      startZoneOffset = ZoneOffset.UTC,
      endZoneOffset = ZoneOffset.UTC,
)

Berikut ini cara menambahkan tahapan yang mencakup seluruh periode sesi tidur:

val stages = listOf(
    SleepSessionRecord.Stage(
        startTime = START_TIME
        endTime = END_TIME,
        stage = SleepSessionRecord.STAGE_TYPE_SLEEPING,
    )
)

SleepSessionRecord(
        title = "weekend sleep",
        startTime = START_TIME,
        endTime = END_TIME,
        startZoneOffset = START_ZONE_OFFSET,
        endZoneOffset = END_ZONE_OFFSET,
        stages = stages,
)

Membaca sesi tidur

Untuk setiap sesi tidur yang ditampilkan, Anda harus memeriksa apakah data tahapan tidur juga ada:

suspend fun readSleepSessions(
    healthConnectClient: HealthConnectClient,
    startTime: Instant,
    endTime: Instant
) {
    val response =
        healthConnectClient.readRecords(
            ReadRecordsRequest(
                SleepSessionRecord::class,
                timeRangeFilter = TimeRangeFilter.between(startTime, endTime)
            )
        )
    for (sleepRecord in response.records) {
        // Retrieve relevant sleep stages from each sleep record
        val sleepStages = sleepRecord.stages
    }
}

Menghapus sesi tidur

Berikut ini cara menghapus sesi. Untuk contoh ini, kita telah menggunakan sesi tidur:

suspend fun deleteSleepSession(
    healthConnectClient: HealthConnectClient,
    sleepRecord: SleepSessionRecord,
) {
    val timeRangeFilter = TimeRangeFilter.between(sleepRecord.startTime, sleepRecord.endTime)
    healthConnectClient.deleteRecords(SleepSessionRecord::class, timeRangeFilter)
}