整合 Wear OS 模組

在搭載 Wear OS 的穿戴式裝置上擴充應用程式,改善應用程式的健康與健身體驗。

新增 Wear OS 模組

Android Studio 提供實用的精靈,方便您在應用程式中新增 Wear OS 模組。依序點選「File」>「New Module」選單,然後選取「Wear OS」,如下圖所示:

Android Studio 中的 Wear OS 模組精靈
圖 1:建立 Wear OS 模組

請注意,「Minimum SDK」必須為 API 30 或以上版本,方可使用最新版的「健康照護服務」。健康照護服務會自動設定健康感應器,方便您追蹤指標及記錄資料。

完成精靈後,請同步處理專案。系統隨即會顯示下列「Run」設定:

顯示 Wear OS 應用程式執行按鈕的圖片
圖 2:新 Wear OS 模組的「執行」按鈕

這可讓您在穿戴式裝置上執行 Wear OS 模組。新增頻道的方法有以下兩種:

執行設定會將應用程式部署至 Wear OS 模擬器或裝置,並顯示「Hello World」體驗。這是基本 UI 設定,使用 Compose for Wear OS 開始建構應用程式。

新增健康照護服務和 Hilt

將下列程式庫整合至 Wear OS 模組:

  • 健康照護服務存取智慧手錶上的感應器和資料非常方便、更有效率。
  • Hilt允許有效插入及管理依附元件。

建立健康照護服務管理工具

如要讓健康照護服務使用起來更便利,並公開更小且更順暢的 API,您可以建立如下所示的包裝函式:

private const val TAG = "WATCHMAIN"

class HealthServicesManager(context: Context) {
    private val measureClient = HealthServices.getClient(context).measureClient

    suspend fun hasHeartRateCapability() = runCatching {
        val capabilities = measureClient.getCapabilities()
        (DataType.HEART_RATE_BPM in capabilities.supportedDataTypesMeasure)
    }.getOrDefault(false)

    /**
     * Returns a cold flow. When activated, the flow will register a callback for heart rate data
     * and start to emit messages. When the consuming coroutine is canceled, the measure callback
     * is unregistered.
     *
     * [callbackFlow] creates a  bridge between a callback-based API and Kotlin flows.
     */
    @ExperimentalCoroutinesApi
    fun heartRateMeasureFlow(): Flow<MeasureMessage> = callbackFlow {
        val callback = object : MeasureCallback {
            override fun onAvailabilityChanged(dataType: DeltaDataType<*, *>, availability: Availability) {
                // Only send back DataTypeAvailability (not LocationAvailability)
                if (availability is DataTypeAvailability) {
                    trySendBlocking(MeasureMessage.MeasureAvailability(availability))
                }
            }

            override fun onDataReceived(data: DataPointContainer) {
                val heartRateBpm = data.getData(DataType.HEART_RATE_BPM)
                Log.d(TAG, "💓 Received heart rate: ${heartRateBpm.first().value}")
                trySendBlocking(MeasureMessage.MeasureData(heartRateBpm))
            }
        }

        Log.d(TAG, "⌛ Registering for data...")
        measureClient.registerMeasureCallback(DataType.HEART_RATE_BPM, callback)

        awaitClose {
            Log.d(TAG, "👋 Unregistering for data")
            runBlocking {
                measureClient.unregisterMeasureCallback(DataType.HEART_RATE_BPM, callback)
            }
        }
    }
}

sealed class MeasureMessage {
    class MeasureAvailability(val availability: DataTypeAvailability) : MeasureMessage()
    class MeasureData(val data: List<SampleDataPoint<Double>>) : MeasureMessage()
}

在您建立要管理的 Hilt 模組後,請使用下列程式碼片段:

@Module
@InstallIn(SingletonComponent::class)
internal object DataModule {
    @Provides
    @Singleton
    fun provideHealthServices(@ApplicationContext context: Context): HealthServicesManager = HealthServicesManager(context)
}

您可以將 HealthServicesManager 插入為任何其他 Hilt 依附元件。

新的 HealthServicesManager 提供 heartRateMeasureFlow() 方法,可註冊心臟監控器的事件監聽器,並發出收到的資料。

在穿戴式裝置上啟用資料更新

健身相關資料必須取得 BODY_SENSORS 權限。如果您尚未在應用程式的資訊清單檔案中宣告 BODY_SENSORS 權限,請先完成這項操作。然後要求權限,如以下程式碼片段所示:

val permissionState = rememberPermissionState(
    permission = Manifest.permission.BODY_SENSORS,
    onPermissionResult = { granted -> /* do something */ }
)

[...]

if (permissionState.status.isGranted) {
    // do something
} else {
    permissionState.launchPermissionRequest()
}

如果您在實體裝置上測試應用程式,系統應會開始更新資料。

從 Wear OS 4 開始,模擬器也會自動顯示測試資料。在先前的版本中,您可以模擬來自感應器的資料串流。在終端機視窗中,執行以下 ADB 指令:

