外部デバイスを操作する

Android 11 以降では、クイック アクセス デバイス コントロール機能により、デフォルトのランチャーから 3 回の操作で、照明、サーモスタット、カメラなどの外部デバイスをユーザー アフォーダンスからすばやく表示して操作できます。デバイス OEM は、使用するランチャーを選択します。デバイス アグリゲータ（Google Home など）やサードパーティ ベンダーのアプリは、このスペースに表示されるデバイスを指定できます。このページでは、このスペースにデバイス コントロールを表示し、コントロール アプリにリンクする方法について説明します。

注: これらの機能を使用するには、プロジェクトの minSdk が 30 以上である必要があります。

図 1. Android UI のデバイス コントロール スペース。

このサポートを追加するには、ControlsProviderService を作成して宣言します。事前定義されたコントロール タイプに基づいてアプリがサポートするコントロールを作成し、さらにそれらのコントロール用にパブリッシャーを作成します。

ユーザー インターフェース

デバイスは、[デバイス コントロール] の下にテンプレート化されたウィジェットとして表示されます。次の図に示すように、5 種類のデバイス コントロール ウィジェットを使用できます。

切り替え	スライダーで切り替え	範囲（オンとオフを切り替えることはできない）
ステートレス切り替え	温度パネル（閉じた状態）

図 2. テンプレート化されたウィジェットのコレクション。

ウィジェットを長押しすると、アプリでさらに詳細な制御が可能になります。各ウィジェットのアイコンと色はカスタマイズできますが、デフォルトの設定がデバイスに適合する限り、デフォルトのアイコンと色を使用してください。

図 3. 温度パネル ウィジェットを開きます。

サービスを作成する

このセクションでは、ControlsProviderService の作成方法について説明します。このサービスは、Android UI のデバイス コントロール エリアに表示されるデバイス コントロールがアプリに含まれていることを、Android のシステム UI に伝えます。

ControlsProviderService API では、Reactive Streams GitHub プロジェクトで定義されて Java 9 Flow インターフェースに実装されている、リアクティブ ストリームに習熟していることが前提になっています。API は次のコンセプトに基づいています。

• パブリッシャー: アプリがパブリッシャーになる。
• サブスクライバー: システム UI がサブスクライバーであり、パブリッシャーから複数のコントロールをリクエストできます。
• サブスクリプション: パブリッシャーがシステム UI にアップデートを送信できる期間。このウィンドウは、パブリッシャーまたはサブスクライバーのいずれかが閉じることができます。

サービスを宣言する

アプリでは、アプリ マニフェストで MyCustomControlService などのサービスを宣言する必要があります。

サービスには ControlsProviderService のインテント フィルタが含まれている必要があります。このフィルタにより、アプリはシステム UI にコントロールを提供できます。

また、システム UI のコントロールに表示される label も必要です。

次の例は、サービスを宣言する方法を示しています。

<service
    android:name="MyCustomControlService"
    android:label="My Custom Controls"
    android:permission="android.permission.BIND_CONTROLS"
    android:exported="true"
    >
    <intent-filter>
      <action android:name="android.service.controls.ControlsProviderService" />
    </intent-filter>
</service>

次に、MyCustomControlService.kt という名前の新しい Kotlin ファイルを作成し、ControlsProviderService を拡張します。

class MyCustomControlService : ControlsProviderService() {
    // ...
}
MyCustomControlService.kt

正しいコントロール タイプを選択する

API には、コントロールを作成するためのビルダー メソッドが用意されています。ビルダーにデータを入力するには、制御するデバイスと、ユーザーがデバイスを操作する方法を決定します。次の手順を行います。

1. コントロールが表すデバイスのタイプを選択します。DeviceTypes クラスは、サポートされているすべてのデバイスの列挙です。このタイプは、UI でデバイスのアイコンと色を決定するために使用されます。
2. ユーザー向けの名前、デバイスの位置情報（キッチンなど）、コントロールに関連付けられているその他の UI テキスト要素を決定します。
3. ユーザー インタラクションをサポートする最適なテンプレートを選択します。コントロールには、アプリケーションから ControlTemplate が割り当てられます。このテンプレートは、制御状態と利用可能な入力方法（ControlAction）をユーザーに直接表示します。次の表は、利用可能なテンプレートの一部と、そのテンプレートでサポートされるアクションを示しています。

