ติดตามเซสชันการนอนหลับ

คู่มือนี้ใช้ได้กับ Health Connect เวอร์ชัน 1.1.0-alpha11

Health Connect มีข้อมูลประเภท เซสชันการนอนหลับ เพื่อจัดเก็บข้อมูลเกี่ยวกับการนอนหลับของผู้ใช้ เช่น เซสชันการนอนหลับตอนกลางคืนหรือการงีบหลับตอนกลางวัน โดยใช้ข้อมูลประเภท SleepSessionRecord เพื่อแสดงเซสชันเหล่านี้

เซสชันช่วยให้ผู้ใช้วัดประสิทธิภาพตามเวลาในช่วงระยะเวลาหนึ่งได้ เช่น ข้อมูลอัตราการเต้นของหัวใจหรือข้อมูลตำแหน่งแบบต่อเนื่อง

เซสชัน SleepSessionRecord มีข้อมูลที่บันทึกระยะการนอนหลับ เช่น AWAKE, SLEEPING และ DEEP

ข้อมูลประเภทย่อย คือข้อมูลที่ "เป็นของ" เซสชันและมีความหมายก็ต่อเมื่ออ่านพร้อมกับเซสชันหลัก เช่น ระยะการนอนหลับ

ในทางกลับกัน ข้อมูลที่เชื่อมโยง หมายถึงข้อมูลที่บันทึก แยกกันแต่เกิดขึ้นในช่วงเวลาของเซสชัน ตัวอย่างเช่น หากผู้ใช้บันทึกอัตราการเต้นของหัวใจระหว่างเซสชันการนอนหลับ ข้อมูลอัตราการเต้นของหัวใจจะเป็นข้อมูลที่เชื่อมโยง ข้อมูลที่เชื่อมโยงประกอบด้วยบันทึกอิสระแต่ละรายการที่มี UUID ของตัวเอง ซึ่งแตกต่างจากข้อมูลประเภทย่อยที่เป็นส่วนหนึ่งของบันทึกเซสชัน

ตรวจสอบความพร้อมใช้งานของ Health Connect

ก่อนที่จะพยายามใช้ Health Connect แอปของคุณควรตรวจสอบว่า Health Connect พร้อมใช้งานในอุปกรณ์ของผู้ใช้หรือไม่ เนื่องจากอาจไม่ได้ติดตั้ง Health Connect ไว้ล่วงหน้าในอุปกรณ์บางเครื่องหรืออาจปิดใช้ไว้ คุณสามารถตรวจสอบความพร้อมใช้งานได้โดยใช้วิธี HealthConnectClient.getSdkStatus()

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
}

คุณสามารถแนะนำให้ผู้ใช้ติดตั้งหรืออัปเดต Health Connect จาก Google Play Store ได้หากจำเป็น ทั้งนี้ขึ้นอยู่กับสถานะที่ getSdkStatus() แสดงผล

ความพร้อมใช้งานของฟีเจอร์

ไม่มีแฟล็กความพร้อมใช้งานของฟีเจอร์สำหรับข้อมูลประเภทนี้

สิทธิ์ที่จำเป็น

การเข้าถึงเซสชันการนอนหลับได้รับการคุ้มครองโดยสิทธิ์ต่อไปนี้

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

หากต้องการเพิ่มความสามารถในการใช้เซสชันการนอนหลับลงในแอป ให้เริ่มต้นด้วยการขอสิทธิ์สำหรับข้อมูลประเภท SleepSession

นี่คือสิทธิ์ที่คุณต้องประกาศเพื่อให้สามารถเขียนข้อมูลเซสชันการนอนหลับได้

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

หากต้องการอ่านข้อมูลเซสชันการนอนหลับ คุณต้องขอสิทธิ์ต่อไปนี้

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

ขอสิทธิ์จากผู้ใช้

หลังจากสร้างอินสแตนซ์ไคลเอ็นต์แล้ว แอปของคุณต้องขอสิทธิ์จากผู้ใช้ ผู้ใช้ต้องได้รับอนุญาตให้ให้หรือปฏิเสธสิทธิ์ได้ทุกเมื่อ โดยสร้างชุดสิทธิ์สำหรับข้อมูลประเภทที่จำเป็น ตรวจสอบว่าได้ประกาศสิทธิ์ในชุดในไฟล์ Manifest ของ Android ก่อน

val permissions =
    setOf(
        HealthPermission.getReadPermission(SleepSessionRecord::class),
        HealthPermission.getWritePermission(SleepSessionRecord::class)
    )
HealthConnectManager.kt

val permissions = setOf(
        HealthPermission.getReadPermission(StepsRecord::class),
        HealthPermission.getWritePermission(StepsRecord::class),
        HealthPermission.getReadPermission(HeartRateRecord::class),
        HealthPermission.getWritePermission(HeartRateRecord::class)
    )