adb shell am broadcast \
-a "whs.USE_SYNTHETIC_PROVIDERS" \
com.google.android.wearable.healthservices

如要查看不同的心率值,請嘗試模擬不同的運動。這個指令會模擬步行:

adb shell am broadcast \
-a "whs.synthetic.user.START_WALKING" \
com.google.android.wearable.healthservices

這個指令會模擬執行作業:

adb shell am broadcast \
-a "whs.synthetic.user.START_RUNNING" \
com.google.android.wearable.healthservices

如要停止模擬資料,請執行下列指令:

adb shell am broadcast -a \
"whs.USE_SENSOR_PROVIDERS" \
com.google.android.wearable.healthservices

讀取心率資料

獲得 BODY_SENSORS 權限後,您就可以在 HealthServicesManager 中讀取使用者的心率 (heartRateMeasureFlow())。在 Wear OS 應用程式的 UI 中,目前心率值是由穿戴式裝置的感應器測量而得。

ViewModel 中,開始使用心率流程物件收集資料,如以下程式碼片段所示:

val hr: MutableState<Double> = mutableStateOf(0.0)

[...]

healthServicesManager
    .heartRateMeasureFlow()
    .takeWhile { enabled.value }
    .collect { measureMessage ->
        when (measureMessage) {
            is MeasureData -> {
                val latestHeartRateValue = measureMessage.data.last().value
                hr.value = latestHeartRateValue
            }

            is MeasureAvailability -> availability.value =
                    measureMessage.availability
        }
    }

使用類似以下的可組合物件,在應用程式 UI 中顯示即時資料:

val heartRate by viewModel.hr

Text(
  text = "Heart Rate: $heartRate",
  style = MaterialTheme.typography.display1
)

將資料傳送到手持裝置

如要將健康與健身資料傳送至手持裝置,請使用健康照護服務中的 DataClient 類別。下列程式碼片段說明如何傳送應用程式先前收集的心率資料:

class HealthServicesManager(context: Context) {
    private val dataClient by lazy { Wearable.getDataClient(context) }

[...]

    suspend fun sendToHandheldDevice(heartRate: Int) {
        try {
            val result = dataClient
                .putDataItem(PutDataMapRequest
                    .create("/heartrate")
                    .apply { dataMap.putInt("heartrate", heartRate) }
                    .asPutDataRequest()
                    .setUrgent())
                .await()

            Log.d(TAG, "DataItem saved: $result")
        } catch (cancellationException: CancellationException) {
            throw cancellationException
        } catch (exception: Exception) {
            Log.d(TAG, "Saving DataItem failed: $exception")
        }
    }
}

在手機上接收資料

如要在手機上接收資料,請建立 WearableListenerService

@AndroidEntryPoint
class DataLayerListenerService : WearableListenerService() {

    @Inject
    lateinit var heartRateMonitor: HeartRateMonitor

    override fun onDataChanged(dataEvents: DataEventBuffer) {

        dataEvents.forEach { event ->
            when (event.type) {
                DataEvent.TYPE_CHANGED -> {
                    event.dataItem.run {
                        if (uri.path?.compareTo("/heartrate") == 0) {
                            val heartRate = DataMapItem.fromDataItem(this)
                                    .dataMap.getInt(HR_KEY)
                            Log.d("DataLayerListenerService",
                                    "New heart rate value received: $heartRate")
                            heartRateMonitor.send(heartRate)
                        }
                    }
                }

                DataEvent.TYPE_DELETED -> {
                    // DataItem deleted
                }
            }
        }
    }
}

完成這個步驟後,請留意以下幾點:

  • @AndroidEntryPoint 註解讓我們能夠在這個類別中使用 Hilt
  • @Inject lateinit var heartRateMonitor: HeartRateMonitor 會確實在這個類別中插入依附元件
  • 類別會實作 onDataChanged(),並接收一系列您可以剖析及使用的事件

下列 HeartRateMonitor 邏輯可讓您將收到的心率值,傳送到應用程式程式碼集的其他部分:

class HeartRateMonitor {
    private val datapoints = MutableSharedFlow<Int>(extraBufferCapacity = 10)

    fun receive(): SharedFlow<Int> = datapoints.asSharedFlow()

    fun send(hr: Int) {
        datapoints.tryEmit(hr)
    }
}

資料匯流排從 onDataChanged() 方法接收事件,並使用 SharedFlow 讓資料觀察者使用這些資料。

最後位元是手機應用程式 AndroidManifest.xml 中的 Service 宣告:

<service
    android:name=".DataLayerListenerService"
    android:exported="true">
    <intent-filter>
        <!-- listeners receive events that match the action and data filters -->
        <action android:name="com.google.android.gms.wearable.DATA_CHANGED" />
        <data
            android:host="*"
            android:pathPrefix="/heartrate"
            android:scheme="wear" />
    </intent-filter>
</service>

在手持裝置上顯示即時資料

在手持裝置執行的應用程式部分中,將 HeartRateMonitor 插入檢視模型的建構函式。這個 HeartRateMonitor 物件會觀察心率資料,並視需要發出 UI 更新。