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

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

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

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

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

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

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

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

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

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

fun checkHealthConnectAvailability(context: Context) {
    val providerPackageName = "com.google.android.apps.healthdata"
    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)
    )
ใช้ getGrantedPermissions เพื่อดูว่าแอปของคุณได้รับสิทธิ์ที่จำเป็นแล้วหรือยัง หากไม่มี ให้ใช้ createRequestPermissionResultContract เพื่อขอสิทธิ์เหล่านั้น หน้าจอแสดงสิทธิ์ของ Health Connect จะปรากฏขึ้น
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.") }
    }
}
เนื่องจากผู้ใช้สามารถให้หรือเพิกถอนสิทธิ์ได้ทุกเมื่อ แอปของคุณจึงต้องตรวจสอบสิทธิ์ทุกครั้งก่อนใช้งานและจัดการสถานการณ์ที่สิทธิ์หายไป

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

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

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

ต่อไปนี้เป็นหลักเกณฑ์แนวทางปฏิบัติแนะนำบางส่วนเกี่ยวกับวิธีทำงานกับเซสชันการนอนหลับใน 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",
                metadata = Metadata.activelyRecorded(device = Device(type = Device.TYPE_WATCH))
            ),
        )
    )
}

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

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

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

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

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

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

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

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

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

val zoneRules = ZoneId.systemDefault().rules

// Calculate the specific offset for both start and end times
val startOffset = zoneRules.getOffset(startTime)
val endOffset = zoneRules.getOffset(endTime)

SleepSessionRecord(
    title = "weekend sleep",
    startTime = startTime,
    endTime = endTime,
    startZoneOffset = startOffset,
    endZoneOffset = endOffset,
    metadata = Metadata.activelyRecorded(device = Device(type = Device.TYPE_WATCH))
)

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

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
}

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

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

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