このページは Cloud Translation API によって翻訳されました。

センサーマネージャーを使用してモバイルデバイスから歩数を測定します。

このガイドで説明するように、センサーマネージャーを使用してモバイルアプリに歩数データを入力します。エクササイズアプリの UI を設計、管理する方法については、基本的なフィットネスアプリを作成するをご覧ください。

開始する

モバイルデバイスで基本的な歩数計の歩数を測定するには、アプリモジュールの build.gradle ファイルに依存関係を追加する必要があります。最新バージョンの依存関係を使用するようにしてください。また、アプリのサポートを Wear OS などの他のフォームファクタに拡張する場合は、そのフォームファクタに必要な依存関係を追加します。

UI の依存関係の例を次にいくつか示します。完全なリストについては、こちらの UI 要素のガイドをご覧ください。

implementation(platform("androidx.compose:compose-bom:2023.10.01"))
implementation("androidx.activity:activity-compose")
implementation("androidx.compose.foundation:foundation")
implementation("androidx.compose.material:material")

歩数計センサーを取得する

ユーザーが必要なアクティビティ認識の権限を付与すると、歩数計センサーにアクセスできます。

getSystemService() から SensorManager オブジェクトを取得します。
SensorManager から歩数計センサーを取得します。

private val sensorManager by lazy {
        getSystemService(Context.SENSOR_SERVICE) as SensorManager }
private val sensor: Sensor? by lazy {
        sensorManager.getDefaultSensor(Sensor.TYPE_STEP_COUNTER) }

歩数計センサーを搭載していないデバイスもあります。センサーを確認し、デバイスにセンサーがない場合はエラーメッセージを表示する必要があります。

if (sensor == null) {
    Text(text = "Step counter sensor is not present on this device")
}

フォアグラウンドサービスを作成する

基本的なフィットネスアプリでは、歩数をトラッキングするための開始イベントと停止イベントをユーザーから受け取るボタンがあるとします。

センサーのベストプラクティスに留意してください。特に、歩数計センサーは、センサーリスナーの登録中にのみ歩数をカウントする必要があります。センサー登録をフォアグラウンドサービスに関連付けることで、センサーは必要な期間だけ登録され、アプリがフォアグラウンドにない場合でもセンサーの登録状態を維持できます。

フォアグラウンドサービスの onPause() メソッドでセンサーの登録を解除するには、次のスニペットを使用します。

override fun onPause() {
    super.onPause()
    sensorManager.unregisterListener(this)
}

イベントのデータを分析する

センサーデータにアクセスするには、SensorEventListener インターフェースを実装します。センサー登録をフォアグラウンドサービスのライフサイクルに関連付けて、サービスが一時停止または終了時にセンサーの登録を解除する必要があります。次のスニペットは、Sensor.TYPE_STEP_COUNTER に SensorEventListener インターフェースを実装する方法を示しています。

private const val TAG = "STEP_COUNT_LISTENER"

context(Context)
class StepCounter {
    private val sensorManager = getSystemService(Context.SENSOR_SERVICE) as SensorManager
    private val sensor: Sensor? = sensorManager.getDefaultSensor(Sensor.TYPE_STEP_COUNTER)

    suspend fun steps() = suspendCancellableCoroutine { continuation ->
        Log.d(TAG, "Registering sensor listener... ")

        val listener: SensorEventListener by lazy {
            object : SensorEventListener {
                override fun onSensorChanged(event: SensorEvent?) {
                    if (event == null) return

                    val stepsSinceLastReboot = event.values[0].toLong()
                    Log.d(TAG, "Steps since last reboot: $stepsSinceLastReboot")

                    if (continuation.isActive) {
                        continuation.resume(stepsSinceLastReboot)
                    }
                }

                override fun onAccuracyChanged(sensor: Sensor?, accuracy: Int) {
                      Log.d(TAG, "Accuracy changed to: $accuracy")
                }
            }
       }

        val supportedAndEnabled = sensorManager.registerListener(listener,
                sensor, SensorManager.SENSOR_DELAY_UI)
        Log.d(TAG, "Sensor listener registered: $supportedAndEnabled")
    }
}

センサーイベントのデータベースを作成する

ユーザーが、時間の経過に伴う歩数を確認できる画面を表示することがあります。アプリでこの機能を提供するには、Room 永続ライブラリを使用します。

次のスニペットは、歩数の測定値と、アプリが各測定値にアクセスした時刻を含むテーブルを作成します。

@Entity(tableName = "steps")
data class StepCount(
  @ColumnInfo(name = "steps") val steps: Long,
  @ColumnInfo(name = "created_at") val createdAt: String,
)

データの読み取りと書き込みを行うデータアクセスオブジェクト（DAO）を作成します。

@Dao
interface StepsDao {
    @Query("SELECT * FROM steps")
    suspend fun getAll(): List<StepCount>