テンプレート	アクション	説明
ControlTemplate.getNoTemplateObject()	None	アプリケーションはこれを使用してコントロールに関する情報を伝えることができますが、ユーザーはコントロールを操作できません。
ToggleTemplate	BooleanAction	有効状態と無効状態を切り替えられるコントロールを表します。BooleanAction オブジェクトには、ユーザーがコントロールをタップしたときに、リクエストされた新しい状態を表すように変化するフィールドが含まれています。
RangeTemplate	FloatAction	指定された最小値、最大値、ステップ値を示すスライダー ウィジェットを表します。ユーザーがスライダーを操作すると、値が更新された新しい FloatAction オブジェクトがアプリに返されます。
ToggleRangeTemplate	BooleanAction, FloatAction	このテンプレートは ToggleTemplate と RangeTemplate を組み合わせたものです。たとえば調光可能な照明のコントロールのように、タッチイベントやスライダーがサポートされています。
TemperatureControlTemplate	ModeAction, BooleanAction, FloatAction	このテンプレートでは、上記のアクションをカプセル化するのに加えて、ユーザーが暖房、冷房、暖房・冷房、エコ、オフなどのモードを設定できます。
StatelessTemplate	CommandAction	リモートの IR テレビのように、タップ機能があるが状態を判定できないコントロールを示すために使用されます。このテンプレートを使用して、コントロールと状態の変化を集約したルーティンやマクロを定義できます。

この情報に基づいてコントロールを作成できます。

• コントロールの状態が不明な場合は Control.StatelessBuilder ビルダークラスを使用します。
• コントロールの状態がわかっている場合は Control.StatefulBuilder ビルダークラスを使用します。

たとえば、スマート電球とサーモスタットを制御するには、次の定数を MyCustomControlService に追加します。

private const val LIGHT_ID = 1234
private const val LIGHT_TITLE = "My fancy light"
private const val LIGHT_TYPE = DeviceTypes.TYPE_LIGHT
private const val THERMOSTAT_ID = 5678
private const val THERMOSTAT_TITLE = "My fancy thermostat"
private const val THERMOSTAT_TYPE = DeviceTypes.TYPE_THERMOSTAT

class MyCustomControlService : ControlsProviderService() {
    // ...
}
MyCustomControlService.kt

コントロール用のパブリッシャーを作成する

コントロールを作成したら、次にパブリッシャーが必要になります。パブリッシャーは、システム UI にコントロールの存在を通知します。ControlsProviderService クラスには、アプリケーション コードでオーバーライドする必要がある 2 つのパブリッシャー メソッドがあります。

• createPublisherForAllAvailable: アプリで使用可能なすべてのコントロール用に Publisher を作成します。このパブリッシャーについては Control.StatelessBuilder を使用して Control オブジェクトをビルドします。
• createPublisherFor: 文字列識別子によって識別される特定のコントロールのリストについて、Publisher を作成します。パブリッシャーが各コントロールに状態を割り当てる必要があるため、これらの Control オブジェクトをビルドするには Control.StatefulBuilder を使用します。

パブリッシャーを作成する

アプリがコントロールを最初にシステム UI に公開する時点では、アプリは各コントロールの状態を認識しません。デバイス プロバイダのネットワークでのホップ数が多い場合には、状態の取得に時間がかかることがあります。createPublisherForAllAvailable メソッドを使用して、利用可能なコントロールをシステムにアドバタイズします。このメソッドでは、各コントロールの状態が不明なため、Control.StatelessBuilder ビルダークラスを使用します。

Android UI にコントロールが表示されると、ユーザーはお気に入りのコントロールを選択できます。

Kotlin コルーチンを使用して ControlsProviderService を作成するには、build.gradle に新しい依存関係を追加します。

Groovy

dependencies {
    implementation "org.jetbrains.kotlinx:kotlinx-coroutines-jdk9:1.6.4"
}

Kotlin

dependencies {
    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-jdk9:1.6.4")
}

Gradle ファイルを同期したら、次のスニペットを Service に追加して createPublisherForAllAvailable を実装します。

class MyCustomControlService : ControlsProviderService() {

    override fun createPublisherForAllAvailable(): Flow.Publisher<Control> =
        flowPublish {
            send(createStatelessControl(LIGHT_ID, LIGHT_TITLE, LIGHT_TYPE))
            send(createStatelessControl(THERMOSTAT_ID, THERMOSTAT_TITLE, THERMOSTAT_TYPE))
        }

    private fun createStatelessControl(id: Int, title: String, type: Int): Control {
        val intent = Intent(this, MainActivity::class.java)
            .putExtra(EXTRA_MESSAGE, title)
            .addFlags(Intent.FLAG_ACTIVITY_NEW_TASK)
        val action = PendingIntent.getActivity(
            this,
            id,
            intent,
            PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_IMMUTABLE,
        )

        return Control.StatelessBuilder(id.toString(), action)
            .setTitle(title)
            .setDeviceType(type)
            .build()
    }

    override fun createPublisherFor(controlIds: List<String>): Flow.Publisher<Control> {
        TODO()
    }

