Recording API บนอุปกรณ์เคลื่อนที่

Recording API บนอุปกรณ์เคลื่อนที่ช่วยให้แอปบันทึกจำนวนก้าวได้ คล้ายกับเครื่องวัดระยะทางที่ดึงข้อมูลจำนวนก้าวจากอุปกรณ์เคลื่อนที่ในลักษณะที่ประหยัดแบตเตอรี่ API นี้ไม่มีบัญชี ซึ่งหมายความว่าไม่จําเป็นต้องมีบัญชี Google เพื่อใช้บริการ และข้อมูลจะจัดเก็บไว้ในอุปกรณ์

คู่มือนี้แสดงวิธีใช้ Recording API บนอุปกรณ์เคลื่อนที่ในประสบการณ์ด้านสุขภาพและการออกกำลังกาย

ดูตัวอย่างได้ที่ Recording API บนอุปกรณ์เคลื่อนที่ใน GitHub

รายละเอียดที่น่าสนใจ

Recording API บนอุปกรณ์เคลื่อนที่มีฟีเจอร์ที่น่าสนใจหลายอย่างดังนี้

• เมื่อการสมัครใช้บริการการบันทึกเริ่มขึ้นหรือมีการต่ออายุแล้ว คุณจะเข้าถึงข้อมูลได้สูงสุด 10 วันนับตั้งแต่การสมัครใช้บริการครั้งล่าสุด
• ข้อมูลจะพร้อมใช้งานก็ต่อเมื่อมีการใช้งานการสมัครใช้บริการอยู่เท่านั้น หากนำการสมัครใช้บริการออกโดยเรียกใช้ unsubscribe คุณจะเข้าถึงข้อมูลจำนวนก้าวที่รวบรวมไว้ไม่ได้

ประเภทข้อมูล

Recording API บนอุปกรณ์เคลื่อนที่สามารถบันทึกข้อมูลประเภทต่อไปนี้

• TYPE_STEP_COUNT_DELTA

เริ่มต้นใช้งาน

หากต้องการเริ่มต้นใช้งาน ให้เพิ่มข้อกําหนดต่อไปนี้ในไฟล์ build.gradle

plugin {
  id("com.android.application")
}

...

dependencies {
  implementation("com.google.android.gms:play-services-fitness:21.2.0")
}

apply plugin: 'com.android.application'

...

dependencies {
  implementation 'com.google.android.gms:play-services-fitness:21.2.0'
}

ขอสิทธิ์

หากต้องการบันทึกข้อมูลโดยใช้ Recording API บนอุปกรณ์เคลื่อนที่ แอปของคุณจะต้องขอสิทธิ์ต่อไปนี้

• android.permission.ACTIVITY_RECOGNITION

ตรวจสอบเวอร์ชันของบริการ Google Play

หากต้องการใช้ Recording API บนอุปกรณ์เคลื่อนที่ ผู้ใช้ต้องอัปเดตบริการ Google Play เป็น LOCAL_RECORDING_CLIENT_MIN_VERSION_CODE คุณตรวจสอบปัญหานี้ได้โดยใช้วิธี isGooglePlayServicesAvailable ดังนี้

val hasMinPlayServices = isGooglePlayServicesAvailable(context, LocalRecordingClient.LOCAL_RECORDING_CLIENT_MIN_VERSION_CODE)

if(hasMinPlayServices != ConnectionResult.SUCCESS) {
  // Prompt user to update their device's Google Play services app and return
}

// Continue with Recording API functions

หรือหากเวอร์ชันบริการ Google Play ของผู้ใช้ต่ำเกินไป ระบบจะแสดงข้อยกเว้น ConnectionResult.SERVICE_VERSION_UPDATE_REQUIRED

สมัครรับข้อมูลการออกกำลังกาย

หากต้องการขอรวบรวมข้อมูลจำนวนก้าวในเบื้องหลัง ให้ใช้เมธอด subscribe ดังที่แสดงในข้อมูลโค้ดต่อไปนี้

val localRecordingClient = FitnessLocal.getLocalRecordingClient(this)
// Subscribe to steps data
localRecordingClient.subscribe(LocalDataType.TYPE_STEP_COUNT_DELTA)
  .addOnSuccessListener {
    Log.i(TAG, "Successfully subscribed!")
  }
  .addOnFailureListener { e ->
    Log.w(TAG, "There was a problem subscribing.", e)
  }

อ่านและประมวลผลข้อมูลการออกกำลังกาย

เมื่อสมัครใช้บริการแล้ว ให้ขอข้อมูลโดยใช้เมธอด readData จากนั้นคุณสามารถรับ LocalDataPoints จาก LocalDataSet ที่ได้ โดยสร้าง LocalDataReadRequest ดังที่แสดงในตัวอย่างโค้ดต่อไปนี้

val endTime = LocalDateTime.now().atZone(ZoneId.systemDefault())
val startTime = endTime.minusWeeks(1)
val readRequest =
  LocalDataReadRequest.Builder()
    // The data request can specify multiple data types to return,
    // effectively combining multiple data queries into one call.
    // This example demonstrates aggregating only one data type.
    .aggregate(LocalDataType.TYPE_STEP_COUNT_DELTA)
    // Analogous to a "Group By" in SQL, defines how data should be
    // aggregated. bucketByTime allows bucketing by time span.
    .bucketByTime(1, TimeUnit.DAYS)
    .setTimeRange(startTime.toEpochSecond(), endTime.toEpochSecond(), TimeUnit.SECONDS)
    .build()

  localRecordingClient.readData(readRequest).addOnSuccessListener { response ->
    // The aggregate query puts datasets into buckets, so flatten into a
    // single list of datasets.
    for (dataSet in response.buckets.flatMap { it.dataSets }) {
      dumpDataSet(dataSet)
    }
  }
  .addOnFailureListener { e ->
    Log.w(TAG,"There was an error reading data", e)
  }

fun dumpDataSet(dataSet: LocalDataSet) {
  Log.i(TAG, "Data returned for Data type: ${dataSet.dataType.name}")
  for (dp in dataSet.dataPoints) {
    Log.i(TAG,"Data point:")
    Log.i(TAG,"\tType: ${dp.dataType.name}")
    Log.i(TAG,"\tStart: ${dp.getStartTime(TimeUnit.HOURS)}")
    Log.i(TAG,"\tEnd: ${dp.getEndTime(TimeUnit.HOURS)}")
    for (field in dp.dataType.fields) {
      Log.i(TAG,"\tLocalField: ${field.name.toString()} LocalValue: ${dp.getValue(field)}")
    }
  }
}

LocalRecordingClient จะอัปเดตการเก็บรวบรวมข้อมูลอย่างต่อเนื่อง คุณใช้ readData เพื่อดึงตัวเลขล่าสุดได้ทุกเมื่อ

โปรดทราบว่า LocalRecordingClient จะจัดเก็บข้อมูลสูงสุด 10 วัน หากต้องการลดความเสี่ยงที่จะสูญเสียข้อมูล คุณสามารถใช้ WorkManager เพื่อรวบรวมข้อมูลในเบื้องหลังเป็นระยะๆ

ยกเลิกการสมัครรับข้อมูลการออกกำลังกาย

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

val localRecordingClient = FitnessLocal.getLocalRecordingClient(this)
// Unsubscribe from steps data
localRecordingClient.unsubscribe(LocalDataType.TYPE_STEP_COUNT_DELTA)
  .addOnSuccessListener {
    Log.i(TAG, "Successfully unsubscribed!")
  }
  .addOnFailureListener { e ->
    Log.w(TAG, "There was a problem unsubscribing.", e)
  }