    @Query("SELECT * FROM steps WHERE created_at >= date(:startDateTime) " +
            "AND created_at < date(:startDateTime, '+1 day')")
    suspend fun loadAllStepsFromToday(startDateTime: String): Array<StepCount>

    @Insert
    suspend fun insertAll(vararg steps: StepCount)

    @Delete
    suspend fun delete(steps: StepCount)
}

DAO をインスタンス化するには、RoomDatabase オブジェクトを作成します。

@Database(entities = [StepCount::class], version = 1)
abstract class AppDatabase : RoomDatabase() {
    abstract fun stepsDao(): StepsDao
}

センサーデータをデータベースに保存する

ViewModel は新しい StepCounter クラスを使用するため、読み次第すぐにステップを保存できます。

viewModelScope.launch {
    val stepsFromLastBoot = stepCounter.steps()
    repository.storeSteps(stepsFromLastBoot)
}

repository クラスは次のようになります。

class Repository(
    private val stepsDao: StepsDao,
) {

    suspend fun storeSteps(stepsSinceLastReboot: Long) = withContext(Dispatchers.IO) {
        val stepCount = StepCount(
            steps = stepsSinceLastReboot,
            createdAt = Instant.now().toString()
        )
        Log.d(TAG, "Storing steps: $stepCount")
        stepsDao.insertAll(stepCount)
    }

    suspend fun loadTodaySteps(): Long = withContext(Dispatchers.IO) {
        printTheWholeStepsTable() // DEBUG

        val todayAtMidnight = (LocalDateTime.of(LocalDate.now(), LocalTime.MIDNIGHT).toString())
        val todayDataPoints = stepsDao.loadAllStepsFromToday(startDateTime = todayAtMidnight)
        when {
            todayDataPoints.isEmpty() -> 0
            else -> {
                val firstDataPointOfTheDay = todayDataPoints.first()
                val latestDataPointSoFar = todayDataPoints.last()

                val todaySteps = latestDataPointSoFar.steps - firstDataPointOfTheDay.steps
                Log.d(TAG, "Today Steps: $todaySteps")
                todaySteps
            }
        }
    }
}

センサーデータの定期的な取得

フォアグラウンドサービスを使用する場合は、WorkManager を設定する必要はありません。アプリがユーザーの歩数を積極的にトラッキングしているときは、更新された合計歩数がアプリに表示される必要があるためです。

ただし、歩数レコードをバッチ処理したい場合は、WorkManager を使用して特定の間隔（15 分に 1 回など）で歩数を測定できます。WorkManager は、確実な実行のためのバックグラウンド処理を実行するコンポーネントです。詳しくは、WorkManager Codelab をご覧ください。

データを取得するように Worker オブジェクトを構成するには、次のコードスニペットに示すように、doWork() メソッドをオーバーライドします。

private const val TAG = " StepCounterWorker"

@HiltWorker
class StepCounterWorker @AssistedInject constructor(
    @Assisted appContext: Context,
    @Assisted workerParams: WorkerParameters,
    val repository: Repository,
    val stepCounter: StepCounter
) : CoroutineWorker(appContext, workerParams) {

    override suspend fun doWork(): Result {
        Log.d(TAG, "Starting worker...")

        val stepsSinceLastReboot = stepCounter.steps().first()
        if (stepsSinceLastReboot == 0L) return Result.success()

        Log.d(TAG, "Received steps from step sensor: $stepsSinceLastReboot")
        repository.storeSteps(stepsSinceLastReboot)

        Log.d(TAG, "Stopping worker...")
        return Result.success()
    }
}

現在の歩数を 15 分ごとに保存するように WorkManager を設定するには、次の操作を行います。

Application クラスを拡張して Configuration.Provider インターフェースを実装します。
onCreate() メソッドで、PeriodicWorkRequestBuilder をキューに追加します。

このプロセスを次のコードスニペットに示します。

@HiltAndroidApp
@RequiresApi(Build.VERSION_CODES.S)
internal class PulseApplication : Application(), Configuration.Provider {

    @Inject
    lateinit var workerFactory: HiltWorkerFactory

    override fun onCreate() {
        super.onCreate()

        val myWork = PeriodicWorkRequestBuilder<StepCounterWorker>(
                15, TimeUnit.MINUTES).build()

        WorkManager.getInstance(this)
            .enqueueUniquePeriodicWork("MyUniqueWorkName",
                    ExistingPeriodicWorkPolicy.UPDATE, myWork)
    }

    override val workManagerConfiguration: Configuration
        get() = Configuration.Builder()
            .setWorkerFactory(workerFactory)
            .setMinimumLoggingLevel(android.util.Log.DEBUG)
            .build()
}

アプリの起動直後にアプリの歩数計データベースへのアクセスを制御するコンテンツプロバイダを初期化するには、アプリのマニフェストファイルに次の要素を追加します。

<provider
    android:name="androidx.startup.InitializationProvider"
    android:authorities="${applicationId}.androidx-startup"
    tools:node="remove" />

センサー マネージャーを使用してモバイル デバイスから歩数を測定します。