    override fun performControlAction(
        controlId: String,
        action: ControlAction,
        consumer: Consumer<Int>,
    ) {
        TODO()
    }
}
MyCustomControlService.kt

システム メニューを下にスワイプして、図 4 に示す [デバイス コントロール] ボタンを見つけます。

図 4. システム メニューのデバイス コントロール。

[デバイス コントロール] をタップすると、アプリを選択できる 2 番目の画面に移動します。アプリを選択すると、図 5 に示すように、前のスニペットで作成したカスタム システム メニューに新しいコントロールが表示されます。

図 5. 追加する照明とサーモスタットのコントロール。

次に、createPublisherFor メソッドを実装し、次のコードを Service に追加します。

private val job = SupervisorJob()
private val scope = CoroutineScope(Dispatchers.IO + job)
private val controlFlows = mutableMapOf<String, MutableSharedFlow<Control>>()

private var toggleState = false
private var rangeState = 18f

override fun createPublisherFor(controlIds: List<String>): Flow.Publisher<Control> {
    val flow = MutableSharedFlow<Control>(replay = 2, extraBufferCapacity = 2)

    controlIds.forEach { controlFlows[it] = flow }

    scope.launch {
        delay(1000) // Retrieving the toggle state.
        flow.tryEmit(createLight())

        delay(1000) // Retrieving the range state.
        flow.tryEmit(createThermostat())
    }
    return flow.asPublisher()
}

private fun createLight() = createStatefulControl(
    LIGHT_ID,
    LIGHT_TITLE,
    LIGHT_TYPE,
    toggleState,
    ToggleTemplate(
        LIGHT_ID.toString(),
        ControlButton(
            toggleState,
            toggleState.toString().uppercase(Locale.getDefault()),
        ),
    ),
)

private fun createThermostat() = createStatefulControl(
    THERMOSTAT_ID,
    THERMOSTAT_TITLE,
    THERMOSTAT_TYPE,
    rangeState,
    RangeTemplate(
        THERMOSTAT_ID.toString(),
        15f,
        25f,
        rangeState,
        0.1f,
        "%1.1f",
    ),
)

private fun <T> createStatefulControl(
    id: Int,
    title: String,
    type: Int,
    state: T,
    template: ControlTemplate,
): Control {
    val intent = Intent(this, MainActivity::class.java)
        .putExtra(EXTRA_MESSAGE, "$title $state")
        .addFlags(Intent.FLAG_ACTIVITY_NEW_TASK)
    val action = PendingIntent.getActivity(
        this,
        id,
        intent,
        PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_IMMUTABLE,
    )

    return Control.StatefulBuilder(id.toString(), action)
        .setTitle(title)
        .setDeviceType(type)
        .setStatus(Control.STATUS_OK)
        .setControlTemplate(template)
        .build()
}

override fun onDestroy() {
    super.onDestroy()
    job.cancel()
}
MyCustomControlService.kt

この例では、createPublisherFor メソッドに、アプリが行う必要のある処理（デバイスと通信してステータスを取得し、そのステータスをシステムに出力する）の偽の実装が含まれています。

createPublisherFor メソッドは、Kotlin のコルーチンと Flow を使用して、次の処理を行い、必要な Reactive Streams API を満たします。

1. Flow を作成します。
2. 1 秒間待機します。
3. スマートライトの状態を作成して出力します。
4. さらに 1 秒待機します。
5. サーモスタットの状態を作成して出力します。

アクションを処理する

performControlAction メソッドは、公開されたコントロールをユーザーが操作したときに通知します。送信された ControlAction のタイプによってアクションが決まります。特定のコントロールに対して適切なアクションを実行し、Android UI でデバイスの状態を更新します。

この例を完成させるには、Service に次のコードを追加します。

override fun performControlAction(
    controlId: String,
    action: ControlAction,
    consumer: Consumer<Int>,
) {
    controlFlows[controlId]?.let { flow ->
        when (controlId) {
            LIGHT_ID.toString() -> {
                consumer.accept(ControlAction.RESPONSE_OK)
                if (action is BooleanAction) toggleState = action.newState
                flow.tryEmit(createLight())
            }
            THERMOSTAT_ID.toString() -> {
                consumer.accept(ControlAction.RESPONSE_OK)
                if (action is FloatAction) rangeState = action.newValue
                flow.tryEmit(createThermostat())
            }
            else -> consumer.accept(ControlAction.RESPONSE_FAIL)
        }
    } ?: consumer.accept(ControlAction.RESPONSE_FAIL)
}
MyCustomControlService.kt

アプリを実行し、[デバイスのコントロール] メニューにアクセスすると、照明とサーモスタットのコントロールが表示されます。

図 6. 照明とサーモスタットの操作。