2026 年より、Google Fit API のサポートは終了します。Google Fit の移行について詳しくは、移行ガイドをご覧ください。

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

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

このガイドで説明するように、Sensor Manager を使用してモバイルアプリに歩数データを入力します。エクササイズアプリの 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()
    }
}

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

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" />