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

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

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

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

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

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

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

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

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

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

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

ประกาศสิทธิ์เหล่านี้ใน Play Console สำหรับแอปของคุณ รวมถึงในไฟล์ Manifest ของแอป ดังนี้

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

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

คำแนะนำทั่วไป

ต่อไปนี้คือหลักเกณฑ์แนวทางปฏิบัติแนะนำเกี่ยวกับวิธีทำงานกับเซสชันการนอนหลับใน 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)
}