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

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

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

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

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

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

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

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

วิธีตรวจสอบความพร้อมใช้งานของ 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
}

คุณสามารถแนะนำให้ผู้ใช้ติดตั้งหรืออัปเดต 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>

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

หลังจากสร้างอินสแตนซ์ไคลเอ็นต์แล้ว แอปของคุณต้องขอสิทธิ์จากผู้ใช้ ผู้ใช้ต้องได้รับอนุญาตให้ให้สิทธิ์หรือปฏิเสธสิทธิ์ได้ทุกเมื่อ

โดยให้สร้างชุดสิทธิ์สำหรับประเภทข้อมูลที่จำเป็น ตรวจสอบว่าได้ประกาศสิทธิ์ในชุดไว้ใน Android manifest ก่อน

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

ใช้ getGrantedPermissions เพื่อดูว่าแอปของคุณได้รับสิทธิ์ที่จำเป็นแล้วหรือไม่ หากไม่มี ให้ใช้ createRequestPermissionResultContract เพื่อขอสิทธิ์เหล่านั้น ซึ่งจะแสดงหน้าจอขอสิทธิ์ของ 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)
  }
}

เนื่องจากผู้ใช้สามารถให้หรือเพิกถอนสิทธิ์ได้ทุกเมื่อ แอปของคุณจึงต้อง ตรวจสอบสิทธิ์ที่ได้รับเป็นระยะๆ และจัดการสถานการณ์ที่ สิทธิ์สูญหาย

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

ค่ารวมต่อไปนี้พร้อมใช้งานสำหรับ 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"
            ),
        )
    )
}
  • ไม่ควรใช้เซสชันสำหรับการวัดผลทั่วไป เช่น จำนวนก้าวต่อวัน
  • ข้อมูลประเภทย่อยไม่มี UID แต่ข้อมูลที่เชื่อมโยงมี UID ที่แตกต่างกัน
  • ข้อมูลประเภทย่อยต้องสอดคล้องกันในเซสชันที่มีการประทับเวลาตามลำดับ ซึ่งไม่ซ้อนทับกัน แต่จะเว้นวรรคได้
  • เซสชันมีประโยชน์ในกรณีที่ผู้ใช้ต้องการเชื่อมโยงข้อมูลกับเซสชัน (และติดตามเป็นส่วนหนึ่งของเซสชัน) แทนที่จะบันทึกอย่างต่อเนื่อง

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

คุณอ่านหรือเขียนข้อมูลการนอนหลับใน 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,
)

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

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

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

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

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
    }
}

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

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

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