val requestPermissionsLauncher = rememberLauncherForActivityResult(
    contract = PermissionController.createRequestPermissionResultContract()
) { grantedPermissions ->
    if (grantedPermissions.containsAll(permissions)) {
        coroutineScope.launch { snackbarHostState.showSnackbar("Permissions granted!") }
    } else {
        coroutineScope.launch { snackbarHostState.showSnackbar("Permissions denied.") }
    }
}
HealthConnectActivity.kt

การรวมที่รองรับ

ค่ารวมต่อไปนี้ใช้ได้กับ SleepSessionRecord:

• SLEEP_DURATION_TOTAL

คําแนะนําทั่วไป

ต่อไปนี้คือหลักเกณฑ์แนวทางปฏิบัติแนะนำเกี่ยวกับวิธีใช้เซสชันการนอนหลับใน Health Connect

• ควรใช้เซสชันเพื่อเพิ่มข้อมูลจากเซสชันการนอนหลับที่เฉพาะเจาะจงสำหรับการนอนหลับ

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"
            ),
        )
    )
}
HealthConnectManager.kt

• ข้อมูลประเภทย่อยต้องสอดคล้องกับเซสชันที่มีการประทับเวลาตามลำดับซึ่งไม่ทับซ้อนกัน อย่างไรก็ตาม ระบบอนุญาตให้มีช่องว่างได้
• ข้อมูลประเภทย่อยไม่มี UUID แต่ข้อมูลที่เชื่อมโยงมี UUID ที่แตกต่างกัน
• เซสชันมีประโยชน์หากผู้ใช้ต้องการให้ข้อมูลเชื่อมโยงกับเซสชัน (และติดตามเป็นส่วนหนึ่งของเซสชัน) แทนที่จะบันทึกอย่างต่อเนื่อง

เซสชันการนอนหลับ

คุณสามารถอ่านหรือเขียนข้อมูลการนอนหลับใน Health Connect ได้ ข้อมูลการนอนหลับจะแสดงเป็นเซสชันและแบ่งออกเป็น 8 ระยะการนอนหลับที่แตกต่างกันได้ดังนี้

• UNKNOWN: ไม่ได้ระบุหรือไม่ทราบว่าผู้ใช้นอนหลับหรือไม่
• AWAKE: ผู้ใช้ตื่นอยู่ภายในวงจรการนอนหลับ ไม่ใช่ระหว่างวัน
• SLEEPING: คำอธิบายการนอนหลับทั่วไปหรือแบบไม่ละเอียด
• OUT_OF_BED: ผู้ใช้ลุกจากเตียงกลางเซสชันการนอนหลับ
• AWAKE_IN_BED: ผู้ใช้ตื่นอยู่บนเตียง
• LIGHT: ผู้ใช้อยู่ในวงจรการนอนหลับตื้น
• DEEP: ผู้ใช้อยู่ในวงจรการนอนหลับลึก
• REM: ผู้ใช้อยู่ในวงจรการนอนหลับแบบ REM

ค่าเหล่านี้แสดงถึงประเภทการนอนหลับที่ผู้ใช้ได้รับในช่วงเวลาหนึ่ง การเขียนข้อมูลระยะการนอนหลับเป็นตัวเลือก แต่ขอแนะนำให้ทำหากมีข้อมูล

เขียนข้อมูลเซสชันการนอนหลับ

ข้อมูลประเภท SleepSessionRecord มี 2 ส่วนดังนี้

1. เซสชันโดยรวมซึ่งครอบคลุมระยะเวลาการนอนหลับทั้งหมด
2. ระยะต่างๆ ระหว่างเซสชันการนอนหลับ เช่น การนอนหลับตื้นหรือการนอนหลับลึก

วิธีแทรกเซสชันการนอนหลับที่ไม่มีระยะต่างๆ

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

วิธีเพิ่มระยะต่างๆ ที่ครอบคลุมระยะเวลาทั้งหมดของเซสชันการนอนหลับ

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,
)

อ่านข้อมูลเซสชันการนอนหลับ

สำหรับเซสชันการนอนหลับที่แสดงผลแต่ละรายการ คุณควรตรวจสอบว่ามีข้อมูลระยะการนอนหลับด้วยหรือไม่

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
}
HealthConnectManager.kt

ลบเซสชันการนอนหลับ

วิธีลบเซสชัน ในตัวอย่างนี้ เราใช้เซสชันการนอนหลับ

val timeRangeFilter = TimeRangeFilter.between(sleepRecord.startTime, sleepRecord.endTime)
healthConnectClient.deleteRecords(SleepSessionRecord::class, timeRangeFilter)
HealthConnectManager.kt